注: Content owner reports are only accessible to YouTube content partners who participate in the YouTube Partner Program.
このページでは、コンテンツ所有者が YouTube Analytics API で取得できるレポートの一覧を示します。コンテンツ所有者レポートには、指定した YouTube コンテンツ所有者にリンクされているチャンネルの指標が含まれます。指標は、ユーザー アクティビティ、広告のパフォーマンス、推定収益の個々の測定値です。
-
動画レポートには、コンテンツ所有者のチャンネルの動画に関するユーザー アクティビティ、広告のパフォーマンス、推定収益の指標が含まれます。
-
再生リスト レポートには、再生リストのコンテキストで発生した動画の視聴回数に特に関連する統計情報が表示されます。再生リスト レポートでは、動画レポートと同じディメンションやフィルタが多数使用されています。
-
広告のパフォーマンス レポートには、収益と広告のパフォーマンスに関連する指標が表示されます。adType ディメンションを使用して、動画再生中に表示された広告の種類に基づいて指標をグループ化します。広告のパフォーマンス レポートのセクションでは、API がサポートする 2 種類の広告パフォーマンス指標について説明します。
レポートの取得
コンテンツ所有者のレポートを取得するには、API の reports.query
メソッドを呼び出し、API リクエストの ids
パラメータの値を contentOwner==OWNER_NAME
に設定します。ここで、OWNER_NAME
はコンテンツ所有者の ID を指定します。値が不明な場合は、パートナー マネージャーにお問い合わせください。
承認
YouTube アナリティクス API へのリクエストはすべて承認を受ける必要があります。認可ガイドでは、OAuth 2.0 プロトコルを使用して認可トークンを取得する方法について説明しています。
YouTube アナリティクス 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 Analytics API では、コンテンツ所有者はこのスコープを使用して YouTube アナリティクス グループとグループ アイテムを管理します。 |
注: アスタリスク(*
)が付いている指標には、https://www.googleapis.com/auth/yt-analytics-monetary.readonly
スコープへのアクセス権を付与する認証トークンが必要です。
フィルタ
コンテンツ所有者のレポートを取得するすべての API リクエストでは、video
ディメンション、channel
ディメンション、または claimedStatus
ディメンションと uploaderType
ディメンションのサポートされている組み合わせのいずれかを使用してデータをフィルタする必要があります。(サポートされている組み合わせは、uploaderType
ディメンションの定義に記載されています)。
サポートされているレポートを説明する表には、特定のレポートで使用できるフィルタが記載されています。説明文では、括弧で囲まれたフィルタは省略可能です。たとえば、レポートにフィルタ オプションとして video(,country)
が表示されている場合、レポートをフィルタして特定の動画のデータのみを含めることも、特定の国の特定の動画のデータのみを含めることもできます。
この API では、video
、playlist
、channel
のフィルタに複数の値を指定することもできます。これらのフィルタのいずれかに複数の値を指定する場合は、リクエストで指定するディメンションのリストにそのフィルタを追加することもできます。これは、特定のレポートでフィルタがサポートされているディメンションとしてリストに表示されていない場合でも同様です。
特定の値または値のセットで 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 個以上を使用: グループから任意の値またはすべての値を含めることができます。
重要: コンテンツ所有者の動画レポートを取得するすべての 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 つのレポートをリストしています。一方のレポートは liveOrOnDemand ディメンション(およびフィルタ)をサポートし、もう一方のレポートは averageViewPercentage 指標をサポートしています。
登録ステータス別のユーザー アクティビティ
このレポートでは、チャンネル登録者とチャンネル登録していない視聴者のユーザー アクティビティ指標を確認できます。統計情報は期間(日または月)でグループ化できます。また、レポートは国、大陸、subContinentでフィルタすることもできます。
州別の登録ステータス別のユーザー アクティビティ
このレポートには、米国の州またはコロンビア特別区におけるチャンネル登録者と未登録者のユーザー アクティビティ指標が表示されます。このレポートでサポートされる指標は、以前のレポートよりも少なくなっています。
再生の詳細(時間ディメンションは省略可)
これらのレポートでは、時間ディメンション(日または月)は省略可能です。レポートの対象期間を指定するには、いずれにしても startDate
と endDate
のリクエスト パラメータを使用する必要があるためです。ディメンションが存在する場合、レポートのデータを日別、月別などに集計することを意味します。
再生の詳細(オプションの時間ディメンションと liveOrOnDemand 統計情報を含む)
このレポートには、特定の期間の再生に関する詳細な統計情報が表示されます。liveOrOnDemand ディメンション(およびフィルタ)をサポートしています。
このレポートには、特定の期間の再生に関する詳細な統計情報が表示されます。
国別の再生の詳細
このレポートでは、国別の再生の詳細な統計情報を確認できます。liveOrOnDemand ディメンション(およびフィルタ)をサポートしています。
次のレポートは、前のレポートと似ています。averageViewPercentage 指標のサポートが追加されましたが、liveOrOnDemand はディメンションまたはフィルタとしてサポートされていません。
都道府県別の再生回数の詳細
このレポートには、米国の州とコロンビア特別区の再生に関する詳細な統計情報が記載されています。liveOrOnDemand ディメンション(およびフィルタ)をサポートしています。
次のレポートは、前のレポートと似ています。averageViewPercentage 指標のサポートが追加されましたが、liveOrOnDemand はディメンションまたはフィルタとしてサポートされていません。
再生場所
ビデオ再生場所レポート
このレポートは、動画再生が発生したページまたはアプリケーションのタイプに関する統計情報を提供します。.
再生場所の詳細 (25 件以下の結果)
注: このレポートでは、maxResults
パラメータを 25
以下の整数値に設定する必要があります。他のほとんどのレポートとは異なり、このレポートでは sort
リクエスト パラメータの値を指定する必要もあります。
このレポートでは、コンテンツ所有者のコンテンツの視聴回数または視聴時間が最も多かった埋め込み動画プレーヤーを確認できます。このレポートを取得する際は、insightPlaybackLocationType
フィルタを EMBEDDED
に設定する必要があります。
トラフィック ソース
トラフィック ソース
このレポートでは、視聴者が動画コンテンツにアクセスした方法に基づいて視聴統計情報が集計されます。たとえば、Google 検索や関連動画へのリンクから発生した視聴回数を特定できます。
注: クエリされた動画の数 × 期間の日数 の積が 50,000 を超えると、このレポートはエラーを返します。たとえば、500 個の動画 ID のデータを取得するクエリでは、最大 100 日間のデータをリクエストできます。リクエストで返される行数を減らすには、指定する動画の数を減らすか、期間を短くする複数のクエリに分割します。
トラフィック ソースの詳細 (25 件以下の結果)
注: このレポートでは、maxResults
パラメータを 25
以下の整数値に設定する必要があります。他のほとんどのレポートとは異なり、このレポートでは sort
リクエスト パラメータの値を指定する必要もあります。
このレポートには、コンテンツ所有者のコンテンツの視聴回数が最も多かったリファラーに基づいて集計された視聴統計情報が表示されます。参照 URL は、トラフィック ソースの種類によって分類されます。レポートを取得するトラフィック ソースは、insightTrafficSourceDetail ディメンションの定義によって特定されます。たとえば、insightTrafficSourceType フィルタを ADVERTISING
に設定すると、コンテンツ所有者のコンテンツで最も多くの視聴回数または視聴時間を獲得した広告の種類がレポートに表示されます。
注: このレポートは、特定のトラフィック ソースでのみサポートされます。VIDEO_REMIXES
、NOTIFICATION
、END_SCREEN
、CAMPAIGN_CARD
、VIDEO_REMIXES
、NO_LINK_EMBEDDED
のトラフィック ソースは、サポートされていないトラフィック ソースの一部です。
デバイスの種類とオペレーティング システム
デバイスの種類
このレポートには、視聴者がコンテンツを視聴したときに使用していたデバイスの種類に基づいて集計された視聴統計情報が表示されます。たとえば、タブレットやゲーム機で発生した視聴回数を特定できます。
オペレーティング システム
このレポートは、視聴者のオペレーティング システムに基づいて、表示回数の統計情報を集計します。たとえば、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 つのバージョンがあります。利用可能な各レポートについて、次のセクションで各バージョンの説明を示します。
集計された動画指標
これらの指標は、再生リスト内のすべての動画(再生リストを所有するチャンネルが所有する動画)について集計されたユーザー アクティビティとインプレッションの指標を提供します。他のチャンネルが所有する動画の指標は、集計で計算されません。そのため、他のチャンネルが所有する動画のみを含む再生リストをチャンネルが作成した場合、これらの再生リストのレポートにはこれらの指標の値が表示されません。
YouTube でサポートされている動画の集計指標の一覧については、サポートされているプレイリストの指標をご覧ください。
再生リスト内の指標
これらの指標は、再生リスト ページでのユーザーのアクティビティとエンゲージメントを反映しています。これらの指標には、再生リスト内のすべての動画の視聴回数が含まれます(所有チャンネルは問いません)。ただし、再生リスト内で発生した視聴回数のみがカウントされます。
サポートされているプレイリストの指標
基本統計情報
このレポートは、コンテンツ所有者のチャンネルの再生リスト内の動画に対するユーザーのアクションに関する統計情報を提供します。レポートに必須ディメンションがありません。
時間ベース
このレポートは、特定の期間におけるコンテンツ所有者のチャンネルの再生リスト内の動画に対するユーザーの操作に関する統計情報を提供します。レポートをフィルタして、特定の再生リストまたはチャンネルのデータのみを返すことができます。
ユーザーの地域
このレポートは、特定の国のユーザーがチャンネルの再生リスト内の動画に対して行った操作に関する統計情報を提供します。
このレポートでは、国別の再生リストの統計情報が提供されます。
都道府県別のプレイリスト アクティビティ
このレポートは、米国の州とコロンビア特別区の再生リストのアクティビティの統計情報を提供します。このレポートでは、filters
パラメータ値に country==US
を含めます。
再生場所
このレポートには、プレイリストの再生が行われたページまたはアプリの種類に関する統計情報が表示されます。
再生場所の詳細 (25 件以下の結果)
注: このレポートでは、maxResults
パラメータを 25
以下の整数値に設定する必要があります。他のほとんどのレポートとは異なり、このレポートでは sort
リクエスト パラメータの値を指定する必要もあります。
このレポートでは、コンテンツ所有者の再生リストの視聴回数または視聴時間が最も多かった埋め込み動画プレーヤーを確認できます。
トラフィック ソース
このレポートでは、視聴者が再生リストのコンテンツにアクセスした方法に基づいて視聴統計情報が集計されます。たとえば、Google 検索やチャンネル ページから発生した視聴回数を特定できます。
トラフィック ソースの詳細 (25 件以下の結果)
注: このレポートでは、maxResults
パラメータを 25
以下の整数値に設定する必要があります。他のほとんどのレポートとは異なり、このレポートでは sort
リクエスト パラメータの値を指定する必要もあります。
このレポートでは、コンテンツ所有者の再生リストの視聴回数が最も多かった参照元に基づいて、視聴統計情報が集計されます。参照 URL は、トラフィック ソースの種類によって分類されます。レポートを取得するトラフィック ソースは、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
スコープへのアクセスを許可する認可トークンが必要です。
広告のパフォーマンス レポートには、動画の再生中に表示された広告のインプレッションに基づく指標が表示されます。これらの指標では、広告のインプレッションごとにカウントされ、1 回の動画再生で複数のインプレッションが発生する可能性があります。
インプレッション ベースの広告のパフォーマンス指標は次のとおりです。
また、一部の動画レポートでは、再生ベースの広告パフォーマンス指標もサポートされています。ただし、これらの指標は広告のパフォーマンス レポートには含まれません。