文档

展示级收入服务服务器 API

通过 ILR 服务器 API 访问每日 CSV 报告,轨道广告展示和设备级别的广告收入。
阅读时间1 分钟最后更新于 24 天前

展示量级别收入 (ILR) 解决方案在 LevelPlay 聚合中为广告服务提供设备级别和展示量级别数据。有两个单独的 API:
  • 一个用于提取设备级别数据
  • 一个用于提取展示级别数据。
根据 app、网络、国家/地区和实例,根据每个展示的 eCPM 来计算收入。

工作原理

  • 获取展示级别和用户级别数据是通过完成以下步骤执行的:
    • 发起 API 请求,获取用于下载报告的 URL 链接
    • 点击提供的链接下载报告
  • 每个 API 调用必须针对单个 app 和单个日期进行。
  • 每个日期的数据会存储并可供访问 14 天。
    • 示例:1 月 1 日的数据将在 1 月 14 日及之前可供访问
  • 每天,昨天的数据从 UTC 上午 10:00 开始可用。确保仅在每天上午 10:00 UTC 之后调用 API。
    • 示例:1 月 1 日的数据仅在 1 月 2 日 UTC 时间上午 10:00 后可供访问
  • 每天,我们都会更新昨天和前天的数据。数据在 2 天后不会改变。
    • 示例:1 月 1 日的数据将在 1 月 2 日和 1 月 3 日更新。1 月 3 日之后,数据将不再变化
  • Date & app Key 未包含在展示和用户级别报告中,因为它们在每个报告(文件)中是唯一的

展示级别

用于获取报告 URL 的 API 请求

注意
有效的 API 请求会返回所请求文件的链接。该文件的下载有效期仅为一小时。

Authentication类型

方法

必需参数

Name(名称)

类型

描述

date
字符串YYYY-MM-DD(UTC 时区)
appKey
字符串应用程序密钥(在我们的平台上显示)

请求示例 URL

响应示例网址

{"urls": ["https://user-ad-revenue.s3.amazonaws.com/data/bi_databases/arm/tables/mediation/report_version%3Dv1/publisher_id%3D551399/application_id%3D225509/day%3D2020-03-31/report.csv.gz?AWSAccessKeyId=AKIAILCCGIXP5G2XNXBA&Expires=1585751272&Signature=bONL8mMc%2B0kdtekXzmXRT4shidQ%3D"],"expiration": "2020-03-31 14:27:52"}

下载报告

选择要下载报告的网址。

字段定义 v3

字段

描述

示例

event timestamp
展示的确切日期和时间(UTC)2020-03-30 09:33:58
advertising id
设备广告 ID - GAID 或 IDFAfdbe7b9b-d183-4c7c-9bb5-59c9df8c35aa
advertising vendor id
设备广告供应商 ID - app Set ID 或 IDFVA0810F0B-16C2-474B-B765-77B3A3113AA2
user id
开发者正在设置的用户 ID135920
ad unit
产生收入的广告格式奖励视频
ad network
广告网络名称Admob
creative id
广告系列的创意 ID。默认为空字字符串(不包括在 Google、Meta、Digital Turbine 和 Mintegral 网络中)65af8c5f9dd504dba89ea38e
instance name
平台上定义的广告网络实例名称。对于竞价源,实例名称将“Bidding”高
country
2 字母国家代码,符合 ISO 3166-1 Alpha-2CN
placement
平台上定义的与用户相关的放置/位置主屏幕
segment
用户相关的细分段,根据细分方法定义。阅读更多第 1 层
AB Testing
分配给用户的 A/B 测试组(可以是“A”、“B”、“N/A”)A, B, N/A
revenue
用户产生的收入(美元)。收入值要么是估算的(CPM/速率),要么是准确的(对于投标人实例,不包括风扇)。0.5
mediation ad unit id
产生收入的广告单元的 IDfgx25t56dq201bd2
mediation ad unit name
产生收入的广告单元的名称

用户级别

用于获取报告 URL 的 API 请求

有效的 API 请求会返回所请求文件的链接。该文件的下载有效期仅为一小时。

身份验证类型

方法

GET:
platform.ironsrc.com/partners/userAdRevenue/v3

必需参数

Name(名称)

类型

描述

date
字符串YYYY-MM-DD(UTC 时区)
appKey
字符串应用程序密钥(在我们的平台上显示)
reportType
整数支持不同的报告类型。目前,应始终设置为 1。

请求示例网址

https://platform.ironsrc.com/partners/userAdRevenue/v3?appKey=12345678&date=2018-12-15&reportType=1

响应示例网址

https://user-ad-revenue.s3.amazonaws.com/data/bi database/uar/tables/network/report version%3Dv1/publisher id% 3D 138101/application id% 3D 100411/day% 3D 2018-07-13/000000.gz?AWSAccessKeyId=AKIAILCCGIXP5G2XNXBA&Expires=153252 ⁇ &Signature=1U%2FbrLmb%2F7TwXXdoHtb%2F%2FQjrmz0% 3D

下载报告

选择要下载报告的网址。以下部分概述了各种报告字段的定义。

字段定义

字段

描述

示例

Ad Unit
产生收入的广告单元奖励视频
Advertising ID
用户设备的唯一 ID21d0e51a-772d-4b23-9fc4-296126b4f123
Advertising ID Type
用户设备的唯一 ID 类型IDFA/IDFV/GAID
User ID
开发者正在设置的用户 ID135920
Segment
用户相关的细分段,根据细分段定义