このドキュメントでは、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 は、YouTube クリエイター ツールで対応するレポートにアクセスできるコンテンツ所有者向けに、システム管理レポートのセットを自動的に生成します。これらのレポートでは、広告収益データにプログラムでアクセスできます。
サポートされるレポート
次の表は、API を使用して取得できるさまざまな種類のレポートを示しています。ターゲットを絞り込んだクエリは YouTube Analytics API で、一括レポートは YouTube Reporting API で利用できます。
一方の API で使用できるデータが、もう一方の API では使用できない場合があります。たとえば、YouTube Analytics API ではユーザー アクティビティ指標を週単位または月単位で取得できますが、YouTube Reporting API ではデータを自分で集計する必要があります。一方、YouTube Reporting API はコンテンツ所有者のアセット レポートをサポートしていますが、そのデータは YouTube Analytics API からは利用できません。
| レポートの種類 | |
|---|---|
| 動画レポート | チャンネル（query または bulk）とコンテンツ所有者（query または bulk）でサポートされています。 動画レポートは、チャンネルの動画またはコンテンツ所有者の動画に関連するすべてのユーザー アクティビティの統計情報を提供します。たとえば、これらのレポートには動画の視聴回数が含まれます。YouTube Analytics API では、一部のコンテンツ所有者の動画レポートに、見積もり収益額と広告のパフォーマンス指標も含まれます。 |
| 再生リストレポート | チャンネル（query または bulk）とコンテンツ所有者（query または bulk）でサポートされています。 再生リスト レポートには、再生リストのコンテキストで発生した動画の視聴回数に特に関連する統計情報が表示されます。YouTube Reporting API はプレイリストの視聴者維持率レポートに対応していますが、YouTube Analytics API は同様のレポートに対応していません。 |
| 広告のパフォーマンス レポート | コンテンツ所有者（query または bulk）でサポートされています。 広告の掲載結果レポートには、動画の再生中に表示された広告のインプレッションに基づく指標が表示されます。これらの指標では、広告のインプレッションごとにカウントされ、1 回の動画再生で複数のインプレッションが発生する可能性があります。 |
| 推定収益レポート | コンテンツ所有者向け（一括）にサポートされています。 推定収益レポートには、Google 広告配信元と広告以外の配信元からの動画の合計推定収益が表示されます。これらのレポートには、広告のパフォーマンス指標も含まれています。システム管理レポートには実際の収益が含まれます。 |
| アセット レポート | コンテンツ所有者向け（一括）にサポートされています。 アセット レポートには、コンテンツ所有者のアセットにリンクされている動画に関連するユーザー アクティビティ指標が表示されます。コンテンツ所有者が動画を所有するアセットの 1 つと一致するとして申し立てた場合、その動画はコンテンツ所有者のレポートに含まれます。動画は、コンテンツ所有者または別の YouTube ユーザーによってアップロードされた可能性があります。 |
| システム管理レポート | YouTube のクリエイター ツールの [レポート メニュー] で対応するレポートにアクセスできるコンテンツ所有者が対象です。 システム管理レポートには、アセットと動画が実際に獲得した収益のデータが表示されます。別のレポートには、申し立てが行われた動画と、それらの動画と一致するアセットが一覧表示されます。すべてのクリエイター ツール レポートを API で利用できるわけではありません。 注: YouTube は、クリエイター ツールで対応するレポートにアクセスできるコンテンツ所有者向けに、システム管理レポートを自動的に生成します。そのため、これらのレポートを取得するプロセスは、このリストにある他のタイプのレポートとは異なります。詳細については、システム管理レポートのドキュメントをご覧ください。 |
主な違い
次の表は、YouTube Analytics API と YouTube Reporting API の重要な違いを示しています。
| 機能 | YouTube Analytics API | YouTube Reporting API |
|---|---|---|
| データを取得するプロセス | 各 API リクエストでは、返されるディメンションと指標、およびデータが返される期間を指定します。 | アプリケーションはレポートジョブをスケジュールします。YouTube は、各ジョブについて、非同期でダウンロードできる日次レポートを生成します。 |
| 期間 | 一部の API レポートでは、ユーザー アクティビティが発生した日付が指定されます。これらのレポートの一部では、ユーザー アクティビティ指標を月ごとに集計するディメンションがサポートされています。 | すべての API レポートで、ユーザー アクティビティが発生した日が指定されます。API を使用するアプリケーションは、定期的な間隔でデータを集計する機能を実装できます。 |
| データのフィルタリング | レポートをフィルタして、ディメンションに特定の値がある行のみを含めることができます。この API は、フィルタとしてのみ使用される continent や subContinent などのディメンションもサポートしています。 | API は、完全なデータセットの一括ダウンロードをサポートしています。フィルタのみのディメンションのフィルタリングやデータの返信はサポートされていません。クライアント アプリケーションは、ダウンロードしたデータを保存し、独自の機能を実装してデータをフィルタします。 |
| 並べ替え | レポートは、返された指標値に基づいて並べ替えることができます。一部のレポートでは、サポートされる結果の数に制限があります。たとえば、チャンネルの視聴回数が最も多い動画を一覧表示するレポートでは、最大 200 行が返されます。 | この API は、完全なデータセットの一括ダウンロードをサポートしています。クライアント アプリケーションは、ダウンロードしたデータを並べ替える独自の機能を実装できます。 |
| 列挙型 | API レポートには、列挙型ディメンション値を識別するためのテキスト値（「ANDROID」や「CHANNEL」など）が含まれています。 | API レポートには、テキスト値にマッピングできる整数が含まれています。 |
| 割り当て | API サーバーは各クエリを評価して、割り当て費用を決定します。割り当て使用量セクションで、この方法について詳しく説明します。 | データは 1 回取得されてから、アプリケーション内でフィルタリング、並べ替え、クエリが行われるため、割り当て使用量は問題になりません。 |
| ユニーク レポート |
|
|
| ユニークなディメンション | 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 のように camelCase が使用されます。YouTube Reporting API の名前は小文字で、ad_type のようにアンダースコアを使用します。
次の表に、同じ指標とディメンションを識別するために 2 つの API で使用される異なる名前を示します。場合によっては、2 つの名前の違いが、camelCase からアンダースコアに変換した結果よりも大きくなることがあります。たとえば、YouTube Analytics API の video ディメンションは、YouTube Reporting API では video_id という名前になっています。