このドキュメントでは、YouTube Analytics API でサポートされているディメンションを定義します。この API は、ターゲットを絞り込んだリアルタイム クエリに対応し、カスタムの YouTube アナリティクス レポートを生成できます。
ディメンションは、データの集計に使用される一般的な条件です(ユーザー アクティビティが発生した日付や、ユーザーが所在する国など)。
各クエリ レポートには、サポートされているディメンションが示されています。たとえば、時間別にユーザー アクティビティを取得する場合は、データのレポート対象期間(日または月)を選択します。どのレポートでも、データの各行にはディメンション値の一意の組み合わせがあります。
クエリ レポートを取得するには、YouTube Analytics API の reports.query
メソッドを呼び出します。リクエストで dimensions
パラメータを使用して、レポートの指標値の計算に YouTube が使用するディメンションを指定します。
主要なディメンション
YouTube Analytics API は、利用規約で定義されている非推奨ポリシーの対象となりますが、コア以外のディメンション(およびコア以外の指標)はポリシーの対象外です。このページの定義では、コア ディメンションであるディメンションは明示的に識別されます。
次のリストに、API のコア ディメンションを示します。
詳細については、非推奨ポリシーが適用される YouTube API のリストをご覧ください。
フィルタ
すべてのクエリ レポートでフィルタがサポートされています。フィルタは、取得したデータセットに存在する必要があるディメンション値を特定します。そのため、特定の値または値のセットに一致するデータのみが API レスポンスに含まれるように制限されます。たとえば、すべての国のユーザー アクティビティ指標を取得するのではなく、フィルタを使用して特定の国のデータのみを取得できます。
クエリ レポートを取得するリクエストでは、省略可能な filters
リクエスト パラメータで、データをフィルタするディメンション値を指定します。たとえば、ヨーロッパのユーザー アクティビティ指標を取得するには、filters
パラメータの値を continent==150
に設定します。
重要: コンテンツ所有者レポートを取得する API リクエストでは、レポート対象エンティティのディメンションのいずれかを使用するか、claimedStatus
ディメンションと uploaderType
ディメンションのサポートされている組み合わせを使用してデータをフィルタする必要があります。
ディメンション
以降のセクションでは、YouTube Analytics API のクエリ レポートで使用されるディメンションを定義します。特に明記されていない限り、これらのディメンションはチャンネル レポートとコンテンツ所有者レポートの両方で使用されます。フィルタとしてのみ使用できるディメンションも識別されます。
リソース
これらのディメンションは、チャンネルとコンテンツ所有者が YouTube で管理するリソースに対応しています。
注: この API では、video
、playlist
、channel
ディメンションをフィルタとして使用するときに、複数の値を指定できます。これを行うには、filters
パラメータの値を、API レスポンスのフィルタ対象となる動画 ID、再生リスト ID、チャンネル ID のカンマ区切りリストに設定します。パラメータ値には、最大 500 個の ID を指定できます。
- 動画 (コア ディメンション)
- YouTube 動画の ID。YouTube Data API では、これは
video
リソースのid
プロパティの値です。This is a core dimension and is subject to the Deprecation Policy. - 再生リスト
- YouTube 再生リストの ID。YouTube Data API では、これは
playlist
リソースのid
プロパティの値です。 - channel(コア ディメンション)(コンテンツ所有者のレポートでのみ使用)
- YouTube チャンネルの ID。YouTube Data API では、これは
channel
リソースのid
プロパティの値です。This is a core dimension and is subject to the Deprecation Policy.channel
ディメンションは、コンテンツ所有者レポートでよく使用されます。これらのレポートでは通常、複数のチャンネルのデータが集計されるためです。 - group(フィルタのみ)
- YouTube アナリティクス グループの ID。この値は、YouTube Analytics API の
groups.list
メソッドを使用して取得できます。group
フィルタを使用すると、API レスポンスには、そのグループ内のすべての動画、再生リスト、チャンネルのデータが含まれます。
例
次のサンプル リクエストでは、レポート エンティティのディメンションまたはフィルタを使用しています。
チャンネルの例
コンテンツ所有者の例
地理的エリア
これらのディメンションは、ユーザー アクティビティ、広告のパフォーマンス、推定収益の指標に関連付けられた地域を特定します。
- country(コア ディメンション)
- レポートの行の指標に関連付けられている国。ディメンションの値は、
US
、CN
(中国)、FR
(フランス)などの 2 文字の ISO-3166-1 国コードです。国コードZZ
は、YouTube が関連する国を特定できなかった指標を報告するために使用されます。This is a core dimension and is subject to the Deprecation Policy. - province
- レポートの行の指標に関連付けられている米国の州または地域。ディメンションの値は、米国の州またはコロンビア特別区を識別する ISO 3166-2 コードです(
US-MI
(ミシガン)やUS-TX
(テキサス)など)。州コードUS-ZZ
は、YouTube が関連する米国の州を特定できなかった指標を報告するために使用されます。API リクエストのdimensions
パラメータ値にprovince
が含まれている場合は、filters
パラメータ値にcountry==US
を含めて、データを米国に限定する必要があります。注: このディメンションは、米国の離島を識別する ISO 3166-2 値をサポートしていません。これらの地域には独自の ISO 3166-1 国コードもあります。また、米国以外の国の行政区画もサポートされていません。
- dma
- Nielsen がデータ行に記載されている視聴イベントに関連付けられた指定マーケット エリア(DMA)を識別するために使用する 3 桁の識別子。
- city
- レポートの行の指標に関連付けられている推定都市。このディメンションのデータは、2022 年 1 月 1 日以降の日付について使用できます。
- continent(フィルタのみ)
-
国連(UN)統計地域コード。この API は、次の値をサポートしています。
値 002
アフリカ 019
南北アメリカ(北米、ラテンアメリカ、南米、カリブ海地域) 142
アジア 150
ヨーロッパ 009
オセアニア filters
パラメータの値をcontinent==REGION_CODE
に設定し、表のREGION_CODE
値を指定します。 - subContinent(フィルタのみ)
-
地理的サブリージョンを識別する国連統計地域コード。国連統計局には、サブリージョンと、各リージョンに関連付けられている国がリストされています。
このディメンションは、データのフィルタリングにのみ使用できます。このディメンションを使用するには、
filters
パラメータの値をsubContinent==REGION_CODE
に設定し、UN リストのREGION_CODE
値を指定します。
例
次のサンプル リクエストでは、地域のディメンションまたはフィルタを使用しています。
チャンネルの例
- 基本統計情報: チャンネルの国別の視聴回数など
-
地域
- チャンネルの動画の国別再生時間の指標
- チャンネルの動画のアノテーションに関する国別の指標
- 米国の州とワシントン DC の州固有の指標
- チャンネルの再生リストの国別の総再生時間の指標
- トップ 10 - 米国で最も再生された再生リスト
- 再生場所: さまざまな再生場所での 1 日あたりの視聴回数と総再生時間
- トラフィック ソース: 国内のさまざまなトラフィック ソースからの視聴回数と総再生時間
- ユーザー属性: カリフォルニア州の視聴者のユーザー属性(年齢層と性別)
-
人気の動画
- トップ 10 – 特定の国における再生回数が多い動画
- トップ 10 - ヨーロッパで最も視聴された動画
コンテンツ所有者の例
- 基本統計情報: 自分でアップロードしたすべての動画の国別の視聴回数など
-
地域
- 自身がアップロードしたコンテンツの国別再生時間の指標
- 自身がアップロードしたコンテンツのアノテーションに関する国別の指標
- 米国の州とワシントン DC の州固有の指標
- コンテンツ所有者のプレイリストの国別の総再生時間の指標
- トップ 10 - 米国で最も再生された再生リスト
- 再生場所: さまざまな再生場所での 1 日の視聴回数と総再生時間
- ユーザー属性: カリフォルニア州の視聴者のユーザー属性(年齢層と性別)
- 人気の動画: トップ 10 - コンテンツ所有者のヨーロッパでの視聴回数上位の動画
- 収益/広告のパフォーマンス: 国別の収益と広告のパフォーマンス指標
期間
これらのディメンションは、レポートで期間(日、週、月など)に基づいてデータを集計することを示します。startDate
と endDate
のリクエスト パラメータは、レポートにデータが含まれる期間を指定します。ただし、レポートで実際に返されるデータは、クエリが実行された時点でリクエストで指定されたすべての指標が利用可能な最終日までのものです。レポートでは、日付は YYYY-MM-DD
形式で表示されます。
重要: すべての日付は、太平洋時間(UTC-7 または UTC-8)の午前 0 時から、指定した日付、月、年の午後 11 時 59 分までの期間を指します。そのため、夏時間に合わせて時計が進められる日付は 23 時間の期間を表し、時計が遅められる日付は 25 時間の期間を表します。
[月] ディメンションは、指定した月と年の 1 日目の午前 0 時(太平洋時間(UTC-7 または UTC-8))から始まる期間を表します。
- 日 (コア ディメンション)
- このディメンションを使用すると、レポート内のデータは日単位で集計され、各行には 1 日分のデータが含まれます。他のディメンションを使用して、データをさらに細かく分類することもできます。たとえば、トラフィック ソース レポートでは、ユーザーが動画にアクセスした方法に基づいて 1 日の視聴統計情報を集計できます。This is a core dimension and is subject to the Deprecation Policy.
- 月 (コア ディメンション)
- レポートのデータは暦月ごとに集計されます。日次レポートと同様、他のフィルタを使用してデータをさらに細かく分類することができます。レポートの日付は
YYYY-MM
形式で表示されます。
注: API クエリでmonth
ディメンションを使用する場合は、start-date
パラメータとend-date
パラメータの両方を 1 日目に設定する必要があります。This is a core dimension and is subject to the Deprecation Policy.
例
次のサンプル リクエストでは、時間ディメンションまたはフィルタを使用しています。
チャンネルの例
-
時間ベース
- チャンネルの動画の日別再生時間の指標
- チャンネルの動画のアノテーションに関する日別の指標
- チャンネルの 1 日の再生リスト視聴回数
- 再生場所: さまざまな再生場所での 1 日あたりの視聴回数と総再生時間
- トラフィック ソース: さまざまなトラフィック ソースからの 1 日あたりの視聴回数と総再生時間
-
デバイス/OS
- Android オペレーティング システムの端末のタイプに関する日別の指標
- 携帯端末のオペレーティング システムに関する日別の指標
- オペレーティング システムと端末のタイプに関する日別の指標
-
時間ベース
コンテンツ所有者の例
-
時間ベース
- 自身がアップロードしたコンテンツの日別再生時間の指標
- 申し立てが行われたコンテンツのアノテーションに関する指標
- コンテンツ所有者の 1 日の再生リストの視聴回数
- 再生場所: さまざまな再生場所での 1 日あたりの視聴回数と総再生時間
- トラフィック ソース: さまざまなトラフィック ソースからの 1 日あたりの視聴回数と総再生時間
-
デバイス/OS
- 申し立てが行われた動画の端末のタイプに関する日別の指標
- 申し立てが行われた動画が携帯端末で再生されたときのオペレーティング システムに関する日別の指標
- オペレーティング システムと端末のタイプに関する日別の指標
- 収益/広告のパフォーマンス: 1 日あたりの収益と広告のパフォーマンスに関する指標
-
時間ベース
再生場所
これらのディメンションでは、ユーザー アクティビティが発生したページまたはアプリに関する分析情報を確認できます。
- insightPlaybackLocationType
-
レポートのデータは、動画の再生が発生したページまたはアプリの種類に基づいて集計されます。このディメンションの値は次のとおりです。
-
BROWSE
- YouTube のホームページまたはホーム画面、ユーザーのチャンネル登録フィード、または YouTube の他のブラウジング機能で行われた視聴を表すデータです。 -
CHANNEL
- チャンネル ページで発生した視聴回数を示すデータ。 -
EMBEDDED
-<iframe>
または<object>
埋め込みを使用して動画が埋め込まれた別のウェブサイトまたはアプリケーションで発生した視聴を表します。 -
EXTERNAL_APP
- サードパーティ製アプリで発生した視聴回数を表します。この場合、動画は<iframe>
または<object>
の埋め込み以外の方法で再生されています。たとえば、YouTube Android Player API を使用するアプリでの再生は、この値を使用して分類されます。 -
MOBILE
- YouTube のモバイル ウェブサイトまたは承認済みの YouTube API クライアント(モバイル デバイスを含む)で発生した視聴を表すデータ。2013 年 9 月 10 日より、YouTube アナリティクスのレポートで再生が
MOBILE
再生として分類されなくなりました。以前のデータは引き続きこのカテゴリに分類されるため、この値はレポートに残ることがあります。ただし、それ以降のモバイル再生は、再生が発生するアプリの種類に応じて、WATCH
、EMBEDDED
、EXTERNAL_APP
のいずれかの再生として分類されます。 -
SEARCH
- YouTube 検索結果ページで直接行われた視聴回数を表すデータです。 -
WATCH
- 動画の YouTube 再生ページまたは公式の YouTube アプリ(YouTube Android アプリなど)で発生した視聴を表すデータ。 -
YT_OTHER
- 特に分類されていないビューを記述するデータ。
-
- insightPlaybackLocationDetail
- データは、プレーヤーが配置されているページに基づいて集計されます。このレポートは埋め込みプレーヤーで発生した再生回数のみに対応しており、指定した動画が最も多く再生された埋め込みプレーヤーを識別します。このため、上位の埋め込みプレーヤーに関連付けられた URL またはアプリケーションを識別することにより、再生場所レポートよりもきめ細かいビューが提供されます。
例
以下のサンプル リクエストでは、再生場所ディメンションを使用しています。
チャンネルの例
-
再生場所
- 各再生場所における再生回数と再生時間
- さまざまな再生場所での 1 日の視聴回数と総再生時間
- トップ 10 – 埋め込み動画の再生を最も多く生成したサードパーティのサイト
- 再生リストの視聴回数と再生時間(再生場所別)
- 再生リストの 1 日の視聴回数と再生時間(再生場所別)
-
再生場所
コンテンツ所有者の例
-
再生場所
- 各再生場所における再生回数と再生時間
- さまざまな再生場所での 1 日の視聴回数と総再生時間
- トップ 10 – 埋め込み動画の再生を最も多く生成したサードパーティのサイト
- 再生リストの視聴回数と再生時間(再生場所別)
- 再生リストの 1 日の視聴回数と再生時間(再生場所別)
-
再生場所
再生の詳細
- creatorContentType
- このディメンションは、データ行のユーザー アクティビティ指標に関連付けられているコンテンツのタイプを識別します。このディメンションのデータは、2019 年 1 月 1 日以降の日付について利用できます。
次の表に、ディメンションの値を示します。
値 LIVE_STREAM
視聴したコンテンツが YouTube ライブ配信だった。 SHORTS
視聴されたコンテンツが YouTube ショートだった。 STORY
視聴したコンテンツが YouTube ストーリーだった。 VIDEO_ON_DEMAND
視聴されたコンテンツが、他のディメンション値のいずれにも該当しない YouTube 動画である。 UNSPECIFIED
表示されたコンテンツのコンテンツ タイプが不明です。 - liveOrOnDemand
- このディメンションは、データ行のユーザー アクティビティ指標がライブ配信の視聴に関連付けられているかどうかを示します。このディメンションのデータは、2014 年 4 月 1 日以降の日付で利用できます。
次の表に、ディメンションの値を示します。
値 LIVE
行のデータには、ライブ配信中に発生したユーザー アクティビティが記述されます。 ON_DEMAND
この行のデータは、ライブ配信中に発生しなかったユーザー アクティビティを表します。 - subscribedStatus
- このディメンションは、データ行のユーザー アクティビティ指標が、動画または再生リストのチャンネルをチャンネル登録している視聴者に関連付けられているかどうかを示します。
有効な値は
SUBSCRIBED
とUNSUBSCRIBED
です。
ディメンションの値は、ユーザー アクティビティが発生した時点で正確です。たとえば、あるユーザーがチャンネルに登録せずにそのチャンネルの動画の 1 本を視聴し、その後チャンネルに登録して別の動画を視聴したとします。この場合、すべて同じ日に行われたとみなされます。 チャンネルのレポートによると、1 つのビューのsubscribedStatus
の値はSUBSCRIBED
、もう 1 つのビューのsubscribedStatus
の値はUNSUBSCRIBED
です。 - youtubeProduct
- このディメンションでは、ユーザー アクティビティが発生した YouTube サービスが特定されます。このディメンションのデータは 2015 年 7 月 18 日より利用できます。
次の表に、ディメンションの値を示します。
値 CORE
特別な YouTube アプリ(YouTube Gaming、YouTube Kids、YouTube Music)で発生しなかったユーザー アクティビティ。例外: 2021 年 3 月 1 日より前に YouTube Music で発生したユーザー アクティビティは CORE
に含まれます。GAMING
ユーザー アクティビティが YouTube Gaming で発生した。 KIDS
ユーザー アクティビティが YouTube Kids で発生した。 MUSIC
ユーザー アクティビティが 2021 年 3 月 1 日以降に YouTube Music で発生している。2021 年 3 月 1 日より前のデータは CORE
に含まれます。リアルタイム データは記録されません。UNKNOWN
ユーザー アクティビティが 2015 年 7 月 18 日より前に発生している。
トラフィック ソース
- insightTrafficSourceType
- レポートのデータは、ユーザーが動画にアクセスした方法を示す参照元の種類に基づいて集計されます。このディメンションでは、次の値を使用できます。
ADVERTISING
- 視聴者が広告から動画に誘導された。このトラフィック ソースに基づいてフィルタリングする場合、insightTrafficSourceDetail
フィールドは広告の種類を識別します。ANNOTATION
- 視聴者が別の動画のアノテーションをクリックして動画にアクセスした。CAMPAIGN_CARD
- コンテンツ所有者が視聴されたコンテンツの宣伝に使用した、ユーザーがアップロードした申し立てを受けた動画から発生した視聴回数。このトラフィック ソースは、コンテンツ所有者レポートでのみサポートされています。END_SCREEN
- 別の動画の終了画面から参照された視聴回数。EXT_URL
- 動画の視聴回数が、別のウェブサイトのリンクから発生した。このトラフィック ソースに基づいてフィルタリングする場合、insightTrafficSourceDetail
フィールドはウェブページを識別します。このトラフィック ソースには、Google 検索結果からの参照が含まれます。HASHTAGS
- VOD ハッシュタグ ページまたはショート動画ハッシュタグ ピボット ページから発生した視聴回数。LIVE_REDIRECT
- 動画の視聴回数がライブ リダイレクトから参照されたもの。NO_LINK_EMBEDDED
- 動画が視聴されたときに、別のウェブサイトに埋め込まれていた。NO_LINK_OTHER
- YouTube はトラフィックの参照元を特定しませんでした。このカテゴリには動画への直接トラフィック(ノーリファラー)とモバイル アプリのトラフィックが含まれます。NOTIFICATION
- YouTube からのメールまたは通知から動画の視聴に誘導された。PLAYLIST
- 動画の視聴は、動画が再生リストの一部として再生されている間に発生しました。これには、再生リスト ページからのトラフィックが含まれます。PRODUCT_PAGE
- 動画の視聴が商品ページから参照された。PROMOTED
- YouTube の「注目の動画」ページなど、YouTube の無料プロモーションから動画の視聴に誘導された場合。RELATED_VIDEO
- 動画再生は、別の動画再生ページの関連動画のリスティングから参照されたものです。このトラフィック ソースに基づいてフィルタする場合、insightTrafficSourceDetail
フィールドにはその動画の動画 ID が指定されます。SHORTS
- 視聴者が、YouTube ショートの視聴環境で前の動画から縦方向にスワイプして参照された。SOUND_PAGE
- ショート動画のサウンド ピボットページからの視聴回数。SUBSCRIBER
- YouTube トップページのフィードまたは YouTube の登録チャンネル機能から動画視聴に誘導された視聴回数。このトラフィック ソースに基づいてフィルタリングする場合、insightTrafficSourceDetail
フィールドには、視聴が参照されたトップページのフィードアイテムまたはその他のページを指定します。YT_CHANNEL
- 動画の視聴がチャンネル ページで発生しました。このトラフィック ソースに基づいてフィルタする場合は、insightTrafficSourceDetail
フィールドにそのチャンネルのチャンネル ID を指定します。YT_OTHER_PAGE
- YouTube ページに表示された検索結果や関連動画のリンク以外のリンクから動画が参照された視聴回数。このトラフィック ソースに基づいてフィルタする場合、insightTrafficSourceDetail
フィールドはページを識別します。YT_SEARCH
- YouTube 検索結果から動画が参照された視聴回数。このトラフィック ソースに基づいてフィルタする場合は、insightTrafficSourceDetail
フィールドに検索キーワードを指定します。VIDEO_REMIXES
- 動画の視聴回数が、YouTube ショート プレーヤーのリミックス動画リンクから発生した。このトラフィック ソースに基づいてフィルタする場合、insightTrafficSourceDetail
フィールドには、視聴者が参照された動画を指定します。
- insightTrafficSourceDetail
- レポートのデータは、指定した動画と指定したトラフィック ソース タイプで最も多くの視聴回数を発生させた参照元に基づいて集計されます。このレポートを利用できるトラフィック ソースは次のとおりです。トラフィック ソースごとに、
insightTrafficSourceDetail
ディメンションが提供する情報がリストに表示されます。ADVERTISING
- 視聴につながった広告の種類。次の値があります。- Click-to-Play エンゲージメント広告
- エンゲージメント促進広告
- Google 検索広告
- トップページ YVA
- 予約済みのスキップ可能なインストリーム
- TrueView インサーチとインディスプレイ
- TrueView インストリーム
- 該当カテゴリのない YouTube 広告
- サムネイル表示
CAMPAIGN_CARD
- レポートで特定された動画に視聴者を誘導した申し立てを受けた動画。END_SCREEN
- 報告で特定された動画に視聴者を誘導した動画。EXT_URL
- 視聴者を動画に誘導したウェブサイト。HASHTAGS
- 視聴につながったハッシュタグ。NOTIFICATION
- トラフィックを誘導したメールまたは通知。RELATED_VIDEO
- 報告対象の動画に視聴者を誘導した関連動画。SOUND_PAGE
- 視聴につながった動画。SUBSCRIBER
- レポートに記載されている動画に視聴者を誘導した、トップページ フィード アイテムまたは YouTube 登録チャンネル機能。有効な値は次のとおりです。activity
- アップロードやソーシャル チャンネル以外のアクティビティ(高評価、お気に入り、お知らせの投稿、再生リストへの追加など)が原因で、トップページの登録チャンネル フィードに表示されたアイテムからの視聴回数です。blogged
- トップブログからのリンクからアクセスされた、トップページの登録チャンネル フィード内のアイテムからの視聴回数。mychannel
- トップページに表示される他のフィード([高評価]、[再生履歴]、[後で見る] など)のアイテムからの視聴回数です。podcasts
- Podcasts のリンク先ページのアイテムから発生した視聴回数。sdig
- 定期購入の更新メールから発生した視聴回数。uploaded
- トップページの登録チャンネル フィードに表示されたuploaded
アイテムからの視聴回数です。/
- YouTube のトップページから発生したその他の視聴回数。/my_subscriptions
- YouTube の [マイ チャンネル登録] ページから発生した視聴回数。
YT_CHANNEL
- 視聴者が動画を視聴したチャンネル ページ。YT_OTHER_PAGE
- 視聴者が動画に誘導された YouTube ページ。YT_SEARCH
- 視聴者を動画に誘導した検索語句。VIDEO_REMIXES
- 視聴につながった動画。
例
以下のサンプル リクエストでは、トラフィック ソース ディメンションを使用しています。
チャンネルの例
-
トラフィック ソース
- 特定の国におけるトラフィック ソース別の再生回数および再生時間
- さまざまなトラフィック ソースからの 1 日あたりの視聴回数と総再生時間
- トップ 10 – 動画のトラフィックを最も多く生成した YouTube 検索キーワード
- 上位 10 個 - 動画のトラフィックを最も多く発生させた Google 検索キーワード
- 1 か国内のさまざまなトラフィック ソースからの再生リストの視聴回数と総再生時間
- トラフィック ソース別のプレイリストの 1 日あたりの視聴回数と総再生時間
-
トラフィック ソース
コンテンツ所有者の例
-
トラフィック ソース
- トラフィック ソース別の再生回数と再生時間
- さまざまなトラフィック ソースからの 1 日あたりの視聴回数と総再生時間
- トップ 10 – 動画のトラフィックを最も多く生成した YouTube 検索キーワード
- 上位 10 個 - 動画のトラフィックを最も多く発生させた Google 検索キーワード
- 1 か国内のさまざまなトラフィック ソースからの再生リストの視聴回数と総再生時間
- トラフィック ソース別のプレイリストの 1 日あたりの視聴回数と総再生時間
-
トラフィック ソース
デバイス
- deviceType
- このディメンションは、視聴が発生したデバイスの物理的なフォーム ファクタを識別します。
次のリストは、API がデータを返すデバイスタイプを示しています。
deviceType
ディメンションをフィルタとして使用し、オペレーティング システム レポートに特定の種類のデバイスのデータのみを含めることもできます。DESKTOP
GAME_CONSOLE
MOBILE
TABLET
TV
UNKNOWN_PLATFORM
- operatingSystem
- このディメンションは、視聴が発生したデバイスのソフトウェア システムを識別します。
次のリストは、API がデータを返すオペレーティング システムを示しています。
operatingSystem
をフィルタとして使用して、デバイス タイプ レポートに特定のオペレーティング システムのデータのみを含めることもできます。ANDROID
BADA
BLACKBERRY
CHROMECAST
DOCOMO
FIREFOX
HIPTOP
IOS
KAIOS
LINUX
MACINTOSH
MEEGO
NINTENDO_3DS
OTHER
PLAYSTATION
PLAYSTATION_VITA
REALMEDIA
SMART_TV
SYMBIAN
TIZEN
VIDAA
WEBOS
WII
WINDOWS
WINDOWS_MOBILE
XBOX
例
以下のサンプル リクエストでは、端末ディメンションを使用しています。
チャンネルの例
-
デバイス/OS
- Android オペレーティング システムの端末のタイプに関する日別の指標
- 携帯端末のオペレーティング システムに関する日別の指標
- オペレーティング システムと端末のタイプに関する日別の指標
- Android オペレーティング システムでの再生リストの視聴回数に関するデバイスの種類の 1 日あたりの指標
- モバイル デバイスでの再生リストの視聴回数に関する 1 日の OS 指標
-
デバイス/OS
コンテンツ所有者の例
-
デバイス/OS
- 申し立てが行われた動画の端末のタイプに関する日別の指標
- 申し立てが行われた動画が携帯端末で再生されたときのオペレーティング システムに関する日別の指標
- オペレーティング システムと端末のタイプに関する日別の指標
- Android オペレーティング システムでの再生リストの視聴回数に関するデバイスの種類の 1 日あたりの指標
- モバイル デバイスでの再生リストの視聴回数に関する 1 日の OS 指標
-
デバイス/OS
ユーザー属性
ユーザー属性のディメンションを使用すると、動画の視聴者の年齢層と性別を把握できます。YouTube Analytics レポートのユーザー属性データの詳細については、YouTube ヘルプセンターをご覧ください。
- ageGroup(コア ディメンション)
- このディメンションは、レポートデータに関連付けられているログイン ユーザーの年齢層を特定します。この API では、次の年齢グループが使用されます。
- age13-17
- age18-24
- age25-34
- age35-44
- age45-54
- age55-64
- age65-
- gender(コア ディメンション)
- このディメンションは、レポートデータに関連付けられているログイン ユーザーの性別を識別します。
有効な値は
female
、male
、user_specified
です。This is a core dimension and is subject to the Deprecation Policy.
例
以下のサンプル リクエストでは、ユーザー属性ディメンションを使用しています。
チャンネルの例
-
ユーザー属性
- カリフォルニア州の視聴者のユーザー属性(年齢層と性別)
- カリフォルニア州の再生リスト視聴者のユーザー属性(年齢層と性別)
-
ユーザー属性
コンテンツ所有者の例
-
ユーザー属性
- カリフォルニア州の視聴者のユーザー属性(年齢層と性別)
- カリフォルニア州の再生リスト視聴者のユーザー属性(年齢層と性別)
-
ユーザー属性
エンゲージメントとコンテンツの共有
- sharingService(コア ディメンション)
- このディメンションは、動画の共有に使用されたサービスを識別します。YouTube(または YouTube プレーヤー)で [共有] ボタンを使用して、動画を共有することができます。This is a core dimension and is subject to the Deprecation Policy.
次の表に、有効なディメンション値を示します。
共有サービス API 値 Ameba AMEBA
Android メール ANDROID_EMAIL
Android メッセージ ANDROID_MESSENGER
Android メッセージ ANDROID_MMS
BlackBerry Messenger BBM
Blogger BLOGGER
クリップボードにコピー COPY_PASTE
Cyworld CYWORLD
Digg DIGG
Dropbox DROPBOX
定着 EMBED
メール MAIL
Facebook FACEBOOK
Facebook Messenger FACEBOOK_MESSENGER
Facebook ページ FACEBOOK_PAGES
Fotka FOTKA
Gmail GMAIL
goo GOO
Google+ GOOGLEPLUS
Go SMS GO_SMS
GroupMe GROUPME
ハングアウト HANGOUTS
hi5 HI5
HTC のテキスト メッセージ HTC_MMS
Google 受信トレイ INBOX
iOS システム アクティビティ ダイアログ IOS_SYSTEM_ACTIVITY_DIALOG
KAKAO Story KAKAO_STORY
Kakao(KakaoTalk) KAKAO
Kik KIK
LGE メール LGE_EMAIL
線 LINE
LinkedIn LINKEDIN
LiveJournal LIVEJOURNAL
menéame MENEAME
mixi MIXI
Motorola Messaging MOTOROLA_MESSAGING
Myspace MYSPACE
Naver NAVER
ニアバイシェア NEARBY_SHARE
NUjij NUJIJ
Odnoklassniki(Одноклассники) ODNOKLASSNIKI
その他 OTHER
Pinterest PINTEREST
Rakuten(楽天市場) RAKUTEN
Google.com REDDIT
Skype SKYPE
Skyrock SKYBLOG
Sony Conversations SONY_CONVERSATIONS
StumbleUpon STUMBLEUPON
Telegram TELEGRAM
テキスト メッセージ TEXT_MESSAGE
Tuenti TUENTI
Tumblr です。 TUMBLR
Twitter TWITTER
不明 UNKNOWN
Verizon メッセージ VERIZON_MMS
Viber VIBER
VKontakte(ВКонтакте) VKONTAKTE
WeChat WECHAT
Weibo WEIBO
WhatsApp WHATS_APP
Wykop WYKOP
Yahoo! 日本 YAHOO
YouTube Gaming YOUTUBE_GAMING
YouTube Kids YOUTUBE_KIDS
YouTube Music YOUTUBE_MUSIC
YouTube TV YOUTUBE_TV
詳しくは、ヘルプ ドキュメントをご覧ください。
例
以下のサンプル リクエストでは、ソーシャル ディメンションを使用しています。
視聴者維持率
- elapsedVideoTimeRatio
- このディメンションでは、動画の再生時間と動画の長さの比率を指定します。維持率のディメンションと指標は、時間の経過に伴う視聴者維持率を測定するために使用されます。
elapsedVideoTimeRatio
ディメンションは時間の測定値です。たとえば、値が0.4
の場合、対応するレポートデータには、動画の 40% が経過した後の維持率データが表示されます。
この API は、比率値が0.01
~1.0
の動画ごとに 100 個のデータポイントを返します。動画の再生中にデータが測定されるタイミングは、動画ごとに均等に間隔が空いています。つまり、2 分間の動画の場合、データポイント間の間隔は 1.2 秒です。ただし、2 時間の動画の場合、データポイント間の間隔は 72 秒です。ディメンションの値は、区間の終了を示す値です。 - audienceType (フィルタのみ)
- ディメンションの値は、レポートデータに関連付けられたトラフィックのタイプを識別します。サポートされている値は
ORGANIC
、AD_INSTREAM
、AD_INDISPLAY
です。これらのトラフィック ソースの種類について詳しくは、YouTube ヘルプセンターをご覧ください。audienceType
フィルタのデータは 2013 年 9 月 25 日以降ご利用いただけます。API は、フィルタを使用して以前の日付のデータを取得しようとするクエリのデータは返しません。このフィルタを使用しないクエリは、2008 年 7 月 1 日以降の日付に対して機能します。
例
次のサンプル リクエストでは、オーディエンス維持率のディメンションを使用しています。
ライブ配信
- livestreamPosition
- このディメンションでは、ライブ動画配信中の特定の分を指定する。レポートの指標には、その時点でライブ配信を視聴していたユーザーの数が表示されます。
メンバーシップの解約
- membershipsCancellationSurveyReason
- レポート対象期間中に指定したチャンネルのチャンネル メンバーシップを解約した YouTube ユーザーが完了したアンケートの数。次の表に、有効なディメンション値を示します。
API 値 説明 UNKNOWN
ユーザーがアンケートを完了しなかった。 DISLIKE_PERKS
お客様はメンバーシップの特典に満足していなかった。 PERKS_NOT_DELIVERED
約束されたメンバーシップ特典が提供されていないとユーザーから報告があった。 CANNOT_ACCESS_PERKS
ユーザーが特典にアクセスできなかった。 NO_LONGER_INTERESTED
ユーザーがチャンネル メンバーシップに興味を失った。 FEEL_UNAPPRECIATED
ユーザーはチャンネル メンバーとして評価されていないと感じている。 FINANCIAL_REASONS
ユーザーが経済的な理由で解約した。 JOIN_LIMITED_TIME
ユーザーは限定的な期間のみ参加するつもりだった。 OTHER
お客様がキャンセルした理由が他にもある場合。
広告の掲載結果
- adType
adType
ディメンションは広告のパフォーマンス レポートで使用され、動画の再生中に配信された広告のタイプに基づいて、リクエストされた指標を集計します。 使用できるディメンション値は次のとおりです。YouTube の広告フォーマットについて詳しくは、YouTube ヘルプセンターをご覧ください。
-
auctionBumperInstream
- オークションで配置される、最長 6 秒のスキップ不可の動画広告で、最後まで再生しないと動画を視聴することができません。 -
auctionDisplay
- 動画プレーヤーの下部にオーバーレイとして、動画再生ページに 300x250 サイズの広告ユニットとして、またはその両方として表示されるリッチメディア広告または画像広告。オーバーレイの実行時に、一定時間表示された後に自動的に閉じますが、ユーザーが手動で閉じることもできます。オーバーレイとバナーが同時に表示された場合、各広告は個別のインプレッションとしてカウントされます。 -
auctionInstream
- メイン動画の前、途中、または後に再生されるスキップ不可の動画広告。 -
auctionTrueviewInslate
- 動画の前に表示される選択肢から、視聴者が複数の動画広告のいずれかを選択します。See the TrueView documentation for more information. -
auctionTrueviewInstream
- メイン動画の再生前または再生中に配信されるスキップ可能な動画広告。 詳しくは、TrueView のドキュメントをご覧ください。 -
auctionUnknown
- AdWords オークションで購入された広告で、他の広告タイプに分類されていない広告。 -
reservedBumperInstream
- 純広告として販売される、最長 6 秒のスキップ不可の動画広告で、最後まで再生しないと動画を視聴することができません。 -
reservedClickToPlay
- 再生を開始するにはユーザーがクリックする必要がある動画広告。広告のインプレッションは、ユーザーが再生を開始するかどうかに関係なく、Click-to-Play 広告が表示されるたびに記録されます。これらの広告は予約ベースで販売されます。 -
reservedDisplay
- 動画プレーヤーの下部にオーバーレイとして、動画再生ページに 300x250 サイズの広告ユニットとして、またはその両方として表示されるリッチメディア広告または画像広告。オーバーレイの実行時に、一定時間表示された後に自動的に閉じますが、ユーザーが手動で閉じることもできます。オーバーレイとバナーが同時に表示された場合、各広告は個別のインプレッションとしてカウントされます。 -
reservedInstream
- メイン動画の再生前、途中、後に挿入されるスキップ不可の動画広告。 -
reservedInstreamSelect
-
reservedMasthead
- ホームページに表示される大きな広告。動画やグラフィック要素を含めることができます。 -
reservedUnknown
- 予約ベースで販売された広告で、他の広告タイプに分類できないもの。 -
unknown
- YouTube でこの広告タイプを分類できませんでした。
-
例
次のサンプル レポートは、広告のパフォーマンスまたは収益の指標を取得します。
チャンネルの例
-
収益/広告
- チャンネルの収益と広告のパフォーマンスに関する指標
- 1 日の収益と広告のパフォーマンスに関する指標
- 国別の収益と広告のパフォーマンスに関する指標
- トップ 10 - 収益額が最も高い動画
- 広告タイプ別の広告の掲載結果の指標
-
収益/広告
コンテンツ所有者の例
-
収益/広告
- 申し立てを受けたコンテンツの収益と広告のパフォーマンスに関する指標
- 1 日の収益と広告のパフォーマンスに関する指標
- 国別の収益と広告のパフォーマンスに関する指標
- トップ 10 - 収益額が最も高い動画
- 広告タイプ別の広告の掲載結果の指標
-
収益/広告
コンテンツ所有者ディメンション
以下のディメンションは、コンテンツ所有者レポートでのみサポートされています。
- claimedStatus(コンテンツ所有者レポートでのみ使用)
- このディメンションでは、API レスポンスに申し立て対象のコンテンツの指標のみを含めるように指定できます。このディメンションで有効な値は
claimed
のみです。filters
パラメータでクエリをclaimedStatus==claimed
に制限すると、API は申し立て対象のコンテンツのデータのみを取得します。uploaderType
ディメンションの定義の表に、このディメンションの使用方法の詳細が記載されています。
- uploaderType(コア ディメンション)(コンテンツ所有者のレポートでのみ使用)
- このディメンションを使用すると、API レスポンスに、指定したコンテンツ所有者によってアップロードされたコンテンツや、サードパーティによってアップロードされたコンテンツ(ユーザーがアップロードした動画など)の指標を含めるかどうかを指定できます。有効な値は
self
とthirdParty
です。これはコア ディメンションで、非推奨ポリシーが適用されます。
次の表に、claimedStatus
ディメンションとuploaderType
ディメンションのサポートされている組み合わせを示します。どちらもfilters
パラメータで使用されます。
claimedStatus
値uploaderType
値説明 [未設定] self コンテンツ所有者がアップロードした申し立て対象のコンテンツと申し立て対象外のコンテンツの YouTube アナリティクス データを取得します。 申し立て済み [未設定] コンテンツ所有者または第三者によってアップロードされた申し立て対象のコンテンツのデータが取得されます。 申し立て済み self コンテンツ所有者がアップロードした申し立てを受けたコンテンツのデータが取得されます。 申し立て済み thirdParty 第三者によってアップロードされた申し立て対象のコンテンツのデータが取得されます。
例
コンテンツ所有者レポートのサンプル API リクエストの多くは、claimedStatus
ディメンションと uploaderType
ディメンションのサポートされている組み合わせを使用してデータをフィルタします。