このドキュメントでは、YouTube Analytics API と YouTube Reporting API で YouTube アナリティクスのデータにアクセスする方法の類似点と相違点について説明します。このドキュメントは、アプリケーションに適した API を選択できるようにすることを目的としています。
どちらの API でも、デベロッパーは YouTube アナリティクスのデータを取得できます。また、どちらの API も YouTube チャンネル所有者と YouTube コンテンツ所有者をサポートしており、それぞれ特定のレポートにアクセスできます。
-
チャンネル レポート: 指定したチャンネルについて、ユーザー アクティビティの指標が表示されます。
-
コンテンツ所有者レポート: 指定した YouTube コンテンツ所有者にリンクされているすべてのチャンネルの指標が集計されます。たとえば、レコード レーベルは、そのレーベルのすべてのアーティストの YouTube チャンネルについて集計された統計情報を含むレポートを取得できます。コンテンツ所有者レポートには、ユーザー アクティビティの指標を含むものと、収益と広告のパフォーマンスに関連する指標が含まれるものがあります。
Reporting API を使用すると、一部のコンテンツ所有者はシステム管理の広告収益レポートにアクセスできます。システム管理レポートのデータは、Reporting API でのみ取得できます。
YouTube アナリティクスと YouTube Reporting API のリクエストはすべて、リクエストされたデータを所有するチャンネルまたはコンテンツ所有者の承認を受ける必要があります。
コンテンツを報告する
API が取得するレポートには、次の 2 種類のデータが含まれます。
-
ディメンション: ユーザー アクティビティが発生した日付やユーザーが所在する国など、データの集計に使用される一般的な基準です。
レポートでは、データの各行にはディメンション値の組み合わせが一意になっています。したがって、各行のディメンション値の組み合わせは、その行の主キーとして機能します。
-
指標: ユーザー アクティビティ、広告パフォーマンス、推定収益の個々の測定値。ユーザー アクティビティの指標には、動画再生回数、評価（高評価と低評価）が含まれます。
アプリケーションに適した API の選択
- YouTube Analytics API
- YouTube Analytics API は、リアルタイムのターゲット クエリをサポートし、カスタム YouTube アナリティクス レポートを生成します。API はフィルタリングと並べ替えのパラメータを提供するため、呼び出し元アプリはこれらの関数をネイティブにサポートする必要はありません。
各 API リクエストでは、データが返される期間を指定します。また、この API では週次と月次のデータセットを取得することもできます。そのため、呼び出し元のアプリケーションは、取得したデータセットを保存したり、複数の期間にわたる統計情報を集計したりする必要はありません。 - YouTube Reporting API
- YouTube Reporting API は、チャンネルまたはコンテンツ所有者の YouTube アナリティクス データを含む一括レポートを取得します。大規模なデータセットをインポートでき、そのデータのフィルタリング、並べ替え、マイニングのためのツールを提供するアプリケーション向けに設計されています。
各レポートには、事前定義されたフィールドのセットが含まれます。デベロッパーは API を使用してレポートジョブのスケジュールを設定します。各ジョブは、YouTube が生成するレポートを識別します。YouTube は、非同期にダウンロードできる日次レポートを生成します。各レポートには、24 時間単位のデータが含まれます。
また、YouTube クリエイター ツールの対応するレポートにアクセスできるコンテンツ所有者向けのシステム管理レポートも自動的に生成されます。これらのレポートでは、広告収益データにプログラムでアクセスできます。 - 字幕に関連するユーザー アクティビティ
- 再生リストの視聴者維持率データ
- コンテンツ所有者の推定収益レポート（2 種類のレポートが利用可能）
- コンテンツ所有者のアセット レポート（11 種類のレポートが用意されています）
サポートされるレポート
API を使用して取得できるさまざまなタイプのレポートを次の表に示します。対象となるクエリは YouTube Analytics API を介して、一括レポートは YouTube Reporting API を介して利用できます。
ある API では利用可能なデータを、別の API では利用できない場合があります。たとえば、YouTube Analytics API ではユーザー アクティビティの指標を週単位または月単位で取得できますが、YouTube Reporting API ではユーザー自身でデータを集計する必要があります。一方、YouTube Reporting API はコンテンツ所有者のアセット レポートをサポートしていますが、そのデータは YouTube アナリティクス API からは入手できません。
| レポートタイプ | |
|---|---|
| 動画レポート | チャンネル（クエリまたは一括）とコンテンツ所有者（クエリまたは一括）に対応しています。 動画レポートでは、チャンネルの動画やコンテンツ所有者の動画に関連するすべてのユーザー アクティビティについての統計情報を確認できます。たとえば、これらのレポートでは動画の視聴回数を確認できます。YouTube Analytics API では、一部のコンテンツ所有者の動画レポートに、推定収益と広告のパフォーマンス指標も表示されます。 |
| 再生リストレポート | チャンネル（クエリまたは一括）とコンテンツ所有者（クエリまたは一括）に対応しています。 再生リストのレポートでは、再生リストのコンテキスト内で再生される動画視聴に関する統計情報を確認できます。YouTube Reporting API は再生リストの視聴者維持率レポートをサポートしていますが、YouTube Analytics API は同様のレポートをサポートしていません。 |
| 広告のパフォーマンス レポート | コンテンツ所有者（クエリまたは一括）でサポートされます。 広告の掲載結果レポートには、動画の再生中に配信された広告のインプレッション数に基づく指標が表示されます。これらの指標は広告のインプレッションごとに考慮され、動画の再生ごとに複数のインプレッションが生成されます。 |
| 推定収益レポート | コンテンツ所有者（一括）のサポート 推定収益レポートには、Google が販売した広告ソースとそれ以外のソースからの動画の合計推定収益が表示されます。このレポートには、広告の掲載結果に関する指標も含まれています。システム管理レポートには、実際の収益が表示されます。 |
| アセット レポート | コンテンツ所有者（一括）のサポート アセット レポートでは、コンテンツ所有者のアセットにリンクされている動画に関連するユーザー アクティビティの指標を確認できます。コンテンツ所有者が、自分のコンテンツ所有者のアセットのいずれかに一致するとして申し立てを行った動画は、コンテンツ所有者のレポートに含まれます。その動画がコンテンツ所有者または別の YouTube ユーザーによってアップロードされたものである可能性があります。 |
| システム管理レポート | YouTube クリエイター ツールの [レポート] にある、該当するレポートへのアクセス権があるコンテンツ所有者がサポート対象です。 システム管理レポートでは、アセットや動画から得られる実際の収益データを確認できます。追加の動画には、申し立てを行った動画と、その動画と一致するアセットが一覧表示されます。現在、すべてのクリエイター スタジオのレポートを API で利用できるわけではありません。 注: YouTube は、クリエイター ツール内の対応するレポートにアクセスできるコンテンツ所有者向けに、システム管理レポートを自動的に生成します。そのため、これらのレポートを取得するプロセスは、このリストにある他のタイプのレポートとは異なります。詳しくは、システム管理レポートに関するドキュメントをご覧ください。 |
主な違い
次の表は、YouTube アナリティクス API と Reporting API の重要な違いを示したものです。
| 機能 | YouTube Analytics API | YouTube Reporting API |
|---|---|---|
| データを取得するプロセス | 各 API リクエストでは、返されるディメンションと指標、およびデータが返される期間を指定します。 | アプリケーションは、レポートジョブをスケジュールします。YouTube は、ジョブごとに非同期にダウンロードできる日次レポートを生成します。 |
| 期間 | 一部の API レポートでは、ユーザー アクティビティが発生した日付が指定されます。一部のレポートは、ユーザー アクティビティの指標を月ごとに集計するディメンションをサポートしています。 | すべての API レポートでは、ユーザー アクティビティが発生した日を指定します。API を使用するアプリケーションは、定期的な間隔でデータを集計する機能を実装できます。 |
| データのフィルタリング | 特定の値を持つ行のみが含まれるようにレポートをフィルタリングできます。この API では、大陸や亜大陸など、フィルタとしてのみ使用されるディメンションもサポートされています。 | API により、完全なデータセットを一括ダウンロードできます。フィルタのみのディメンションの場合、フィルタリングや戻り値はサポートされていません。クライアント アプリケーションはダウンロードしたデータを保管し、そのデータをフィルタリングする独自の機能を実装します。 |
| 並べ替え | レポートは、返された指標の値に基づいて並べ替えることができます。一部のレポートでは結果件数が制限される場合があります。たとえば、あるチャンネルの再生回数が最も多い動画のリストでは、最大 200 行が返されます。 | この API は、完全なデータセットの一括ダウンロードをサポートしています。クライアント アプリケーションには、ダウンロードしたデータを並べ替えるための独自の機能を実装できます。 |
| 列挙型 | API レポートには、「ANDROID」や「CHANNEL」などのテキスト値が含まれており、列挙されたディメンション値を識別できます。 | API レポートには、テキスト値にマッピングできる整数が含まれています。 |
| 割り当て | API サーバーは、各クエリを評価して割り当てコストを決定します。この手法の詳細については、割り当て使用量のドキュメントをご覧ください。 | データが一度取得され、アプリケーション内でフィルタリング、並べ替え、クエリが行われるため、割り当てを使用しても問題ありません。 |
| 固有のレポート |
|
|
| 固有のディメンション | group（フィルタのみのディメンション） 大陸（フィルタのみのディメンション） subContinent（フィルタのみのディメンション） month isCurated==1（フィルタのみのディメンション） viewsPerPlaylistStart averageTimeInPlaylist |
annotation_id annotation_type asset_id card_id card_type live_or_on_demand subscribed_status subtitle_language |
| 固有の指標 | ユニーク数 相対維持パフォーマンス viewsPerPlaylistStart averageTimeInPlaylist |
card_click_rate card_clicks card_impressions card_teaser_click_rate card_teaser_clicks card_teaser_impressions estimated_partner_adsense_revenue |
API 間の命名の違い
2 つの API では現在、ディメンションと指標の識別に異なる命名規則を使用しています。現時点では、YouTube Analytics API の名前はキャメルケースを使用し、YouTube Reporting API の名前はアンダースコア区切りの名前を使用します。
次の表は、2 つの API で同じ指標とディメンションの識別に使用されるさまざまな名前を示しています。場合によっては、2 つの名前の違いが、名前をキャメルケースからアンダースコアに変換してから得られる名前よりも大きくなります。たとえば、YouTube Analytics API では video ディメンションが YouTube Reporting API では video_id という名前になります。