Reporting API - 发行商
以发行商身份访问 Tapjoy Offerwall 的 Reporting API,从而获取详细数据,监控和评估应用表现,以及优化变现策略。
阅读时间7 分钟最后更新于 4 天前
作为发行商,您可以使用 Reporting API 来获取集成了 Offerwall 的应用的报告数据。
先决条件
您必须通过 API 的身份验证。请参阅 API 身份验证。- 如需了解如何通过 Reporting API 管理您的内容,请参阅内容管理。
- 如需了解 Reporting API 的错误处理机制和限制,请参阅 Reporting API 最佳实践。
发行商报告指标
Reporting API 可用于请求 Offerwall 内容的效果数据,包括点击、转化和总收入等指标。下表列出了所有可用的发行商报告指标。 建议发行商使用以下基本查询开始获取效果指标:{ publisher { placements(appId: "00000000-0000-0000-0000-000000000000") { id name insights( timeRange: {from: "YYYY-MM-DDT00:00:00Z", until: "YYYY-MM-DDT00:00:00Z"} ) { timestamps reports { dailyUniqueViewers earnings } } } }}
发行商指标 | 描述 | 国家/地区 | 应用组 | 单个发行商应用 | 广告位 | 所有发行商应用总和 |
|---|---|---|---|---|---|---|
| 在应用、广告位或内容卡片中通过 Offerwall 广告完成转化的独立用户的平均数量(每个用户每 24 小时最多计一次),以天数取平均值 | 是 | 是 | 是 | 是 | 是 |
| 每个每日活跃用户的平均收入(总收入除以每日活跃用户数) | 是 | 是 | 是 | 否 | 是 |
| 每日独立 Offerwall 浏览用户的平均收入(即总收入除以在应用中浏览过 Offerwall 的独立用户数,每个用户每 24 小时最多计一次) | 是 | 是 | 是 | 否 | 是 |
| 每日活跃用户的平均数量(每个用户每 24 小时最多计一次),以天数取平均值 | 是 | 是 | 是 | 否 | 是 |
| 在应用中浏览过 Offerwall 的独立用户的平均数量(每个用户每 24 小时最多计一次),以天数取平均值 | 是 | 是 | 是 | 否 | 是 |
| 广告位产生的点击量 | 是 | 否 | 否 | 是 | 否 |
| 广告位产生的转化量 | 是 | 否 | 否 | 是 | 否 |
| 每日活跃用户数 | 是 | 是 | 是 | 否 | 是 |
| 在此广告位或内容卡片中通过广告完成转化的用户数(每个用户每 24 小时最多计一次)。目前仅适用于 Offerwall 内容卡片 | 是 | 否 | 否 | 是 | 否 |
| 在应用中通过 Offerwall 广告完成转化的独立用户数(每个用户每 24 小时最多计一次) | 是 | 是 | 是 | 否 | 是 |
| 在应用中浏览过 Offerwall 的独立用户数(每个用户每 24 小时最多计一次) | 是 | 是 | 是 | 否 | 是 |
| 在此广告位或内容卡片中浏览过广告的独立用户数(每个用户每 24 小时最多计一次)。目前仅适用于 Offerwall 内容卡片 | 是 | 否 | 否 | 是 | 否 |
| 在此广告位或内容卡片中通过广告完成转化的用户数(每个用户每 24 小时最多计一次)除以在此广告位或内容卡片中浏览过广告的用户数(每个用户每 24 小时最多计一次) | 是 | 是 | 是 | 是 | 是 |
| 在应用中浏览过 Offerwall 的独立用户数(每个用户每 24 小时最多计一次)除以每日活跃用户数 | 是 | 是 | 是 | 否 | 是 |
| 收入总金额 | 是 | 否 | 否 | 是 | 否 |
| 总收入 /(总 Offerwall 打开次数 / 1000)。以美元为单位表示 | 是 | 否 | 否 | 是 | 否 |
| 广告位产生的展示量 | 是 | 否 | 否 | 是 | 否 |
| 新用户数量 | 是 | 是 | 是 | 否 | 是 |
| 打开 Offerwall 的总次数 | 是 | 是 | 是 | 否 | 是 |
| 打开应用的次数 | 是 | 是 | 是 | 否 | 是 |
| 总收入 | 是 | 是 | 是 | 否 | 是 |
- 展示量/观看量
- 转化率 (CVR)
指标细分
通过向查询中添加细分段字段,API 可以返回按应用、广告位和/或国家/地区细分的效果数据。 Reporting API 支持以下细分段:- country
- id(应用组 ID)
- id(发行商 App ID)
- placement
- platform
- 所有发行商应用总计
细分示例
按国家/地区细分
{ publisher { placements(appId: "00000000-0000-0000-0000-000000000000") { id insights(timePreset: TODAY) { timestamps reports { country dailyUniqueViewers } } } }}
按应用组细分
{ publisher { apps(first: 3) { nodes { appGroupId insights(timePreset: TODAY) { reports { dailyActiveUsers } } } } }}
按发行商应用细分
query { publisher { apps(first:3) { edges { node { name insights(timePreset:TODAY) { reports { dailyActiveUsers } } } } } }}
按广告位细分
{ publisher{ placements(appId: "00000000-0000-0000-0000-000000000000") { id name insights(timePreset: TODAY) { reports { impressions } timestamps } } }}
按平台细分
{ publisher { placements(appId: "00000000-0000-0000-0000-000000000000") { id insights(timePreset: TODAY) { timestamps reports { platform dailyUniqueViewers } } } }}
所有发行商应用总和
表示此发行商下所有应用的请求指标的总和。{ publisher { publisherAppInsights(timePreset: TODAY) { timestamps reports { ecpm totalRevenue offerwallViews } } }}
过滤功能
通过向查询中添加过滤器,API 将仅返回指定来源的效果指标。Reporting API 支持以下过滤功能:- appId(单个应用)
- apps(前_或_后 x 个应用)
- appGroupId
- content
- country
- platform
- timePreset
- timeRange
过滤示例
按应用过滤
结果将限于单个应用{ publisher{ app(id: "<app ID>") { id name insights(timePreset: TODAY) { reports { arpdau } timestamps } } }}
按多个应用过滤
结果将限于_前_或_后_ x 个应用{ publisher { apps(first: 3) { nodes { id platform insights { reports { arpdau totalRevenue } } } } }}
按应用组 ID 过滤
结果将限于特定应用组 ID 下的应用{publisher { publisherAppInsights(timePreset: TODAY, filter: {appGroupIds: ["00000000-0000-0000-0000-000000000000"]}) { timestamps reports { offerwallViews eCPM totalRevenue } }
按内容卡片过滤
结果将限于单个内容卡片 ID{ publisher { placements(appId: "<app ID>") { id name content(id: "<content ID>") { id type insights(timePreset: TODAY) { timestamps reports { earnings } } } } }}
按国家/地区过滤
结果将限于指定的地域{publisher { publisherAppInsights(timePreset: TODAY, filter: {countries: ["KR, US"]}) { timestamps reports { offerwallViews eCPM totalRevenue } }
按平台过滤
结果将限于指定的平台{publisher { publisherAppInsights(timePreset: TODAY, filter: {platforms: [ios]}) { timestamps reports { offerwallViews eCPM totalRevenue } }
按预设时间范围过滤
结果将限于预设时间范围。这是一个相对时间范围,结果将因查询运行时间而有所不同。 选项:_LAST_30D__LAST_WEEK__TODAY__YESTERDAY_{ publisher { placements(appId: “<app ID>”) { content(id: “<content card ID>") { insights(timePreset:LAST_30D, timeIncrement: DAILY) { timestamps reports { dailyUniqueViewers } } } } }}
按绝对时间范围过滤
结果将限于指定的绝对时间范围。 最大的时间范围为 3 个月,支持的最早日期为过去 2 年。{ publisher { placements(appId: “<app ID>”) { content(id: “<content card ID>") { insights(timeRange: {from: "2024-11-15T00:00:00Z", until: "2024-11-17T00:00:00Z"}, timeIncrement: DAILY) { timestamps reports { dailyUniqueViewers } } } } }}
已弃用的维度
以下旧版维度于 2025 年 2 月 3 日从 Reporting API 中移除。为防止从 Tapjoy 的 Offerwall 获取数据时出错,请确保您的 API 查询不会引用下面以粗体格式列出的任何维度。 对象 > ContentCard > ecpmSettings 枚举 > PublisherContentType:ANNOUNCEMENTDIRECT_PLAY_HOUSE_ADFEATUREDFSI_HOUSE_ADIAP_PROMOTIONINTERSTITIAL_VIDEOMEDIATED_DIRECT_PLAYMEDIATED_FSIPREVIEW_CODEPROGRAMMATIC_INTERSTITIAL_VIDEOPROGRAMMATIC_REWARDED_VIDEOREWARDED_VIDEOTJ_RECOMMENDEDREWARD_UNLOCK
CreatePlacementAndContentSetInputUpdatePlacementAndContentSetInputecpmSettingsToAddecpmSettingsToDeleteecpmSettingsToUpdate