注: Content owner reports are only accessible to YouTube content partners who participate in the YouTube Partner Program .
このページでは、コンテンツ所有者が YouTube Analytics API で取得できるレポートの一覧を示します。コンテンツ所有者レポートには、指定した YouTube コンテンツ所有者にリンクされているチャンネルの指標が含まれます。指標とは、ユーザーの行動、広告のパフォーマンス、推定収益の個別の測定値のことです。
動画レポート には、コンテンツ所有者のチャンネルの動画に関するユーザー アクティビティ、広告のパフォーマンス、推定収益の指標が含まれます。
再生リストレポート には、再生リスト内で発生した動画再生回数に関連する統計情報が表示されます。再生リストレポートでは、動画レポートと同じディメンションとフィルタを多数使用します。
広告のパフォーマンス レポート には、収益と広告のパフォーマンスに関連する指標が含まれます。動画再生中に表示された広告の種類に基づいて指標をグループ化するには、adTypeadType ディメンションを使用します。広告のパフォーマンス レポート のセクションでは、API がサポートする 2 種類の広告のパフォーマンス指標について説明します。
レポートの取得
コンテンツ所有者レポートを取得するには、API の reports.query
メソッドを呼び出し、API リクエストの ids
パラメータ値を contentOwner==OWNER_NAME
に設定します。OWNER_NAME
にはコンテンツ所有者の 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
スコープへのアクセス権を付与する認証トークンが必要です。
フィルタ
コンテンツ所有者レポートを取得するすべての API リクエストでは、video
ディメンション、channel
ディメンション、isCurated
ディメンション、または claimedStatus
ディメンションと uploaderType
ディメンションのサポートされている組み合わせを使用して、データをフィルタする必要があります。(サポートされている組み合わせについては、uploaderType
ディメンションの定義をご覧ください)。
サポートされるレポートを説明する表で、任意のレポートに使用できるフィルタを示します。説明の中で、かっこで囲まれているフィルタは省略可能です。たとえば、レポートにフィルタ オプションとして video(,country)
が表示されている場合は、特定の動画のデータのみを含めるか、特定の国の特定の動画のデータのみが含まれるようにレポートをフィルタできます。
API では、video
、playlist
、channel
フィルタに複数の値を指定する機能もサポートしています。これらのフィルタのいずれかに複数の値を指定する場合は、リクエストで指定したディメンションのリストにそのフィルタを追加することもできます。これは、特定のレポートでサポートされているディメンションとしてフィルタが表示されていない場合でも同じです。
API の結果を特定の値または値セットでフィルタリングする方法については、filters
パラメータ定義をご覧ください。
レポートの表について
このセクションでは、API がサポートするレポートを定義するテーブルで使用される形式と用語について説明します。次の表は、時間ディメンションと averageViewPercentage 指標を使用する再生の詳細動画レポートでサポートされているディメンション、指標、フィルタを示しています。
この表には、ディメンションが 2 行、指標が 1 行、フィルタが 3 行含まれています。ディメンションとフィルタの場合、表の使用ルールに即している場合に限り、各行の値を API リクエストにまとめることができます。たとえば、このレポートで有効な dimensions
パラメータ値は次のようになります。
dimensions=day
dimensions=day,liveOrOnDemand
dimensions=month,subscribedStatus,youtubeProduct
dimensions=month,youtubeProduct
パラメータ値 day,month
は 2 つの時間ベースのディメンションを使用しているため無効ですが、リクエストでは 0 または 1 のいずれかを使用できます。この場合、パラメータ値 subscribedStatus,youtubeProduct
は実際にはレポートを返しますが、指標は日、週、月などで集計されません(このレポートについては、別途ドキュメントに記載されています)。
レポートの表の用語
表では、ディメンションが必須か任意かを示すために次の用語が使用されます。
次の用語は、値が必要であることを示します。
必須: 値を含める必要があります。
1 つだけ使用: グループから 1 つの値を含める必要があります。
1 つ以上使用: グループの値の一部またはすべてを含めることができますが、少なくとも 1 つを含める必要があります。
以下の用語は、値は省略可能です。
省略可: 値を指定することもできます。
0 または 1 を使用する: グループから 1 つの値を含めることができます。
0 個以上の値を使用する: グループに含まれる値の一部またはすべてを含めることができます。
重要: コンテンツ所有者の動画レポートを取得するすべての API リクエストでは、
video ディメンション、
channel ディメンション、
group ディメンション、または
claimedStatus ディメンションと
uploaderType ディメンションのサポートされている組み合わせのいずれかを使用してデータをフィルタする必要があります。(レポートによっては、これらすべてのオプションに対応していないものもあります)。サポートされている組み合わせは次のとおりです(
uploaderType ディメンションの定義にも表示されます)。
uploaderType==self
claimedStatus==claimed
claimedStatus==claimed;uploaderType==self
claimedStatus==claimed;uploaderType==thirdParty
動画レポート
基本統計情報
基本的な統計情報(チャンネル登録者数など)
このレポートには、コンテンツ所有者のすべてのチャンネルでのユーザー アクションに関する統計情報が表示されます。特定の動画や国に関するデータのみを返すように、レポートにフィルタを適用できます。また、申し立てを受けたコンテンツの統計情報のみを取得するためにも使用できます。これには、コンテンツ所有者、第三者、またはその両方がアップロードした申し立てを受けたコンテンツが含まれます。
米国の各州の基本的な統計情報
このレポートは、特定の米国の州またはコロンビア特別区の統計情報を提供します。このレポートは、上で説明した特定の国のレポートで使用可能な指標のサブセットのみをサポートします。
時間ベース
特定の期間のアクティビティ
このレポートでは、特定の期間における、コンテンツ所有者のすべてのチャンネルにおけるユーザー アクションに関連する統計情報を確認できます。特定の動画または特定の国に関するデータのみが含まれるように、レポートをフィルタリングすることができます。
特定期間の米国各州におけるユーザー アクティビティ
このレポートは、特定の米国の州またはコロンビア特別区の統計情報を提供します。このレポートは、上で説明した特定の国のレポートで使用可能な指標のサブセットのみをサポートします。
ユーザーの地域
国別のユーザー アクティビティ
このレポートには、コンテンツ所有者のすべてのチャンネルのユーザー アクティビティに関する統計情報が国別に表示されます。特定の動画またはチャンネルのデータのみを返すように、レポートにフィルタを適用できます。
州別のユーザー アクティビティ
このレポートは、特定の米国の州またはコロンビア特別区のユーザー アクティビティに関する統計情報を提供します。このレポートでは、filters
パラメータ値を country==US
に設定する必要があります。
都市別のユーザー アクション(結果 250 件以下)
注: このレポートを使用するには、maxResults
パラメータを 250
以下の整数値に設定する必要があります。他のほとんどのレポートとは異なり、このレポートでは sort
リクエスト パラメータの値も指定する必要があります。
このレポートでは、都市ごとのユーザー アクションの統計情報を確認できます。
再生の詳細
再生詳細レポートでは、次の視聴属性に関する統計情報を確認できます。
視聴されたのはライブ動画配信ですか、それともオンデマンド動画ですか?
視聴者は、動画を所有しているチャンネルに登録しましたか?
視聴された YouTube サービス
技術的には、これらのレポートがサポートする再生詳細ディメンションはすべて省略可能です。再生の詳細ディメンションをリクエストに含めない場合、返されるレポートは基本統計情報 、時間ベース 、ユーザーの地域 レポートのいずれかと類似しています。
注: liveOrOnDemand ディメンションとフィルタは、averageViewPercentage 指標と組み合わせて使用することはできません。そのため、以降の各サブセクションでは、2 つのレポートを示します。1 つのレポートは liveOrOnDemand ディメンション(およびフィルタ)をサポートし、もう 1 つは averageViewPercentage 指標をサポートしています。
登録済みステータス別のユーザー アクティビティ
このレポートでは、チャンネル登録者とチャンネル登録していない視聴者のユーザー アクティビティの指標を確認できます。統計情報は期間(日 または月 )でグループ化でき、国 、大陸 、subContinent でフィルタすることもできます。
州ごとの登録済みステータス別のユーザー アクティビティ
このレポートでは、米国の州またはコロンビア特別区におけるチャンネル登録者と未登録者のユーザー アクティビティ指標を確認できます。このレポートでサポートされる指標の数は、前のレポートよりも少なくなります。
再生の詳細(オプションの時間ディメンションあり)
これらのレポートでは、時間ディメンション(日 または月 )は省略可能です。レポートの対象期間を指定するには、リクエスト パラメータ startDate
と endDate
を使用する必要があるためです。このディメンションが存在する場合は、レポートのデータを日や月などで集計したいことを示します。
再生の詳細(オプションの時間ディメンションと liveOrOnDemand 統計情報を含む)
このレポートには、特定の時間間隔の再生の詳細に関する統計情報が表示されます。liveOrOnDemand ディメンション(およびフィルタ)をサポートしています。
このレポートには、特定の時間間隔の再生の詳細に関する統計情報が表示されます。
国別の再生詳細
このレポートでは、国ごとの再生の詳細の統計情報を提供します。liveOrOnDemand ディメンション(およびフィルタ)をサポートしています。
次のレポートは、前のレポートに似ています。averageViewPercentage 指標のサポートを追加しますが、liveOrOnDemand はディメンションまたはフィルタとしてサポートしません。
地域別の再生詳細
このレポートでは、米国の州とコロンビア特別区における再生の詳細に関する統計情報を提供します。liveOrOnDemand ディメンション(およびフィルタ)をサポートしています。
次のレポートは、前のレポートに似ています。averageViewPercentage 指標のサポートを追加しますが、liveOrOnDemand はディメンションまたはフィルタとしてサポートしません。
再生場所
ビデオ再生場所レポート
このレポートは、動画再生が発生したページまたはアプリケーションのタイプに関する統計情報を提供します。.
再生場所の詳細(25 件以下)
注: このレポートを使用するには、maxResults
パラメータを 25
以下の整数値に設定する必要があります。他のほとんどのレポートとは異なり、このレポートでは sort
リクエスト パラメータの値も指定する必要があります。
このレポートでは、コンテンツ所有者のコンテンツについて、視聴回数または再生時間が最も多かった埋め込み動画プレーヤーが特定されます。このレポートを取得するときは、insightPlaybackLocationType
フィルタを EMBEDDED
に設定する必要があります。
トラフィック ソース
トラフィック ソース
このレポートは、視聴者がどのようにして動画コンテンツにアクセスしたかに基づいて、再生の統計情報を集計します。たとえば、Google 検索、または関連動画へのリンクから生み出された再生回数を特定できます。
トラフィック ソースの詳細(25 件以下)
注: このレポートを使用するには、maxResults
パラメータを 25
以下の整数値に設定する必要があります。他のほとんどのレポートとは異なり、このレポートでは sort
リクエスト パラメータの値も指定する必要があります。
このレポートでは、コンテンツ所有者のコンテンツの視聴回数が最も多かった参照 URL に基づいて視聴の統計情報が集計されます。参照 URL は、トラフィック ソースの種類によって分類されます。レポートを取得するトラフィック ソースは、insightTrafficSourceDetail ディメンションの定義によって特定されます。たとえば、insightTrafficSourceType フィルタを ADVERTISING
に設定すると、レポートには、コンテンツ所有者のコンテンツの視聴回数または再生時間が最も多い広告の種類が一覧表示されます。
注: このレポートは、特定のトラフィック ソースでのみサポートされます。たとえば、NO_LINK_EMBEDDED
トラフィック ソースには追加の詳細情報がないため、このレポートはサポートされていません。このレポートをサポートするトラフィック ソースの詳細については、insightTrafficSourceType の定義をご覧ください。
デバイスの種類とオペレーティング システム
デバイスのタイプ
このレポートには、視聴者がコンテンツの視聴時に使用したデバイスの種類に基づいて、視聴の統計情報が集計されます。たとえば、タブレットやゲーム機で発生した視聴回数を特定できます。
オペレーティング システム
このレポートは、視聴者のオペレーティング システムに基づいて、表示回数の統計情報を集計します。たとえば、Android 端末あるいは PlayStation での表示回数を特定します。
オペレーティング·システムと端末のタイプ
このレポートは、視聴者のオペレーティング システムと端末のタイプに基づいて、表示回数の統計情報を集計します。たとえば、Android タブレットあるいは Windows デスクトップ デバイスでの表示回数を特定します。
視聴者のユーザー属性
このレポートは、視聴者の年齢層や性別に基づいて表示回数の統計情報を集計します。
エンゲージメントとコンテンツの共有
このレポートは、各種ソーシャル プラットフォームにおけるチャンネルの動画の共有頻度を示す統計情報を提供します。
視聴者維持率
このレポートでは、動画の視聴者維持率を測定できます。elapsedVideoTimeRatio
ディメンションは、対応する指標値ごとに動画の経過時間を測定します。audienceWatchRatio
指標と relativeRetentionPerformance
指標から、動画が視聴者をどの程度維持できているかを示す 2 つの指標が得られます。1 つ目は絶対値で、2 つ目は、長さが同程度の他の YouTube 動画と比較したパフォーマンスです。
注: 視聴者維持率レポートでは、video
フィルタに値のカンマ区切りのリストを指定することはできません。値には単一の動画 ID を指定する必要があります。
人気の動画
注: これらのレポートでは、maxResults
パラメータを 200
以下の整数値に設定する必要があります。2013 年 1 月 1 日までは、上位 10 本の動画のデータのみ利用できます。他のほとんどのレポートとは異なり、これらのレポートでは sort
リクエスト パラメータの値も指定する必要があります。
国別、大陸別、亜大陸別の上位の動画(200 件以下)
このレポートには、指定したフィルタ条件と並べ替え条件に基づいて、コンテンツ所有者の上位の動画が一覧表示されます。
米国の州別上位の動画(200 件以下)
このレポートには、米国の特定の州またはコロンビア特別区でコンテンツ所有者の上位の動画が表示されます。このレポートは、上で説明した特定の国のレポートで使用可能な指標のサブセットのみをサポートします。
チャンネル登録者または未登録の視聴者向けの上位の動画(200 件以下)
このレポートには、チャンネル登録者または未登録の視聴者に人気の動画がリストされます。このレポートをフィルタして、国 、大陸 、またはsubContinent 別に上位の動画を表示できます。以前のレポートでは、チャンネル登録者または未登録の視聴者について、米国の特定の州で上位の動画を取得できましたが、サポートされる指標はこのレポートよりも少なくなります。
YouTube サービス別の上位の動画(200 件以下)
このレポートには、人気の動画の一覧が表示され、再生の詳細と地域に関するフィルタがサポートされています。このレポートは前のレポートに似ていますが、サポートされる指標が少なく、youtubeProduct フィルタのサポートが追加されています。
再生詳細フィルタがある上位の動画(検索結果 200 件以下)
このレポートには、コンテンツ所有者の上位の動画がリストされ、1 つ以上の再生情報ディメンション(liveOrOnDemand 、subscribedStatus 、youtubeProduct )でフィルタリングされています。このレポートでは、地域でのフィルタリングもサポートされています。
再生リストレポート
再生リストレポートには、チャンネル所有者の再生リスト内の動画に関連するユーザー アクティビティに関連する指標が含まれます。レポートには 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 年 12 月 31 日以降のコンテンツ所有者レポートではサポートされていません。再生リストレポート移行ガイド では、今回のサポート終了に関連して実施可能な、または実施する必要のある、その他の変更について説明しています。
時間ベース
このレポートには、コンテンツ所有者のチャンネルの再生リスト内の動画に対するユーザーの操作に関する統計情報が、特定の期間にわたって表示されます。特定の再生リストまたはチャンネルのデータのみを返すように、レポートにフィルタを適用できます。
ユーザーの地域
このレポートには、特定の国のユーザーがチャンネルの再生リスト内の動画に対して行った操作に関する統計情報が表示されます。
このレポートには、再生リストの統計情報が国別に表示されます。
地域別の再生リスト アクティビティ
このレポートは、米国の州とコロンビア特別区の再生リストのアクティビティの統計情報を提供します。このレポートでは、filters
パラメータ値に country==US
が含まれています。
再生場所
このレポートには、再生リストが再生されたページまたはアプリケーションのタイプに関連する統計情報が表示されます。
再生場所の詳細(25 件以下)
注: このレポートを使用するには、maxResults
パラメータを 25
以下の整数値に設定する必要があります。他のほとんどのレポートとは異なり、このレポートでは sort
リクエスト パラメータの値も指定する必要があります。
このレポートでは、コンテンツ所有者の再生リストについて、最も多くの視聴回数または視聴時間を生み出した埋め込み動画プレーヤーが特定されます。
トラフィック ソース
このレポートでは、視聴者が再生リストのコンテンツにアクセスした方法に基づいて視聴の統計情報が集計されます。たとえば、Google 検索やチャンネル ページに起因する視聴回数を特定できます。
トラフィック ソースの詳細(25 件以下)
注: このレポートを使用するには、maxResults
パラメータを 25
以下の整数値に設定する必要があります。他のほとんどのレポートとは異なり、このレポートでは sort
リクエスト パラメータの値も指定する必要があります。
このレポートでは、コンテンツ所有者の再生リストの再生回数が最も多かった参照 URL に基づいて、視聴の統計情報が集計されます。参照 URL は、トラフィック ソースの種類によって分類されます。レポートを取得するトラフィック ソースは、insightTrafficSourceDetail ディメンションの定義によって特定されます。たとえば、insightTrafficSourceType フィルタを ADVERTISING
に設定すると、レポートにはコンテンツ所有者の再生リストの再生回数または再生時間が最も多い広告の種類が一覧表示されます。
注: このレポートは、特定のトラフィック ソースでのみサポートされます。たとえば、NO_LINK_EMBEDDED
トラフィック ソースには追加の詳細情報がないため、このレポートはサポートされていません。このレポートをサポートするトラフィック ソースの詳細については、insightTrafficSourceType の定義をご覧ください。
デバイスの種類とオペレーティング システム
プレイリストのデバイスタイプ
このレポートでは、視聴者が再生リストのコンテンツの視聴に使用したデバイスの種類に基づいて、視聴の統計情報が集計されます。たとえば、モバイル デバイスやゲーム機で発生した視聴回数を特定できます。
再生リストのオペレーティング システム
このレポートは、視聴者のオペレーティング システムに基づいて、表示回数の統計情報を集計します。たとえば、Android デバイスや PlayStation で発生した再生リストの視聴回数を特定します。
プレイリストのオペレーティング システムとデバイスの種類
このレポートは、視聴者のオペレーティング システムと端末のタイプに基づいて、表示回数の統計情報を集計します。たとえば、Android タブレットや Windows デスクトップ デバイスで発生した再生リストの視聴回数を特定できます。
視聴者のユーザー属性
このレポートは、視聴者の年齢層や性別に基づいて表示回数の統計情報を集計します。
上位の再生リスト
注: これらのレポートでは、maxResults
パラメータを 200
以下の整数値に設定する必要があります。2013 年 1 月 1 日より前のデータは、上位 10 件の再生リストについてのみ表示されます。他のほとんどのレポートとは異なり、これらのレポートでは sort
リクエスト パラメータの値も指定する必要があります。
このレポートには、指定したフィルタ条件と並べ替え条件に基づいて、コンテンツ所有者の上位の再生リストが表示されます。
注: 広告のパフォーマンス レポートには、https://www.googleapis.com/auth/yt-analytics-monetary.readonly
スコープへのアクセス権を付与する認証トークンが必要です。
広告のパフォーマンス レポートでは、動画再生中に配信された広告について、インプレッション ベースの指標を確認できます。これらの指標では各広告のインプレッションが考慮されており、動画の再生ごとに複数のインプレッションが発生する可能性があります。
インプレッション数に基づく広告のパフォーマンス指標は次のとおりです。
また、一部の動画レポート では、次の再生回数に基づく広告のパフォーマンス指標がサポートされています。ただし、これらの指標は広告のパフォーマンス レポートには含まれません。