升级指南

1. 从Insights API升级

Insights Reporting API 是一个 REST API,用于检索有关广告(称为广告组)的指标。 要从 Insights API 升级,请将您的入口从 https://api.tapjoy.com/v1/ad_groups/<id>/insights 修改为 https://api.tapjoy.com/graphql。 身份验证过程保持不变。

id 字段的变化

Insights API 请求中使用的id指的是primary或secondary广告ID。 在 Marketing API 中,primary和secondary广告已合并到一个名为 AdSet 的实体中。 您可以使用primary广告 ID 查询 AdSet。

例如,下面描述了 ids 如何从 Insights API 转换为 Marketing API:

Insights API
Marketing API
GET /v1/ad_groups/00000000-0000-0000-0000-000000000000/insights
Host: api.tapjoy.com
Authorization: Bearer <OAuth Token>

指标变化

由于primary和secondary广告已合并到一个 AdSet 中,因此 Marketing API 中的insights指标旨在反映完整的转化数据。

例如,以下 Insights API 请求/响应:

Request
Response
GET /v1/ad_groups/00000000-0000-0000-0000-000000000000/insights?start_time=2018-03-06T00:00:00Z&end_time=2018-03-07T00:00:00Z&time_increment=daily
Host: api.tapjoy.com
Authorization: Bearer <OAuth Token>

...将在 Marketing API 中转换为以下请求/响应:

Query
Marketing API
query {
  adSet(id: "00000000-0000-0000-0000-000000000000") {
    insights(timeRange: {from: "2018-03-06T00:00:00Z", until: "2018-03-07T00:00:00Z", timeIncrement: DAILY}) {
      timestamps
      reports {
        country
        impressions
        mediaP100WatchedActions
        callToActionClicks
        conversions
        spend
      }
    }
  }
}

如您所见,为了构建整个转化数据,您还必须在旧版 Insights API 中请求secondary广告数据。

在 Marketing API 中,所有指标都通过 AdSet 组合在一起。 这些都对应旧版相应指标,如下所示:

Marketing API 指标 Insights API 指标
Impressions global_renders / paid_clicks (Primary)
Media P100 Watched Actions global_conversions (Primary), global_renders / paid_clicks (Secondary)
Call-to-action Clicks n/a
Conversions global_conversions (Secondary)
Spend installs_spend (Primary / Secondary)