快速指南

This API is now deprecated. Access to this API will be removed in late June 2023 after which the Tapjoy GraphQL API must be used for reporting purposes.

1. 身份验证

请求使用标准的两层OAuth2身份验证流程:使用publisher reporting api 密钥请求access_token, 并使用生成的access_token对后续的请求进行身份验证。Access token的生命周期为1个小时,一旦access token过期,只需使用publisher reporting api 密钥重新请求新access token即可。

密钥必须以管理员账户登录时在控制面板(设置-应用设置)获取。如果不是管理账户下获取到的密钥,即使数据可用,API也可能返回“空”。

image_title

A. 请求示例

POST /v1/oauth2/token
Host: api.tapjoy.com
Authorization: Basic [base_64(Publisher Reporting API Key)]
Accept: application/json; */*

B. 成功响应

status 200
{
  “access_token”: “token_string”,
  “token_type”: “bearer”,
  “expires_in”: 3600,
  “refresh_token”: null
}

C. 无效凭证响应

status 401
{
  “error”: “Bad or missing authentication token”
}

2. 请求数据

一旦得到access_token就可以开始后续的API请求。access_token需要在每个请求中以“Bearer”类型填入Authorization header。如果access_token已经过期或者不存在,将会返回401 Unauthorized。token生命周期是1小时。

请求示例

GET /v2/publisher/reports?
Host: api.tapjoy.com
Authorization: Bearer [Access token]
Accept: application/json; */*

重要提示: 按展示位置查询时,API仅会返回LTV平台中当前处于活动状态或存在的展示位置的数据。 如果您删除某个展示位置,则该展示位置的历史数据也将被删除(但在content_type查询中仍然存在)。