Reporting API 広告主向け

最終更新日: 2025年1月22日

概要

広告主は、Reporting APIを使用してオファーウォールで配信された広告のレポートデータを取得できます。

始める前に： API認証の手順に従って、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での毎日の最初の1時間の箇所に報告されます。粒度がHOURLYの場合、00:00:00 UTC - 00:59:59 UTC の時間帯だけが0以外の値を持ちます。
conversions	広告目的に対するコンバージョン数
csConversions	カスタマーサービスによるコンバージョン数
csSpend	カスタマーサポートに対して使用された総額
ecpi	総支出 ÷ 総エンゲージメント数
engagementInstalls	エンゲージメントから推測されたインストール数
impressions	オファーウォール内で広告がクリックされた回数。注：このメトリクスは、実際には「インプレッション」ではなく「クリック」をより正確に表します。今後、メトリクス名が変更される予定です。
offerwallAverageRank	広告が表示されたオファーウォールの平均順位（重み付き）。値は1から昇順で、1が最上位を表します。0の場合は、該当期間中にオファーウォールに表示されなかったことを意味します。
offerwallImpressions	広告がオファーウォールに表示された回数。 注：広告は表示されても、ユーザーに視認されない可能性があります（例：スクロールされていない）。offerwallTrueImpressionsの使用を推奨します。
offerwallTrueImpressions	広告がユーザーに視認された回数。各表示は「真のインプレッション」として登録されます。
returnOnAdSpend	各日にインストールしたユーザーに対する広告費回収率（ROAS）。 注：このメトリクスはUTCでの毎日の最初の1時間の箇所に報告されます。
dayXRoas	インストールからX日後のROAS。day_X_roas_revenue ÷ day_X_roas_spendで計算されます。収益が0の場合、このフィールドも0になります。X = 0, 1, 2, 3, 4, 5, 6, 7, 14, 30, 60, 90に対応。
dayXRoasAdRevenue	インストールからX日後の広告収益。対応範囲：X = 0, 1, 2, 3, 4, 5, 6, 7, 14, 30, 60, 90。
dayXRoasEngagements	インストールからX日後のユーザーエンゲージメント数。 対応範囲：X = 0, 1, 2, 3, 4, 5, 6, 7, 14, 30, 60, 90。
dayXRoasIapRevenue	インストールからX日後のアプリ内課金収益。対応範囲：X = 0, 1, 2, 3, 4, 5, 6, 7, 14, 30, 60, 90。
dayXRoasRevenue	インストールからX日後のユーザー収益。 この値は インストール後X日目のIAP収益 + インストール後X日目広告収益として計算されます。 対応範囲：X = 0, 1, 2, 3, 4, 5, 6, 7, 14, 30, 60, 90。
dayXRoasSpend	インストールからX日後の広告主による支出額。 対応範囲：X = 0, 1, 2, 3, 4, 5, 6, 7, 14, 30, 60, 90。
spend	総支出額

ダッシュボード上で利用可能な追加の広告主メトリクス

• コンバージョンレート（CVR）
• インストラクションCVR
• コンバージョン数/インプレッション数
• クリックレート（CTR）
• 合計 支出に基づくROAS（Reporting APIは コホート の支出に基づくROASを返します）

メトリクスのセグメンテーション

クエリにセグメントフィールドを追加することで、イベント、パブリッシャーアプリ、国などで分割されたパフォーマンスデータを取得できます。Reporting APIでサポートされているセグメント分類は以下の通りです:

• country（国）
• attributionSource（アトリビューションソース）
• language（言語）
• platform（プラットフォーム）
• id (Publisher App ID)
• id (AdSet/Offer ID)
• multiRewardEngagementEvent（マルチリワード エンゲージメント イベント）

セグメンテーションの例

Country、Attribution Source および Language によるセグメント

{
  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
      }
    }
  }
}

Platform によるセグメント

{
  advertiser{
    id
    campaigns(first: 2){
      nodes{
        insights{
          reports{
            impressions
            platform
          }
        }
      }
    }
  }
}

Publisher App によるセグメント

query {
  adSet(id: "00000000-0000-0000-0000-000000000000") {
    ads {
      id
      insights(timePreset: TODAY) {
        reports {
          app {
            bundleId
          }
          impressions
          conversions
          spend
        }
      }
    }
  }
}

Ad Set/Campaign によるセグメント

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

Multi-Reward Engagement Event によるセグメント

{
  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
        }
      }
    }
  }
}

フィルタリング機能

クエリにフィルタを追加することで、指定されたソースのパフォーマンスメトリクスのみを取得できます。サポートされているフィルタ:

• adSet (単一 Ad Set)
• adSets (複数 Ad Sets)
• appIds (Publisher App)
• configuredStatus (ACTIVE, ARCHIVED, or PAUSED)
• countries（国）
• timePreset（時間のプリセット）
• timeRange（絶対時間範囲）

フィルターの例

Ad Set でフィルター

結果を一つの adSet に制限します。

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

複数 Ad Set でフィルター

結果を first または last x 個の Ad Set に制限します。

query {
  advertiser {
    adSets(first: 2) {
      edges {
        node {
          insights(timePreset:TODAY) {
            reports {
              conversions
            }
          }
        }
      }
    }
  }
}

Publisher App でフィルター

結果を指定した publisher の app 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
      }
    }
  }
}

Configured Status でフィルター

結果を指定したステータスの ad sets/campaigns に制限します。

Options: ACTIVE, ARCHIVED, or PAUSED

query {
  advertiser {
    adSets(first: 2, configuredStatus: ACTIVE) {
      edges {
        node {
          insights(timePreset:TODAY) {
            reports {
              conversions
            }
          }
        }
      }
    }
  }
}

Country でフィルター

結果を指定した country に制限します。

query {
  adSet(id: "00000000-0000-0000-0000-000000000000") {
    insights(filter:{countries: [JP, US]}) {
      timestamps
      reports {
        conversions
      }
    }
  }
}

プリセットされた時間範囲でのフィルター

これは、あらかじめ定義された時間範囲に結果を制限します。この範囲は相対的なものであり、クエリの実行時点によって結果が変動します。

オプション: LAST_30D, LAST_WEEK, TODAY, YESTERDAY.

注：データの集計レベルを定義するには、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 パラメータを指定してください。利用可能な値は 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から削除されます。Tapjoyのオファーウォールからデータを取得する際にエラーを防ぐため、APIクエリ内で太字のディメンションを参照しないようにしてください。

• Enums > TargetConnectionType > MOBILE
• Enums > TargetDeviceType > WINDOWS