文档

支持

用户级收入 API 概述

使用 Tapjoy Offerwall 的用户级收入 API 追踪特定用户的收入,并根据实用的洞察信息调整应用的变现策略。
阅读时间4 分钟最后更新于 4 天前

Tapjoy 允许发行商通过用户级广告收入 API 访问其 Offerwall 用户级广告收入数据,此外还可使用我们现有的任务数据回调。此 API 通过存储在 Amazon Web Services (AWS) S3 中的 CSV 文件,直接向移动端成效衡量合作伙伴 (MMP) 或发行商合作伙伴提供用户级广告收入报告。 为了发起请求,用户需要提供相关的 Tapjoy App ID(与 Tapjoy LTV 后台的应用关联的 ID)和所需数据的日期。 要使用此 API,MMP 或合作伙伴必须使用其 Reporting API/Marketing API 密钥向 Tapjoy OAuth 终端发起请求以获取访问令牌。获得访问令牌后,用户向 Tapjoy Report API 发起请求以获取指向 AWS S3 报告的预签名 URL。预签名 URL 在获取后 5 分钟内有效,可用于访问这些报告。最后,对 AWS S3 报告 URL 的请求将返回包含用户级广告收入数据的 CSV 报告。

Report API

终端:
https://api.tapjoy.com/api/client/publisher/apps/<app_id>/user_revenue_report
可使用 Reporting API/Marketing API 密钥通过 OAuth 进行访问。 必需参数:
  • 发行商 App ID
  • UTC 日期
可接受的日期格式为 mm/dd、mm/dd/yyy、mm/dd/yy、dd-mm yyyy-mm-dd、yy-mm-dd 返回一个静态报告 URL 数组,包括有效期为 5 分钟的预签名身份验证令牌。

请求示例

GET api/client/publisher/apps/<publisher_app_id>/user_revenue_report?date=<date> Host: api.tapjoy.com Authorization: Bearer <access_token_string> Accept: application/json

响应示例

成功

{ "urls": [ "https://tapjoy.amazon.s3.com/data/report.csv.gz&key=secure" ]}

失败

status 404 { “reason”: “No publisher app with id <publisher_app_id> found.”}

S3 API

数据 SLA - 第 x 天的数据在第 x+1 天 01:00(UTC 时间)之前准备就绪 留存 SLA - 报告的可用时间为 14 天(第 x 天 + 15 天) 返回用户级收入报告的 CSV 文件

请求示例

GET /data/report.csv.gz&key=secureHost: tapjoy.amazon.s3.com Accept: application/json

响应示例

成功

status 200 { CSV File}

字段概述

下表详细说明了报告中的不同列的含义。

字段

描述

date_id and report_date这是 API 请求中由用户指定的报告日期。报告中的指标会基于这个指定日期
partner_id这是您在 Tapjoy 内部的标识符
app_name 和 appkey这些是应用的名称和 Tapjoy 标识符
IDFA/IDFV/GAID根据具体平台,这些列将具有标识符值或为“UNKNOWN(未知)”
device_os_version关联的移动设备的操作系统版本
att_status设备的 iOS 应用追踪透明度状态(如果已知)
publisher_user_id与设备关联的发行商标识符(如果可用)
ad_unit此字段的值将始终为 offerwall,供 MMP 用于处理
placementTapjoy 广告位名称
content_cardTapjoy 内容卡片名称
geoip_country与设备相关的国家/地区(如果可通过 IP 查找获得)
currency_sale值为 1 表示发生相关转化时未在进行货币促销,如果存在促销,则为货币乘数值
conversion_rate这是交易使用的货币兑换比例
impressions此设备 ID 在指定日期关联的总展示量。这一数值反映用户在完成转化当天查看转化任务的次数
publisher_amount此设备 ID 在指定日期关联的总收入

常见问题解答

否,此报告仅包含 Offerwall 广告收入。如果需要用户级广告收入数据,合作伙伴应联系他们的聚合平台以访问适用的 API 或报告。

发行商合作伙伴可以在 14 天内访问报告,每天凌晨 1:00(UTC 时间)开始可以访问前一天的报告。

在 MR-CPE 产品中,从广告展示到用户后续在多重奖励漏斗图中完成事件转化,通常会有延迟(可能长达几天甚至几周)。

以美元 (USD) 显示

同一名用户在同一个发行商应用中查看任务和最终完成转化时,其
publisher_user_ids
geoip_countries
有可能会不同。这些 ID 由发行商在 SDK 初始化时设置,因此有可能会发生如下情况:
1.用户以
publisher_user_id A
进行连接。 2.他们查看任务 A。查看记录中显示
publisher_user_id A
。 3.用户稍后以
publisher_user_id B
进行连接。 4.他们再次查看任务 A。查看记录中显示
publisher_user_id B
。 5.他们完成转化。转化记录中显示
publisher_user_id B
geoip_countries
也可能发生同样的情况。为了避免收入膨胀,需要将这些值合并为一行。