アップグレード

1. 分析レポーティングAPI からの移行

分析レポーティングAPI はオファー(ad groupとして表記されます)に対する指標値を取得するREST APIです。この分析レポーティングAPIからアップグレードするには、APIのエンドポイントを https://api.tapjoy.com/v1/ad_groups/<id>/insights から https://api.tapjoy.com/graphql にまず変更します。認証プロセス手は同じです。

Change of id fields

分析レポーティング API のリクエストに含まれる id はプライマリまたはセカンダリの追跡用オファーを指すものです。本 API では、プライマリおよびセカンダリオファーは一つの AdSet と呼ばれる要素に統合されています。AdSet はプライマリのオファー ID を使用して検索できます。

例として、下記は分析レポーティングAPIのidが本APIでどのように変換されるかをあげます:

Insights API

Marketing API

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

指標値の違い

プライマリおよびセカンダリのオファーが統合されて一つの AdSet となるため、本API での分析の指標値はコンバージョンの全体像を反映するように設計されています。

例として、下記の分析レポーティング 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>

...本 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
      }
    }
  }
}

先述の通り、分析レポーティング API ではコンバージョンの全体像を得るためにはセカンダリオファーに対しても分析指標値をリクエストする必要がありました。

本 API では、すべての指標が一つの AdSet に統合されています。下記は旧 API の指標との対応表です:

GraphQL APIでの指標	分析レポーティングAPIでの指標
Impressions	global_renders / paid_clicks (プライマリ)
Media P100 Watched Actions	global_conversions (プライマリ), global_renders / paid_clicks (セカンダリ)
Call-to-action Clicks	n/a
Conversions	global_conversions (セカンダリ)
Spend	installs_spend (プライマリ / セカンダリ)

アップグレード
1. 分析レポーティングAPI からの移行

アップグレード

1. 分析レポーティングAPI からの移行

Change of id fields

指標値の違い

Contents