stats api - unity-cn/unityads-help-cn GitHub Wiki

/* Title: Monetization Stats API
Sort: 21 */

Unity Ads 为开发者提供了CSV格式的数据统计API(Statistics API, Stats API). 数据统计API所抓到的数据与开发者在开发者后台里看到的相同. 数据统计API可以用来通过编程的方式拉取数据以便使用在自己的系统里.

概览

统计API会做2个阶段的事情:

  1. 首先用户发出一个GET请求进行验证, 当验证通过后会返回一个302的重定向消息. 这个返回里会包含最终统计服务器的链接.
  2. 之后, 再发出一个GET请求, 服务器会返回一个body中包含一个CSV格式的消息.

验证

要使用Unity Ads统计API, 需要在开发者控制台(Dashboard)上拿到一个API key:

1，从 Dashboard 的 Operate 项的左侧导航栏下选择 Ads Data Export > API Access。

2，在 Monetization API Access section 部分，复制提供的 API key，如果没有 API key，那么请创建一个新的。

必须包含API key作为"apikey="查询参数，或使用authentication header"Authorization: Token "。

重定向URL提取数据。这是所有HTTP客户端支持的标准HTTP行为。

如果身份验证失败，则身份验证服务器将以HTTP/2错误代码和正文中的消息作为响应。例如：

400 {"errors":[{"msg":"access token required"}]}

请求格式

流量变现统计API 支持以下的请求格式，其中organizationId是您的Unity organization的ID ：:

GET 
https://monetization.api.unity.com/stats/v1/operate/organizations/:organizationId

比如：

curl 
https://monetization.api.unity.com/stats/v1/operate/organizations/1234567890abcdefghijkjlmn?groupBy=country,placement,platform,game&fields=adrequest_count,available_sum,revenue_sum,start_count,view_count&scale=hour&start=2019-05-01T00:00:00Z&end=2019-06-12T23:59:00Z&apikey=abcdefghijklmn1234567890 -H "Accept: text/csv" --output stats.csv

显示的数据域（列）:

  • <apikey> 是从 开发者控制台中拿到的
  • <fields> 包含逗号隔开的参数列表:
    • adrequest_count – 从服务器查询的广告数量
    • available_sum – 经查询后所返回的拥有存量的次数
    • start_count – 用户开始看了多少次视频
    • view_count – 用户看完了多少次视频
    • revenue_sum – 赚了多少收入
  • <groupBy> 以逗号分隔的列表，用于扩展行，并按以下字段拆分数据:
    • placement – 所使用的Placement ID
    • country – 国家
    • platform – 平台
    • game – 游戏ID
  • <scale> 按时间间隔拆分数据的值。每天的时间从UTC时间00:00开始计算。支持的选项包括:
    • hour
    • day
    • week
    • month
    • year
    • all
  • <start> 数据集开始的时间，使用ISO 8601格式。
  • <end> 数据集结束的时间，使用ISO 8601格式。
  • <gameIds> 以逗号分隔的源游戏ID列表，用于过滤结果。注意：要获取源ID，可以使用发出groupBy=game请求。

此API支持返回CSV或JSON文件。在"Accept"标题中指定输出格式，如下所示：

  • 对于CSV，请使用 "Accept: text/csv"
  • 对于JSON，请使用 "Accept: application/json"

注意: 同时使用多个域来分隔数据可能会造成数据输出量膨胀, 从而造成网络请求失败, 任何超过60秒的请求都会在60秒时被终止.

请求状态码

服务器可能返回以下状态码以指示请求的结果：

  • 200 – 请求成功。
  • 400 – 缺少参数
  • 401 – API密钥从请求中丢失或无效。
  • 404 – 找不到Organization。
  • 408 – 请求超时。
  • 429 – 超出请求速率限制。
  • 500 – 请求失败，原因不明。
  • 503 – 该服务不可用。

点击此处，查看英文文档

如果有任何疑问，欢迎使用中文向[email protected]咨询。

⚠️ **GitHub.com Fallback** ⚠️