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 を基準とします。

ジョブ

Methods
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

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

reportTypes

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