レポートの概要

Campaign Manager 360 API には、キャンペーン マネージャー 360 から入稿された広告のデータを取得する方法がいくつか用意されています。

レポート サービス

Reports サービス を使用してレポートを生成するには、レポート ファイル (CSV や Excel 形式など)を構成、生成、取得する複数ステップのワークフローが必要です。これは、Campaign Manager 360 API の標準的なレポート作成パスであり、大規模なデータセット、自動化されたスケジュール設定スクリプト、またはファイルを消費するダウンストリーム アプリケーションに適しています。

通常、ワークフローは次の手順で構成されます。

  1. 一意のレポート ID で保存される Report リソース(ディメンション、指標、期間、フィルタを指定)を定義または検索します。レポートの作成と 更新をご覧ください。
  2. reports.run メソッドを呼び出してレポート生成を実行します。これにより、レポートの実行がキューに登録され、プレースホルダの File リソースが返されます。レポートの検索と実行をご覧ください。
  3. File リソースのステータスを定期的に確認します。このプロセスは非同期で実行されるため、ファイルのステータスは PROCESSING から始まり、完了すると REPORT_AVAILABLE に移行します。レポートの検索と実行をご覧ください。
  4. レポートの生成が完了したら、ファイルの内容(CSV または Excel)を取得します。レポートをダウンロードするをご覧ください。

レポートを同期的に実行する

少量のデータのレポート ファイル(CSV または Excel)を生成する必要がある場合は、 同期的にレポートを実行できます。これには、 reports.run メソッドを呼び出し、synchronous パラメータを true に設定します。API は、短いタイムアウト期間内にレポートを生成しようとします。実行に時間がかかると、レポートの実行は自動的に非同期キューに戻ります。

詳細については、同期レポートをご覧ください。

レポートデータをクエリする

reportData.query メソッドを使用すると、レポート ファイルを生成する代わりに、レポートデータ を直接クエリできます。

  • Report リソースを作成して保存する代わりに、リクエストでディメンション、指標、その他のフィルタリング条件や並べ替え条件を直接指定します。
  • レスポンスには構造化されたレポートデータが含まれているため、生成されたファイルをポーリングしてダウンロードする必要はありません。
  • リクエストは 60 秒の制限内で同期的に実行されます。

詳細については、JSON レポートデータをクエリするをご覧ください。