货币化统计 API
使用货币化统计 API 直接以 CSV 格式检索货币化数据。该 API 获取开发者仪表盘上提供相同的统计数据,但是您可以使用它以编程方式提取数据以供自己使用。
重要:中介合作伙伴需要 Unity API 密钥才能收集 Unity Ads 网络的准确报告。如果您已经在中介集成中使用已弃用的 Applifier Statistics API,请在迁移到货币化统计 API 之前咨询您的中介合作伙伴。请注意,您仍然可以使用货币化统计 API 直接 ping Unity 的网络以获取报告数据。所有未经中介的客户都可以安全地迁移到新 API。
认证
注意:货币化统计 API 需要您的组织 ID,并且该 ID 在传输项目时将更改。
Note: Transferring a project changes the Organization ID, which is required for accessing the Monetization Statistics API.
该端点使用来自 Unity Ads 货币化仪表盘 的 API 密钥。从辅助导航菜单中选择设置>API 访问,然后从货币化统计 API 访问部分复制 API 密钥,或者如果不存在,则选择创建 API 密钥。
Note: The Monetization Statistics API generates a unique key for each user. For mediation integration purposes, any individual's key will work for the entire Organization.
您必须将 API 密钥作为 "apikey=<token>"
查询参数包含在内,或者使用身份验证标头 "Authorization: Token <token>"
。重定向 URL 获取数据。这是所有 HTTP 客户端都支持的标准 HTTP 行为。
如果身份验证失败,身份验证服务器将返回 HTTP/2 错误代码,以及正文中的消息。例如
400 {"errors":[{"msg":"access token required"}]}
请求格式
要从 Unity Ads 服务检索统计数据,请使用以下 GET 请求,其中 <organizationId>
是您的 Unity 组织的 组织核心 ID
GET
https://monetization.api.unity.com/stats/v1/operate/organizations/<organizationId>
查询参数
该 API 支持各种方法来拆分您的数据。有些对于成功请求是必需的。
参数 | 描述 | 必需吗? |
---|---|---|
apikey | 从货币化仪表盘检索的 API 身份验证密钥。 | 否。改用身份验证标头。 |
fields | 逗号分隔的列表,定义可用字段的列
| 是 |
groupBy | 逗号分隔的列表,扩展行,按以下字段拆分数据
| 否 |
scale | 一个值,按时间分辨率拆分数据。每一天在 00:00 UTC 分割。支持的选项包括
| 是 |
start | 数据集的开始时间,以 ISO 8601 格式。 | 是 |
end | 数据集的结束时间,以 ISO 8601 格式。 | 是 |
gameIds | 逗号分隔的源游戏 ID 列表,用于过滤结果。 注意:要获取源 ID,您可以使用 | 否 |
此 API 支持返回 CSV 或 JSON 文件。在 "Accept"
标头中指定输出格式,如下所示
- 对于 CSV,使用
"Accept: text/csv"
。 - 对于 JSON,使用
"Accept: application/json"
。
以下是一个示例请求,使用真实参数(除了占位符组织核心 ID 和 API 密钥)
curl
https://monetization.api.unity.com/stats/v1/operate/organizations/:organizationId?groupBy=country,placement,platform,game&fields=adrequest_count,available_sum,revenue_sum,start_count,view_count&scale=hour&start=2020-05-01T00:00:00Z&end=2020-06-01T23:59:00Z&apikey=:apiKeyValue -H "Accept: text/csv" --output stats.csv
Note: Splitting data across multiple dimensions causes the CSV to grow exponentially, which might cause some large data sets to time-out. The request times out if the server takes more than 60 seconds to process the request.
请求状态代码
该端点返回以下状态代码,指示请求的结果
代码 | 描述 |
---|---|
| 请求成功。 |
400 | organizationId 或其他必需参数从查询中省略。 |
401 | API 密钥在请求中丢失或无效。 |
404 | 组织未找到。 |
408 | 请求超时。 |
429 | 请求速率限制已超过。 |
500 | 请求因未知原因失败。 |
503 | 服务不可用。 |