このページでは、チャンネル所有者が YouTube アナリティクス API で取得できるレポートの一覧を示します。チャンネル レポートでは、指定したチャンネルのユーザー アクティビティの指標を確認できます。動画の視聴回数、評価、チャンネル登録者数などを測定できます。
レポートの取得
チャンネル レポートを取得するには、API リクエストの ids
パラメータ値を次のいずれかの値に設定する必要があります。
channel==MINE
- API は、認証されたユーザーの YouTube チャンネルのデータを返します。
channel==CHANNEL_ID
- CHANNEL_ID
は、データを取得するチャンネルの一意のチャンネル ID に設定します。リクエストを承認するユーザーは、チャンネルのオーナーである必要があります。
チャンネル ID は現在、UC
で始まる文字列ですが、形式は変更される可能性があります。(チャンネル ID は、YouTube チャンネルの [アカウントの詳細設定 ] ページで確認できます。また、YouTube Data API's channels.list
メソッドを使用してプログラムでチャンネル ID を取得することもできます)。
承認
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 Analytics API では、チャンネル所有者はこのスコープを使用して YouTube アナリティクスのグループとグループアイテムを管理します。
https://www.googleapis.com/auth/youtubepartner
YouTube のアセットや関連するコンテンツを YouTube で表示、管理できます。YouTube Analytics API では、コンテンツ所有者はこのスコープを使用して YouTube アナリティクスのグループとグループアイテムを管理します。
注: 現在、チャネル レポートでは推定収益と広告のパフォーマンス指標はサポートされていません。そのため、現在のところ、https://www.googleapis.com/auth/yt-analytics-monetary.readonly
スコープでは、これらのレポートの金額データにアクセスできません。
フィルタ
サポートされているレポートを説明する表に、各レポートで使用できるフィルタが示されています。この表の中でかっこで囲まれているフィルタはオプションです。たとえば、フィルタ オプション video(,country)
では、動画 フィルタは必須ですが、国 フィルタは任意です。
この API は、video
フィルタと playlist
フィルタに複数の値を指定することもサポートしています。これらのフィルタのいずれかに複数の値を指定する場合は、そのフィルタをリクエストに指定するディメンションのリストに追加することもできます。これは、特定のレポートでサポートされているディメンションとしてフィルタがリストにない場合でも同様です。
特定の値または値のセットで API の結果をフィルタする方法の詳細については、filters
パラメータの定義をご覧ください。
レポートの表について
このセクションでは、API がサポートするレポートを定義するテーブルで使用される形式と用語について説明します。次の表に、時間ディメンションとaverageViewPercentage 指標を使用する再生の詳細動画レポートでサポートされているディメンション、指標、フィルタを示します。
このテーブルには、ディメンション用の行が 2 つ、指標用の行が 1 つ、フィルタ用の行が 3 つあります。ディメンションとフィルタの場合、組み合わせが表の使用ルールに従っている限り、各行の値を API リクエストで組み合わせることができます。たとえば、このレポートの有効な dimensions
パラメータ値は次のとおりです。
dimensions=day
dimensions=day,subscribedStatus
dimensions=month,subscribedStatus,youtubeProduct
dimensions=month,youtubeProduct
ただし、パラメータ値 day,month
は、2 つの時間ベースのディメンションを使用するため無効です。リクエストでは 0 または 1 のいずれかを使用する必要があります。
レポートの表の用語
表では、ディメンションが必須か省略可能かを次の用語で示します。
次の用語は、値が必須であることを意味します。
必須: 値を含める必要があります。
1 つだけ使用: グループから 1 つの値を含める必要があります。
1 つ以上を使用: グループ内の任意の値またはすべての値を含めることができますが、少なくとも 1 つは含める必要があります。
次の用語は、値が省略可能であることを意味します。
省略可: 値を含めることができます。
0 または 1 を使用する: グループから 1 つの値を含めることができます。
0 個以上を使用する: グループ内の任意の値またはすべての値を含めることができます。
動画レポート
基本統計情報
基本的なユーザー アクティビティの統計情報
このレポートは、チャンネル上でのユーザー操作に関する統計情報を提供します。特定の動画または特定の国に関するデータのみが含まれるように、レポートをフィルタリングすることができます。
米国各州の基本的なユーザー アクティビティ統計情報
このレポートは、特定の米国の州またはコロンビア特別区の統計情報を提供します。このレポートは、上で説明した特定の国のレポートで使用可能な指標のサブセットのみをサポートします。
時間ベース
特定期間の国別ユーザー アクティビティ
このレポートは、特定の期間にわたるチャンネル上でのユーザー操作に関する統計情報を提供します。特定の動画または特定の国に関するデータのみが含まれるように、レポートをフィルタリングすることができます。
特定期間の米国各州におけるユーザー アクティビティ
このレポートは、特定の米国の州またはコロンビア特別区のユーザー アクティビティに関する統計情報を提供します。このレポートは、上で説明した特定の国のレポートで使用可能な指標のサブセットのみをサポートします。
ユーザーの地域
国別のユーザー アクティビティ
このレポートでは、チャンネルに対するユーザー アクティビティに関して、国ごとの統計を提供します。特定の動画のデータのみが含まれるように、レポートをフィルタリングすることができます。
州別のユーザー アクティビティ
このレポートには、米国の各州とコロンビア特別区のユーザー アクティビティの統計情報が表示されます。このレポートでは、filters
パラメータ値を country==US
に設定する必要があります。
都市別のユーザー アクティビティ (250 件以下)
注: このレポートでは、maxResults
パラメータを 250
以下の整数値に設定する必要があります。他のほとんどのレポートとは異なり、このレポートでは sort
リクエスト パラメータの値も指定する必要があります。
このレポートには、都市別のユーザー アクティビティの統計情報が表示されます。
DMA 別のユーザー アクティビティ
このレポートでは、指定市場エリア(DMA)別のユーザー アクティビティの統計情報を確認できます。このレポートでは、filters
パラメータの値を country==US
に設定するか、特定の都道府県(米国の州)にフィルタする必要があります。
再生の詳細
再生の詳細レポートには、次の視聴属性に関連する統計情報が表示されます。
視聴した動画はライブ配信でしたか?それともオンデマンド動画でしたか?
視聴者は、動画を所有するチャンネルに登録していましたか?
視聴が発生した YouTube サービス
注: liveOrOnDemand ディメンションとフィルタは、averageViewPercentage 指標と組み合わせて使用できません。そのため、以下のサブセクションでは、それぞれ 2 つのレポートを紹介します。1 つのレポートは liveOrOnDemand ディメンション(およびフィルタ)をサポートし、もう 1 つのレポートは averageViewPercentage 指標をサポートしています。
定期購入ステータス別のユーザー アクティビティ
このレポートには、チャンネル登録者とチャンネル登録していない視聴者のユーザー アクティビティの指標が表示されます。統計情報は期間(日 または月 )でグループ化できます。また、レポートは国 、大陸 、subContinent でフィルタすることもできます。
州別の定期購入ステータス別のユーザー アクティビティ
このレポートには、米国の州またはコロンビア特別区に居住するチャンネル登録者とチャンネル登録していない視聴者のユーザー アクティビティの指標が表示されます。このレポートでは、以前のレポートよりも少ない指標がサポートされています。
再生の詳細(時間ディメンションを含む)
これらのレポートでは、時間ディメンション(日 または月 )は省略可能です。いずれにしても、startDate
リクエスト パラメータと endDate
リクエスト パラメータを使用して、レポートの対象期間を指定する必要があります。ディメンション(存在する場合)は、レポート内のデータを日、月などで集計することを示します。
このレポートには、特定の期間の再生に関する詳細な統計情報が表示されます。liveOrOnDemand ディメンション(およびフィルタ)をサポートしています。
このレポートには、特定の期間の再生に関する詳細な統計情報が表示されます。averageViewPercentage 指標をサポートしています。
国別の再生の詳細
このレポートには、国別の再生に関する詳細な統計情報が表示されます。liveOrOnDemand ディメンション(およびフィルタ)をサポートしています。
次のレポートは前述のレポートと類似しています。averageViewPercentage 指標のサポートが追加されますが、liveOrOnDemand はディメンションまたはフィルタとしてサポートされません。
都道府県別の再生の詳細
このレポートには、米国の各州とコロンビア特別区の再生に関する詳細な統計情報が表示されます。liveOrOnDemand ディメンション(およびフィルタ)をサポートしています。
次のレポートは前述のレポートと類似しています。averageViewPercentage 指標のサポートが追加されますが、liveOrOnDemand はディメンションまたはフィルタとしてサポートされません。
再生場所
ビデオ再生場所レポート
このレポートは、動画再生が発生したページまたはアプリケーションのタイプに関する統計情報を提供します。.
再生場所の詳細(25 件以下)
注: このレポートでは、maxResults
パラメータを 25
以下の整数値に設定する必要があります。他のほとんどのレポートとは異なり、このレポートでは sort
リクエスト パラメータの値も指定する必要があります。
このレポートでは、チャンネルの動画で最も多くの視聴回数または総再生時間を獲得した埋め込み動画プレーヤーを確認できます。
トラフィック ソース
トラフィック ソース
このレポートでは、視聴者が動画コンテンツにアクセスした方法に基づいて視聴統計情報が集約されます。たとえば、Google 検索や関連動画へのリンクから発生した視聴回数を特定できます。
注: このレポートでは、クエリ対象の動画数 × 期間内の日数 の積が 50,000 を超えるとエラーが返されます。たとえば、500 個の動画 ID のデータを取り出すクエリでは、最大 100 日間のデータのリクエストが可能です。リクエストから返される行数を減らすには、クエリを複数のクエリに分割し、動画の数を減らすか期間を短くします。
トラフィック ソースの詳細 (25 件以下)
注: このレポートでは、maxResults
パラメータを 25
以下の整数値に設定する必要があります。他のほとんどのレポートとは異なり、このレポートでは sort
リクエスト パラメータの値も指定する必要があります。
このレポートは、チャンネルのコンテンツに関して最も多くの再生回数を生み出した参照 URL に基づいて、再生の統計情報を集計します。参照 URL は、トラフィック ソースの種類によって分類されます。レポートを取得するトラフィック ソースは、insightTrafficSourceDetail ディメンションの定義によって特定されます。たとえば、insightTrafficSourceType フィルタを ADVERTISING
に設定すると、チャンネルのコンテンツで視聴回数または総再生時間が最も多かった広告のタイプがレポートに表示されます。
注: このレポートは、特定のトラフィック ソースでのみサポートされます。サポートされていないトラフィック ソースには、VIDEO_REMIXES
、NOTIFICATION
、END_SCREEN
、CAMPAIGN_CARD
、VIDEO_REMIXES
、NO_LINK_EMBEDDED
などがあります。
デバイスの種類とオペレーティング システム
デバイスの種類
このレポートは、視聴者がどのようにして動画コンテンツにアクセスしたかに基づいて、再生の統計情報を集計します。たとえば、モバイル デバイスやゲーム機で発生した視聴回数を特定できます。
オペレーティング システム
このレポートは、視聴者のオペレーティング システムに基づいて、表示回数の統計情報を集計します。たとえば、Android 端末あるいは PlayStation での表示回数を特定します。
オペレーティング·システムと端末のタイプ
このレポートは、視聴者のオペレーティング システムと端末のタイプに基づいて、表示回数の統計情報を集計します。たとえば、Android タブレットあるいは Windows デスクトップ デバイスでの表示回数を特定します。
視聴者のユーザー属性
このレポートは、視聴者の年齢層や性別に基づいて表示回数の統計情報を集計します。
エンゲージメントとコンテンツの共有
このレポートは、各種ソーシャル プラットフォームにおけるチャンネルの動画の共有頻度を示す統計情報を提供します。
視聴者維持率
このレポートでは、動画の視聴者維持率を測定します。また、動画の特定の部分が視聴された頻度も示されます。elapsedVideoTimeRatio
ディメンションは、対応する指標値で経過した動画の長さを測定します。指標は次の 2 つのカテゴリに分類できます。
注: このレポートでは、video
フィルタに値のカンマ区切りリストを指定することはできません。値には 1 つの動画 ID を指定する必要があります。
同時視聴者数(ライブ配信の場合)
このレポートには、1 本のライブ配信動画の特定の位置における同時視聴者数が表示されます。フィルタは動画を指定します。通常、位置情報ディメンションは 1 分を表します。
人気の動画
注: これらのレポートでは、maxResults
パラメータを 200
以下の整数値に設定する必要があります。2013 年 1 月 1 日より前のデータは、上位 10 本の動画についてのみ利用できます。他のほとんどのレポートとは異なり、これらのレポートでは sort
リクエスト パラメータの値も指定する必要があります。
人気の動画(地域別フィルタ可)(200 件以下)
このレポートには、チャンネルの上位の動画が表示されます。レポートは、国 、大陸 、subContinent 別に人気の動画を表示するようにフィルタできます。
州別の人気動画(200 件未満)
このレポートでは、特定の米国の州またはコロンビア特別区で最も人気のあるチャンネル動画が一覧表示されます。このレポートは、上で説明した特定の国のレポートで使用可能な指標のサブセットのみをサポートします。
チャンネル登録している視聴者またはチャンネル登録していない視聴者の人気の動画(200 件以下)
このレポートには、チャンネル登録している視聴者とチャンネル登録していない視聴者向けのチャンネルの上位動画が一覧表示されます。このレポートは、国 、大陸 、subContinent 別に人気の動画を表示するようにフィルタできます。前述のレポートでは、チャンネル登録している視聴者とチャンネル登録していない視聴者を対象に、特定の米国の州で視聴回数の多い動画を取得できますが、このレポートよりもサポートされている指標が少なくなります。
YouTube サービス別の人気動画(200 件以下)
このレポートには、チャンネルの上位動画が表示されます。再生の詳細と地域のフィルタがサポートされています。このレポートは前述のレポートと類似していますが、サポートされている指標が少なく、youtubeProduct フィルタがサポートされています。
再生の詳細フィルタを使用した人気の動画(200 件以下)
このレポートには、再生の詳細ディメンション(liveOrOnDemand 、subscribedStatus 、youtubeProduct )の一部またはすべてでフィルタされた、チャンネルの人気動画が一覧表示されます。前述のレポートとは異なり、このレポートは liveOrOnDemand フィルタをサポートしていますが、averageViewPercentage 指標はサポートしていません。
再生リストレポート
再生リスト レポートには、チャンネル所有者の再生リスト内の動画に関連するユーザー アクティビティに関する指標が含まれています。これらのレポートには 2 つのバージョンがあります。利用可能なレポートごとに、次のセクションで各バージョンの説明を説明します。
各セクションの [推奨 ] タブには、対応するレポートを取得するために推奨される API リクエスト形式が記載されています。推奨レポートでは、動画の集計指標 と再生リスト内の指標 の両方を含む、拡張された指標セットがサポートされています。このリクエスト形式では、isCurated
ディメンションは使用されません。
各セクションの [isCurated
の使用 ] タブでは、isCurated
ディメンションが必要な古い API リクエスト形式について説明します。これらのレポートは、再生リスト内の指標 のみをサポートしています。isCurated
ディメンションは、すべてのレポートで非推奨になりました。以下の警告メモに、非推奨スケジュールが記載されています。
次の警告メモでは、2 つのレポート バージョンの変更点について詳しく説明します。
重要: チャンネルの再生リスト レポートは 2024 年 6 月 30 日までに、コンテンツ所有者の再生リスト レポートは 2024 年 12 月 31 日までに更新してください。次の変更点にご注意ください。
isCurated
ディメンションは非推奨になりました。
チャンネル レポート の場合、このディメンションは 2024 年 6 月 30 日以降ご利用いただけなくなります。
コンテンツ所有者レポートの場合 、このディメンションは 2024 年 12 月 31 日以降サポートされなくなります。
再生リスト レポートを取得するリクエストから isCurated
ディメンションを削除すると、views
指標の動作が変更されます。
リクエストに isCurated
ディメンションが含まれている場合、views
指標は再生リストのコンテキストで動画が視聴された回数を示します。
リクエストに isCurated
ディメンションが含まれていない場合、views
指標は動画の合計視聴回数を指定し、playlistViews
指標は再生リストのコンテキストで動画が視聴された回数を示します。
そのため、isCurated
ディメンションを削除する際に下位互換性を維持するには、プレイリスト レポートでのみ、views
指標ではなく playlistViews
指標を取得するようにコードを更新する必要があります。views
指標は、意味が異なるものの、プレイリスト レポートで引き続きサポートされているため、指標名を更新しない場合でも、API は引き続きデータを返します。もちろん、views
と playlistViews
の両方を取得して表示するようにアプリを変更することもできます。
詳しくは、変更履歴 をご覧ください。
集計された動画指標
これらの指標は、再生リストを所有するチャンネルが所有する再生リスト内のすべての動画について集約されたユーザー アクティビティとインプレッションの指標を提供します。他のチャンネルが所有する動画の指標は、集計では計算されません。そのため、チャンネルが他のチャンネルが所有する動画のみを含む再生リストを作成した場合、それらの再生リストのレポートにはこれらの指標の値は表示されません。
YouTube でサポートされている動画の集計指標の一覧については、サポートされているプレイリスト指標 をご覧ください。
再生リスト内の指標
これらの指標は、再生リスト ページのコンテキストにおけるユーザー アクティビティとエンゲージメントを反映しています。これらの指標には、所有チャンネルに関係なく、再生リスト内のすべての動画の視聴回数が含まれますが、カウントされるのは再生リスト内で発生した視聴回数のみです。
サポートされている再生リストの指標
重要: 次の表に示すように、views
指標は、各再生リスト レポートの 2 つのバージョンで異なる種類のデータを提供します。
推奨 されるレポート形式では、views
は集計された動画指標です。
isCurated
ディメンションを使用して取得されたレポート では、views
は再生リスト内の指標です。
基本統計情報
このレポートには、チャンネルの再生リスト内の動画に対するユーザーの操作に関する統計情報が表示されます。レポートをフィルタして、特定の再生リストのデータのみを返すようにできます。
isCurated
ディメンションは非推奨となり、2024 年 6 月 30 日以降、チャネル レポートでサポートされなくなります。再生リスト レポートの移行ガイド では、このサポート終了に関連して行うことができる、または行う必要があるその他の変更について説明しています。
時間ベース
このレポートには、チャンネルの再生リスト内の動画に対するユーザーの操作に関する統計情報が表示されます。レポートをフィルタして、特定の再生リストのデータのみを返すようにできます。
ユーザーの地域
国別の再生リストのアクティビティ
このレポートには、特定の国におけるユーザーがチャンネルの再生リスト内の動画に対して行った操作に関する統計情報が表示されます。
都道府県別の再生リストのアクティビティ
このレポートには、米国の各州とコロンビア特別区の再生リストのアクティビティの統計情報が表示されます。このレポートでは、結果をフィルタして米国のデータのみを返す必要があります。
再生場所
このレポートには、プレイリスト動画の再生が発生したページまたはアプリの種類に関する統計情報が表示されます。
再生場所の詳細(25 件以下)
注: このレポートでは、maxResults
パラメータを 25
以下の整数値に設定する必要があります。他のほとんどのレポートとは異なり、このレポートでは sort
リクエスト パラメータの値も指定する必要があります。
このレポートでは、チャンネルの再生リスト内の動画で最も多くの視聴回数または総再生時間を獲得した埋め込み動画プレーヤーを特定できます。
トラフィック ソース
このレポートでは、視聴者が再生リストのコンテンツにアクセスした方法に基づいて視聴統計情報が集約されます。たとえば、Google 検索から発生した視聴回数を特定できます。
トラフィック ソースの詳細 (25 件以下)
注: このレポートでは、maxResults
パラメータを 25
以下の整数値に設定する必要があります。他のほとんどのレポートとは異なり、このレポートでは sort
リクエスト パラメータの値も指定する必要があります。
このレポートには、チャンネルの再生リスト内の動画で最も多くの視聴回数を発生させた参照元に基づいて、視聴統計情報が集約されます。参照元はトラフィック ソースの種類別に分類され、insightTrafficSourceDetail ディメンションの定義で、レポートを利用できるトラフィック ソースが特定されます。 たとえば、insightTrafficSourceType フィルタを ADVERTISING
に設定すると、チャンネルの再生リストで最も多くの視聴回数または総再生時間を獲得した広告の種類がレポートに表示されます。
注: このレポートは、特定のトラフィック ソースでのみサポートされます。サポートされていないトラフィック ソースには、VIDEO_REMIXES
、NOTIFICATION
、END_SCREEN
、CAMPAIGN_CARD
、VIDEO_REMIXES
、NO_LINK_EMBEDDED
などがあります。
デバイスの種類とオペレーティング システム
デバイスの種類
このレポートは、視聴者が再生リスト内の動画にアクセスした方法に基づいて視聴統計情報を集計します。たとえば、モバイル デバイスやゲーム機で発生した視聴回数を特定できます。
オペレーティング システム
このレポートは、視聴者のオペレーティング システムに基づいて、表示回数の統計情報を集計します。たとえば、Android デバイスや PlayStation で発生した視聴回数を特定できます。
オペレーティング·システムと端末のタイプ
このレポートは、視聴者のオペレーティング システムとデバイスの種類に基づいて視聴統計情報を集計します。たとえば、Android タブレットや Windows デスクトップ デバイスで発生した視聴回数を特定できます。
視聴者のユーザー属性
上位の再生リスト
注: これらのレポートでは、maxResults
パラメータを 200
以下の整数値に設定する必要があります。2013 年 1 月 1 日より前のデータは、上位 10 件の再生リストについてのみ利用できます。他のほとんどのレポートとは異なり、これらのレポートでは sort
リクエスト パラメータの値も指定する必要があります。
このレポートには、指定したフィルタ条件と並べ替え条件に基づいて、チャンネルの上位再生リストが表示されます。
メンバーシップ レポート
メンバーシップの解約
このレポートには、ユーザーがチャンネル メンバーシップを解約した理由を示す統計情報が表示されます。
注: 広告のパフォーマンス レポートには、https://www.googleapis.com/auth/yt-analytics-monetary.readonly
スコープへのアクセス権を付与する認証トークンが必要です。
広告の掲載結果レポートには、動画の再生中に配信された広告の表示回数ベースの指標が表示されます。これらの指標は広告のインプレッションごとにカウントされます。動画の再生ごとに複数のインプレッションが発生する場合があります。
インプレッション ベースの広告パフォーマンス指標は次のとおりです。
また、一部の動画レポート では、以下の再生ベースの広告パフォーマンス指標がサポートされています。ただし、これらの指標は広告のパフォーマンス レポートには含まれません。