变现统计数据 API
使用变现统计数据 API 在程序中以 CSV 格式访问广告效果数据，从而创建自定义报告并分析。
阅读时间4 分钟最后更新于 1 个月前
使用变现统计数据 API 直接以 CSV 格式获取变现数据。该 API 可获取开发者后台提供的统计数据，不过您也可以使用该 API 以编程方式拉取数据，供自己使用。
重要
聚合合作伙伴需要 Unity API 密钥才能收集 Unity Ads 平台的准确报告。如果已在聚合集成中使用了已弃用的 Applifier 统计数据 API，请在迁移到变现统计数据 API 之前咨询您的聚合平台。请注意，仍然可以使用变现统计数据 API 来 ping Unity 的广告平台以便直接报告数据。所有非聚合客户都可以安全迁移到新的 API。
身份验证
注意
变现统计数据 API 需要您的 Organization ID（组织 ID），该 ID 将在转移项目时更改。
注意
转移项目会更改 Organization ID（组织 ID），这是访问变现统计数据 API 所必需的。
- 转到 Unity Monetization（变现）后台，然后选择 Monetization（变现）菜单。
- 选择 Settings > API management。
- 从 **Monetization Stats API Access（变现统计数据 API 访问）**部分中复制密钥，如果没有任何密钥，请选择 Create Api Key（创建 API 密钥）。
注意
变现统计数据 API 为每个用户生成一个唯一的密钥。为了实现聚合集成，任何个人的密钥都适用于整个组织。
"apikey=<token>""Authorization: Token <token>"400 {"errors":[{"msg":"access token required"}]}
请求格式
要从 Unity Ads 服务获取统计数据，请使用以下 GET 请求，其中的<organizationId>GEThttps://monetization.api.unity.com/stats/v1/operate/organizations/<organizationId>
查询参数
此 API 支持各种拆分数据的方法。有些对于实现成功请求必不可少。参数 | 描述 | 必需？ | 注意 |
|---|---|---|---|
| 从 Monetization（变现）后台获取的 API 身份验证密钥。 | 否。改用 Authentication（身份验证）标头。 | 不适用。 |
| 这是一个以逗号分隔的列表，用于定义可用字段的列：
| 是 | 不适用。 |
| 这是一个以逗号分隔的列表，用于扩展行，按以下字段拆分数据：
| 否 | 不适用。 |
| 这是一个按时间维度拆分数据的值。以 00:00 UTC 划分每天。支持的选项包括：
| 是 | 不适用。 |
| 数据集的开始时间，采用 ISO 8601 格式。 | 是 | 不适用。 |
| 数据集的结束时间，采用 ISO 8601 格式。 | 是 | 不适用。 |
| 这是一个以逗号分隔的列表，其中包含源 Game ID（游戏 ID），用于过滤结果。 | 否 | 要获取源 ID，可以使用 |
"Accept"- 对于 CSV，使用 。
"Accept: text/csv" - 对于 JSON，使用 。
"Accept: application/json"
curlhttps://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
注意
在多个维度上同时拆分数据会导致 CSV 呈指数级增长，这可能会造成某些大型数据集超时。如果服务器处理请求的时间超过 60 秒，则请求会超时。
请求状态代码
终端会返回以下表明请求结果的状态代码：代码 | 描述 |
|---|---|
| 请求已成功。 |
| 查询中省略了 |
| 请求中缺少 API 密钥或该 API 密钥无效。 |
| 未找到组织。 |
| 请求已超时。 |
| 超出请求速率限制。 |
| 由于未知原因而导致请求失败。 |
| 服务不可用。 |