このページは Cloud Translation API によって翻訳されました。

API Reference

YouTube Analytics API を使用すると、YouTube チャンネルまたはコンテンツ所有者の YouTube アナリティクスデータを取得できます。API は、リアルタイムクエリをサポートし、API リクエストパラメータに基づいてレポートを生成します。

API は次の 2 種類の関数をサポートしています。

レポートの取得 – API の reports.query メソッドは YouTube アナリティクスレポートを取得します。
YouTube アナリティクスグループの管理 - YouTube アナリティクスグループは、最大 500 個のチャンネル、動画、再生リスト、アセットのカスタムコレクションです。API では、YouTube アナリティクスグループの作成、取得、更新を行うための複数のメソッドがサポートされています。チャンネルとコンテンツ所有者は、reports.query メソッドを使用して、グループ内のすべての項目の集計データを取得できます。これはパフォーマンスの分析に役立ちます。

このページでは、これらの機能を可能にする API リソースとメソッドの概要を説明します。

承認

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

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

スコープ
https://www.googleapis.com/auth/yt-analytics.readonly	YouTube コンテンツの YouTube アナリティクスレポートを表示します。このスコープは再生回数や評価数など、ユーザーアクティビティの指標へのアクセスを提供します。
https://www.googleapis.com/auth/yt-analytics-monetary.readonly	YouTube コンテンツに関する YouTube アナリティクス収益レポートを表示します。このスコープでは、ユーザーアクティビティの指標や、収益と広告パフォーマンスの推定指標を確認できます。
https://www.googleapis.com/auth/youtube	YouTube アカウントの管理YouTube アナリティクス API では、チャンネル所有者はこのスコープを使用して、YouTube アナリティクスのグループとグループアイテムを管理します。
https://www.googleapis.com/auth/youtubepartner	YouTube のアセットやそれに関連するコンテンツの表示と管理YouTube Analytics API では、コンテンツ所有者はこのスコープを使用して YouTube アナリティクスのグループとグループアイテムを管理します。

レポートの取得

API の reports.query メソッドを使用すると、さまざまな YouTube アナリティクスレポートを取得できます。各リクエストでは、クエリパラメータを使用してチャンネル ID またはコンテンツ所有者、開始日と終了日、少なくとも 1 つの指標を指定します。ディメンション、フィルタ、並べ替え手順など、追加のクエリパラメータを指定することもできます。

メソッド	HTTP リクエスト	説明
`https://youtubeanalytics.googleapis.com/v2` に対する URI
`query`	`GET /reports`	YouTube アナリティクスレポートを取得します。各 API リクエストでは、クエリパラメータを使用してチャンネル ID またはコンテンツ所有者、開始日と終了日、少なくとも 1 つの指標を指定します。ディメンション、フィルタ、並べ替え手順など、追加のクエリパラメータを指定することもできます。指標: 動画再生回数、評価（高評価と低評価）などのユーザーアクションを個別に測定します。ディメンション: ユーザーアクティビティが発生した日付やユーザーが所在する国など、データの集計に使用される一般的な基準です。レポートでは、データの各行にはディメンション値の組み合わせが一意になっています。フィルタは、取得するデータを指定するディメンション値です。たとえば、特定の国、特定の動画、または動画のグループに関するデータを取得できます。サポートされているチャンネルレポートとコンテンツ所有者レポートのリストで、指標、ディメンション、フィルタの有効な組み合わせを定義しています。

グループ管理

この API には、YouTube アナリティクスグループを作成、管理するための 2 つのリソースが用意されています。

グループ
グループアイテム

グループ

group リソースは、YouTube アナリティクスグループを表します。これは、最大 500 個のチャンネル、動画、再生リスト、アセットのカスタムコレクションです。

グループ内のすべてのアイテムは同じ種類のリソースを表します。たとえば、100 件の動画と 100 件の再生リストを含むグループを作成することはできません。

1 つのアナリティクスグループには、ユーザーがアップロードまたは申し立てを行ったリソース、または自分が管理するチャンネルにリンクされているリソースのみを含めることができます。そのため、チャンネル所有者は動画や再生リストのグループを作成できます。コンテンツ所有者は、動画、再生リスト、チャンネル、アセットのグループを作成できます。

このリソースの詳細については、リソース表現およびプロパティ一覧をご覧ください。

メソッド	HTTP リクエスト	説明
`https://youtubeanalytics.googleapis.com/v2` に対する URI
`list`	`GET /groups`	API リクエストパラメータに一致するグループのリストを返します。たとえば、認証済みユーザーが所有しているすべてのグループを取得したり、一意の ID で 1 つ以上のグループを取得したりできます。
`insert`	`POST /groups`	YouTube アナリティクスグループを作成します。グループを作成したら、`groupItems.insert` メソッドを使用してグループにアイテムを追加します。
`update`	`PUT /groups`	グループのメタデータを変更します。現在、更新できるプロパティはグループのタイトルのみです。（`groupItems.insert` と `groupItems.delete` を使用してグループアイテムを追加または削除します）。
`delete`	`DELETE /groups`	グループを削除します。

グループアイテム

groupItem リソースは、YouTube アナリティクスグループ内のアイテムを表します。