用户层级收益API介绍

1. 简介

除了我们现有的广告数据回调外,Tapjoy现在还允许发布者通过用户级广告收入API访问他们的积分墙用户级广告收入数据。此API 通过存储在 Amazon Web Services (AWS) S3 中的 CSV 文件直接向移动监测合作伙伴 (MMP) 或发布者合作伙伴提供用户级广告收入报告。

为了发出请求,用户需要相关的Tapjoy App ID(与Tapjoy LTV 后台的应用程序关联的ID)和需要数据的日期。

要使用API,MMP 或合作伙伴必须使用他们的Marketing API 密钥向 Tapjoy OAuth endpoint 发出请求以获得访问令牌。使用访问令牌,然后使用Tapjoy Report API 发出请求,以获取存储在AWS S3中的报告的URL。URL将允许在检索后 5 分钟内访问报告。最后,访问AWS S3 URL可以获取包含用户级别广告收入数据的 CSV 报告。

2. Report API

Endpoint

https://api.tapjoy.com/api/client/publisher/apps/<app_id>/user_revenue_report

使用Marketing API密钥获取相关访问令牌,请参考OAuth

需要的参数:

  • 开发者app ID
  • UTC时区的时间

可以接受的时间格式: mm/dd, mm/dd/yyyy, 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.” 
}

3. S3 API

数据 SLA - 第 x 天的数据将在第 x+1 天 01:00 UTC 准备就绪

留存 SLA - 报告有效期为 14 天(第 x + 15 天)

返回用户级别收入报告的 CSV 文件

请求示例

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

响应示例

成功


status 200 
{ 
	CSV File
}

失败


status 401 
{ 
	“error”: “Unauthorized” 
}

status 404 
{ 
	“error”: “Not Found” 
}

5. FAQ

此报告是否包括视频收入?

不,此报告仅包括 Offewall 广告收入。 如果需要用户级别的广告收入数据,则合作伙伴应联系聚合平台以访问适用的 API 或报告。

这份报告包括多长时间数据?

开发者合作伙伴可以访问报告 14 天,每天凌晨 1:00 UTC 将提供前一天的报告。

为什么某些用户级别条目的展示次数列中的值为零,而收入的值却非零?

对于 MR-CPE 产品,展示展示与稍后在多奖励中发生事件转化之间通常存在延迟(数天甚至数周)。

我的开发者收入金额以什么货币显示?

以美元 (USD) 显示

当前哪个第三方支持此API

*Appsflyer.

为什么 publisher_user_id 或 geoip_countries 列中有多个结果?

用户可以在具有不同 publisher_user_ids或geoip_countries的同一开发者应用程序中查看和完成转化。 这些ID由发布者在SDK初始化时设置,因此可能会发生以下情况:

  1. 用户连接publisher_user_id A
  2. 他们查看offer A,查看记录有publisher_user_id A
  3. 用户稍后使用 publisher_user_id B 连接
  4. 他们再次查看广告 A。 查看记录有 publisher_user_id B
  5. 他们完成转化。 转换记录有 publisher_user_id B

geoip_countries 也可能发生同样的事情。 为避免虚增收益,这些值需要合并成一行。