YouTube Reporting API

YouTube Reporting API を使用すると、レポート作成ジョブのスケジュールを設定し、生成された一括レポートをダウンロードできます。この API は、事前定義された一連のレポートをサポートしています。各レポートには、チャンネルまたはコンテンツ所有者の YouTube アナリティクス データが包括的に含まれています。

レポート ジョブのスケジュール設定とレポートの取得の手順は次のとおりです。

  1. reportTypes.list() メソッドを呼び出して、チャンネルまたはコンテンツ所有者が取得できるレポートのリストを取得します。
  2. jobs.create() メソッドを呼び出して、チャンネルまたはコンテンツ所有者向けに生成する必要があるレポートを特定します。その後、API の jobs.list() と jobs.delete() を使用して、生成されるレポートのリストを取得または変更できます。
  3. jobs.reports.list() メソッドを呼び出して、特定のジョブ用に生成されたレポートのリストを取得します。レスポンス内の各リソースには、レポートをダウンロードできる URL を指定する downloadUrl プロパティが含まれています。
  4. 承認済みの GET リクエストを送信して、ダウンロード URL からレポートを取得します。

承認

YouTube Reporting API へのすべてのリクエストは承認を受ける必要があります。認可ガイドでは、OAuth 2.0 プロトコルを使用して認可トークンを取得する方法について説明しています。

YouTube Reporting API リクエストでは、次の認証スコープが使用されます。

スコープ
https://www.googleapis.com/auth/yt-analytics.readonly YouTube コンテンツの YouTube アナリティクス レポートを表示します。このスコープは再生回数や評価数など、ユーザー アクティビティの指標へのアクセスを提供します。
https://www.googleapis.com/auth/yt-analytics-monetary.readonly YouTube コンテンツに関する YouTube アナリティクス収益レポートを表示します。このスコープは、ユーザー アクティビティの指標と、推定収益と広告パフォーマンスの指標へのアクセスを提供します。

リソースタイプ

以降のセクションでは、API のリソースとメソッドの概要について説明します。表に示されているメソッド URI はすべて、https://youtubereporting.googleapis.com に対する相対 URI です。

jobs

メソッド
create POST /v1/jobs
レポートジョブを作成します。レポートジョブを作成すると、YouTube にそのレポートを毎日生成するよう指示することになります。レポートは、ジョブの作成後 24 時間以内に利用可能になります。
delete DELETE /v1/jobs/{jobId}
レポートジョブを削除します。
get GET /v1/jobs/{jobId}
チャンネルまたはコンテンツ所有者に対してスケジュールされた特定のレポートジョブに関する情報を取得します。
list GET /v1/jobs
チャンネルまたはコンテンツ所有者に対してスケジュール設定されたレポート ジョブを一覧表示します。レスポンス内の各リソースには id プロパティが含まれています。このプロパティは、YouTube がジョブを一意に識別するために使用する ID を指定します。この ID は、ジョブ用に生成されたレポートのリストを取得したり、ジョブを削除したりするために必要です。

jobs.reports

メソッド
get GET /v1/jobs/{jobId}/reports/{reportId}
特定のレポートのメタデータを取得します。
list GET /v1/jobs/{jobId}/reports
指定されたレポートジョブ用に生成されたレポートを一覧表示します。

reportTypes

メソッド
list GET /v1/reportTypes
チャンネルまたはコンテンツ所有者が取得できるレポート タイプのリストを返します。