このドキュメントでは、YouTube Analytics API と YouTube Reporting API が YouTube アナリティクスのデータにアクセスする方法の類似点と相違点について説明します。これにより、アプリケーションに適した API を選択できます。
どちらの API でも YouTube アナリティクスのデータを取得できます。また、どちらの API も YouTube チャンネル所有者と YouTube コンテンツ所有者をサポートしており、それぞれが特定のレポートセットにアクセスできます。
-
チャンネル レポート : 指定したチャンネルについて、ユーザー アクティビティの指標が表示されます。
-
コンテンツ所有者レポート : 指定した YouTube コンテンツ所有者にリンクされているすべてのチャンネルの指標が集計されます。たとえば、レコード レーベルは、自社アーティストすべての YouTube チャンネルの統計情報を組み合わせたレポートを取得できます。コンテンツ所有者レポートには、ユーザー アクティビティの指標が含まれるものと、収益と広告のパフォーマンスに関連する指標が含まれるものがあります。
Reporting API を使用すると、一部のコンテンツ所有者はシステム管理の広告収益レポートにアクセスすることもできます。システム管理レポートのデータは、Reporting API でのみ取得できます。
YouTube アナリティクス API と YouTube Reporting API のリクエストはすべて、リクエストされたデータを所有するチャンネルまたはコンテンツ所有者によって承認される必要があります。
レポートの内容
API が取得するレポートには、次の 2 種類のデータが含まれています。
-
ディメンション : ユーザー アクティビティが発生した日付やユーザーの所在地など、データの集計に使用される共通の条件です。
レポートでは、データ行ごとにディメンション値の一意の組み合わせがあります。そのため、各行のディメンション値の組み合わせは、その行の主キーとして機能します。
-
指標 : ユーザー アクティビティ、広告のパフォーマンス、推定収益の個々の測定値です。ユーザー アクティビティの指標には、動画の再生回数や評価（高評価と低評価）などがあります。
アプリケーションに適した API を選択する
YouTube Analytics API
YouTube Analytics API は、ターゲットを絞り込んだクエリ に対応し、カスタムの YouTube アナリティクス レポートを生成できます。この API にはフィルタリング パラメータと並べ替えパラメータが用意されているため、呼び出し元のアプリケーションでこれらの機能をネイティブにサポートする必要はありません。
各 API リクエストでは、データが返される期間を指定します。また、この API を使用すると、週次と月次のデータセットを取得できます。そのため、呼び出し元のアプリケーションで取得したデータセットを保存したり、期間全体の統計情報を集計したりする必要はありません。
YouTube Reporting API
YouTube Reporting API は、チャンネルまたはコンテンツ所有者の YouTube アナリティクス データを含む一括レポート を取得します。この API は、大量のデータセットと大規模なエクスポートを必要とする大容量アプリケーション向けに設計されており、特定のコンテンツ所有者データへの排他的アクセスを提供します。
各レポートには、事前定義された一連のフィールドが含まれています。この API を使用して、レポートジョブをスケジュールします。各ジョブは、YouTube が生成するレポートを指定します。YouTube は、非同期でダウンロードできる日次レポートを生成します。各レポートには、一意の 24 時間の期間のデータが含まれています。
YouTube Reporting API は、次のタイプのレポートをサポートしています。
| レポートタイプ | 詳細 |
|---|---|
| 財務レポートと収益レポート | |
| 広告収益 | 広告収益の月次/週次サマリー。 例: content_owner_ad_revenue_summary_a1、
content_owner_estimated_revenue_a1 |
| 定期購入の収益 | 音楽レーベルとパブリッシャーの定期購入の収益。 例: music_content_owner_red_revenue_raw_a1、
content_owner_music_asset_red_revenue_raw_a1 |
| YouTube ショートによる収益 | 特定のコンテンツ所有者の YouTube ショートの収益化のための特定のプール。 例: music_content_owner_shorts_revenue_summary_a1 |
| コンテンツ所有者レポートとアセット レポート | |
| アセットのパフォーマンス | 特定の著作権者が所有するすべてのチャンネルのパフォーマンスをトラッキングできるように設計された、特定のアセット（ISRC/UPC）にリンクされた再生回数とエンゲージメント。 例: content_owner_asset_basic_a3、
content_owner_asset_demographics_a1 |
| 申し立てと参照 | 特定の著作権者が所有するすべてのチャンネルのパフォーマンスをトラッキングできるように設計された、有効な申し立て、潜在的な競合、参照の重複をトラッキングします。 例: content_owner_active_claims_a3、
content_owner_asset_conflict_a3 |
| 動画と再生リストのアナリティクス | |
| 動画と再生リストのアナリティクス | トラフィック ソース、デバイスの種類/OS、再生場所、視聴者の属性など、特定の動画や再生リストの詳細なパフォーマンス データ。 例: channel_traffic_source_a3、
playlist_device_os_a2 |
また、YouTube では、YouTube Studio で対応するレポートにアクセスできるコンテンツ所有者向けに、システム管理レポートのセットが自動的に生成されます。これらのレポートを使用すると、広告収益データにプログラムでアクセスできます。
サポートされるレポート
次の表に、API を使用して取得できるレポートの種類を示します。ターゲットを絞り込んだクエリは YouTube Analytics API を使用して利用でき、一括レポートは YouTube Reporting API を使用して利用できます。
一方の API で利用できるデータが、もう一方の API では利用できない場合があります。たとえば、YouTube Analytics API では、ユーザー アクティビティの指標を週単位または月単位で取得できますが、YouTube Reporting API では、そのデータを自分で集計する必要があります。一方、YouTube Reporting API はコンテンツ所有者のアセット レポートをサポートしていますが、そのデータは YouTube Analytics API からは利用できません。
| レポートの種類 | |
|---|---|
| 動画レポート | チャンネル（クエリまたは一括）とコンテンツ所有者（クエリまたは一括）でサポートされています。 動画レポートには、チャンネルの動画またはコンテンツ所有者の動画に関連するすべてのユーザー アクティビティの統計情報が表示されます。たとえば、これらのレポートには、動画の再生回数が含まれています。YouTube Analytics API では、一部のコンテンツ所有者の動画レポートに、推定収益と広告のパフォーマンスの指標も含まれています。 |
| リーチレポート | チャンネル（一括）とコンテンツ所有者（一括）でサポートされています。 リーチレポートには、動画のサムネイルのインプレッション数とクリック率の統計情報が表示されます。 |
| 再生リストレポート | チャンネル（クエリまたは一括）とコンテンツ所有者（クエリまたは一括）でサポートされています。 再生リストレポートには、再生リストのコンテキストで発生した動画の再生回数に特に関連する統計情報が表示されます。YouTube Reporting API は再生リストの視聴者維持率レポートをサポートしていますが、YouTube Analytics API は同様のレポートをサポートしていません。 |
| 広告のパフォーマンス レポート | コンテンツ所有者（クエリまたは一括）でサポートされています。 広告のパフォーマンス レポートには、動画の再生中に配信された広告のインプレッションに基づく指標が表示されます。これらの指標は広告のインプレッションごとにカウントされ、動画の再生ごとに複数のインプレッションが発生する可能性があります。 |
| 推定収益レポート | コンテンツ所有者（一括）でサポートされています。 推定収益レポートには、Google 広告配信元と広告以外の配信元からの動画の推定総収益が表示されます。 これらのレポートには、広告のパフォーマンスに関する指標も含まれています。システム管理レポートには実際の収益が含まれています。 |
| アセット レポート | コンテンツ所有者（一括）でサポートされています。 アセット レポートには、コンテンツ所有者のアセットにリンクされている動画に関連するユーザー アクティビティの指標が表示されます。コンテンツ所有者が、その動画をコンテンツ所有者のアセットのいずれかと一致するとして申し立てた場合、その動画はコンテンツ所有者のレポートに含まれます。動画は、コンテンツ所有者または別の YouTube ユーザーによってアップロードされた可能性があります。 |
| システム管理レポート | YouTube Studio の [レポート] メニューで対応するレポートにアクセスできるコンテンツ所有者でサポートされています。 システム管理レポートには、アセットと動画が実際に獲得した収益のデータが表示されます。申し立てが行われた動画と、それらの動画が一致するアセットの一覧を示すレポートもあります。YouTube Studio のすべてのレポートが API で利用できるわけではありません。 注: YouTube では、YouTube Studio で対応するレポートにアクセスできるコンテンツ所有者向けに、システム管理レポートが自動的に生成されます。そのため、これらのレポートを取得するプロセスは、このリストの他の種類のレポートとは異なります。詳しくは、システム管理レポートのドキュメントをご覧ください。 |
主な違い
次の表に、YouTube アナリティクス API と Reporting API の重要な違いを示します。
| 機能 | YouTube Analytics API | YouTube Reporting API |
|---|---|---|
| データの取得プロセス | 各 API リクエストでは、返されるディメンションと指標、データが返される期間を指定します。 | アプリケーションはレポートジョブをスケジュールします。ジョブごとに、YouTube は非同期でダウンロードできる日次レポートを生成します。 |
| 期間 | 一部の API レポートでは、ユーザー アクティビティが発生した日付を指定します。これらのレポートの一部では、ユーザー アクティビティの指標を月単位で集計するディメンションがサポートされています。 | すべての API レポートで、ユーザー アクティビティが発生した日付を指定します。この API を使用するアプリケーションでは、一定の間隔でデータを集計する機能を実装できます。 |
| データのフィルタリング | レポートをフィルタして、ディメンションに特定の値が含まれる行のみを含めることができます。この API は、フィルタとしてのみ使用される 大陸 や subContinent などのディメンションもサポートしています。 | この API は、完全なデータセットの一括ダウンロードをサポートしています。フィルタリングはサポートされておらず、フィルタ専用のディメンションのデータは返されません。クライアント アプリケーションは、ダウンロードしたデータを保存し、データをフィルタする独自の機能を実装します。 |
| 並べ替え | レポートは、返された指標値に基づいて並べ替えることができます。一部のレポートでは、結果の数が制限されています。たとえば、チャンネルで最も視聴された動画の一覧を示すレポートでは、最大 200 行が返されます。 | この API は、完全なデータセットの一括ダウンロードをサポートしています。クライアント アプリケーションは、ダウンロードしたデータを並べ替える独自の機能を実装できます。 |
| 列挙型 | API レポートには、「ANDROID」や「CHANNEL」などのテキスト値が含まれており、列挙されたディメンション値を識別できます。 | API レポートには、テキスト値にマッピングできる整数が含まれています。 |
| Quota | API サーバーは各クエリを評価して、割り当てコストを決定します。詳しくは、割り当て使用量のセクションをご覧ください。 | データは一度取得されてから、アプリケーション内でフィルタ、並べ替え、クエリが行われるため、割り当ての使用量は問題になりません。 |
| 一意のレポート |
|
|
| 一意のディメンション | group（フィルタ専用のディメンション） continent（フィルタ専用のディメンション） subContinent（フィルタ専用のディメンション） month viewsPerPlaylistStart averageTimeInPlaylist |
annotation_id annotation_type asset_id card_id card_type live_or_on_demand subscribed_status subtitle_language |
| 一意の指標 | uniques relativeRetentionPerformance viewsPerPlaylistStart averageTimeInPlaylist |
card_click_rate card_clicks card_impressions card_teaser_click_rate card_teaser_clicks card_teaser_impressions estimated_partner_adsense_revenue estimated_partner_doubleclick_revenue playlist_saves_added playlist_saves_removed |
API 間の命名規則の違い
2 つの API では、ディメンションと指標を識別するために異なる命名規則が使用されます。YouTube Analytics API の名前には、adType のようにキャメルケースが使用されます。YouTube Reporting API の名前は小文字で、ad_type のようにアンダースコアが使用されます。
次の表に、2 つの API で同じ指標とディメンションを識別するために使用される名前の違いを示します。場合によっては、2
つの名前の違いは、キャメルケースからアンダースコアに変換した場合よりも大きくなります。たとえば、YouTube Analytics API の video ディメンションは、YouTube Reporting API では video_id という名前になります。