Reporting API - 広告主
広告主は Tapjoy Offerwall の Reporting API にアクセスし、詳細なデータの取得、アプリのパフォーマンスの監視と評価、キャンペーンに関するより優れた分析情報獲得のためのレポートクエリの最適化を行うことができます。
読み終わるまでの所要時間 6 分最終更新 10日前
パブリッシャーは Reporting API を使用して、Offerwall で提供される広告のレポートデータを取得できます。
前提条件
API を使用して認証する 必要があります。- Reporting API を使用してキャンペーンを管理する方法については、キャンペーンの管理 を参照してください。
- Reporting API のエラー処理と制限事項については、Reporting API のベストプラクティス を参照してください。
広告主レポート指標
Reporting API を使用して、収益、インプレッション数、コンバージョン数などの指標を含む、広告セットやマルチリワードイベントのパフォーマンスデータをリクエストできます。利用可能な広告主レポート指標はすべて、以下の表に列挙されています。 広告主には、以下の基本クエリからパフォーマンス指標の取得を開始することをお勧めします。query { adSet(id: "00000000-0000-0000-0000-000000000000") { insights(timeRange: {from: "YYYY-MM-DDT00:00:00Z", until: "YYYY-MM-DDT00:00:00Z"}) { timestamps reports { impressions } } }}
広告主指標 | 説明 |
|---|---|
| amount | このイベントの入札。 |
| averageBid | 合計支出を合計コンバージョンで割った値。 |
| callToActionClicks | 行動喚起が存在する場合に、ユーザーが行動喚起をクリックした回数。 |
| clickToConversionTime | クリックからコンバージョンまでの時間データが複数の異なる方法でセグメント化されます。CTCT 指標は、毎日の最初の UTC 時間にだけ報告されることに注意してください。粒度 |
| conversions | 広告目標のコンバージョン数。 |
| csConversions | 広告目標に対するカスタマーサービスのコンバージョン数。 |
| csSpend | カスタマーサポートの総支出額。 |
| ecpi | 合計支出を合計エンゲージメントで割った比率。 |
| engagementInstalls | エンゲージメントから推定されたインストール数。 |
| iaaRevenue | 選択した時間範囲内にオファーによって発生した合計広告収益。 |
| iapRevenue | 選択した時間範囲内にオファーによって発生した合計 IAP 収益。 |
| impressions | Offerwall で広告がクリックされた回数。この指標はより正確には |
| offerwallAverageRank | 広告が配信された Offerwall の (加重) 平均位置。値は 1 から昇順で表示され、1 は Offerwall の最上位の位置を表します。値 0 は、オファーが選択した期間に Offerwall に表示されなかったことを表します。 |
| offerwallImpressions | 広告が Offerwall に表示された回数。広告が Offerwall に表示されても、ユーザーによって視聴されない (ユーザーが広告を見ることができる位置までスクロールしていない) ことがあります。広告主には、以下の |
| offerwallTrueImpressions | Offerwall でユーザーが広告を視聴した回数。各視聴は真のインプレッションとして登録されます。 |
| returnOnAdSpend | 各日にインストールしたユーザーの広告費回収率データ。広告費回収率指標は、毎日の最初の UTC 時間にだけ報告されることに注意してください。 |
| dayXRoas | インストールから |
| dayXRoasAdRevenue | インストール後 |
| dayXRoasEngagements | インストールから |
| dayXRoasIapRevenue | インストールから |
| dayXRoasRevenue | インストールから |
| dayXRoasSpend | インストールから |
| spend | 合計支出額。 |
| totalRevenue | 選択した期間のオファーによって発生した収益合計額 (IAP + 広告収益)。これは |
- コンバージョン率 (CVR)
- 指示 CVR
- コンバージョン数/インプレッション数
- クリックスルー率 (CTR)
- 合計 支出による ROAS (Reporting API は コホート化 された支出による ROAS を返します)
指標のセグメント化
クエリにセグメントフィールドを追加することで、API はイベント、パブリッシャーアプリ、国ごとなどのパフォーマンスデータを返すことができます。Reporting API は、以下の内訳でのセグメント化に対応しています。- country
- attributionSource
- language
- platform
- id (パブリッシャーアプリ ID)
- id (AdSet/オファー ID)
- multiRewardEngagementEvent
セグメント化の例
国、アトリビューションソース、言語別のセグメント
{ adSet(id: "00000000-0000-0000-0000-000000000000") { insights(timeRange: {from: "2024-08-01T00:00:00Z", until: "2024-08-01T11:59:59Z"}, timeIncrement: DAILY) { timestamps reports { country attributionSource language conversions } } }}
プラットフォーム別のセグメント
{ advertiser { id campaigns(first:2) { nodes { insights { reports { impressions platform } } } } }}
パブリッシャーアプリ別のセグメント
query { adSet(id: "00000000-0000-0000-0000-000000000000") { ads { id insights(timePreset: TODAY) { reports { app { bundleId } impressions conversions spend } } } }}
広告セット/キャンペーン別のセグメント
query { advertiser { adSets(first: 50, configuredStatus: ACTIVE) { edges { node { id insights(timeRange: {from: "2024-11-15T00:00:00Z", until: "2024-11-16T00:00:00Z"}) { timestamps reports { conversions spend } } } } } }}
マルチリワードエンゲージメントイベント別のセグメント
{ adSet(id: "00000000-0000-0000-0000-000000000000") { id insights(timeRange: {from: "2024-11-15T00:00:00Z", until: "2024-11-15T11:59:59Z"}, timeIncrement: DAILY) { timestamps reports { conversions returnOnAdSpend { day0Roas } multiRewardEngagementEvent { eventName } } } } }
フィルタリング機能
クエリにフィルターを追加すると、API は指定されたソースからのみパフォーマンス指標を返します。Reporting API は以下のフィルタリング機能に対応しています。- adSet (単一の広告セット)
- adSets (複数の広告セット)
- appIds (パブリッシャーアプリ)
- configuredStatus (ACTIVE、ARCHIVED、または PAUSED)
- countries
- timePreset
- timeRange
フィルタリングの例
広告セットによるフィルター
これにより、結果が 1 つの 広告セット に制限されます。query { adSet(id: "00000000-0000-0000-0000-000000000000") { insights(timeRange: {from: "2024-08-06T00:00:00Z", until: "2024-08-07T00:00:00Z"}) { timestamps reports { impressions conversions spend offerwallAverageRank } } }}
複数の広告セットによるフィルター
これにより、結果が 最初 または 最後 の x 個の広告セットに制限されます。query { advertiser { adSets(first: 2) { edges { node { insights(timePreset:TODAY) { reports { conversions } } } } } }}
パブリッシャーアプリによるフィルター
結果を指定したパブリッシャーアプリ ID に制限しますquery { adSet(id: "00000000-0000-0000-0000-000000000000") { insights(filter:{appIds: ["00000000-0000-0000-0000-000000000000", "00000000-0000-0000-0000-000000000000"]}) { timestamps reports { conversions } } }}
設定状態によるフィルター
これにより、結果が指定された状態の広告セット/キャンペーンに制限されます。 オプション:ACTIVEARCHIVEDPAUSEDquery { advertiser { adSets(first: 2, configuredStatus: ACTIVE) { edges { node { insights(timePreset:TODAY) { reports { conversions } } } } } }}
国によるフィルター
これにより、結果が指定された国に制限されますquery { adSet(id: "00000000-0000-0000-0000-000000000000") { insights(filter:{countries: [JP, US]}) { timestamps reports { conversions } } }}
プリセット期間によるフィルター
これにより、結果がプリセットされた期間に制限されます。これは相対的な時間範囲であり、クエリの実行時間によって結果が異なります。 オプション:LAST 30DLAST WEEKTODAYYESTERDAY注
データ集計のレベルを定義するには、timeIncrement を組み込みます。timeIncrement は DAILY、HOURLY、MONTHLY の値を取ることができます。timeIncrement はオプションのパラメーターで、デフォルトは ALL です。
query { adSet(id: "00000000-0000-0000-0000-000000000000") { insights(timePreset:LAST_30D, timeIncrement: DAILY) { reports { impressions } } }}
絶対時間範囲によるフィルター
これにより、結果が指定された絶対時間範囲に制限されます。 最大範囲は 3 か月で、サポートされる最も古い日付は過去 2 年間です。注
データ集計のレベルを定義するには、timeIncrement を組み込みます。timeIncrement は DAILY、HOURLY、MONTHLY の値を取ることができます。timeIncrement はオプションのパラメーターで、デフォルトは ALL です。
query { adSet(id: "00000000-0000-0000-0000-000000000000") { insights(timeRange: {from: "2024-11-15T00:00:00Z", until: "2024-11-17T00:00:00Z"}, timeIncrement: DAILY) { reports { impressions } } }}
非推奨のディメンション
以下の古いディメンションは、2025 年 2 月 3 日に Reporting API から削除されました。API クエリが、以下の 太字 でリストされているディメンションを参照していないことを確認してください。これにより、Tapjoy の Offerwall からデータを取得するときのエラーを回避できます。- Enums > TargetConnectionType > MOBILE
- Enums > TargetDeviceType > WINDOWS