このドキュメントでは、YouTube Analytics API でサポートされているディメンションを定義します。この API は、ターゲットを絞り込んだリアルタイム クエリに対応し、カスタムの YouTube アナリティクス レポートを生成できます。
ディメンションは、ユーザー アクティビティが発生した日付やユーザーが所在する国など、データを集計するために使用される一般的な条件です。
各クエリ レポートは、サポートするディメンションを識別します。たとえば、ユーザー アクティビティを時間別に取得する場合は、データをレポートする期間(日または月)を選択します。どのレポートでも、データ行にはディメンション値の一意の組み合わせが含まれています。
クエリ レポートを取得するには、YouTube Analytics API の reports.query
メソッドを呼び出します。リクエストで dimensions
パラメータを使用して、YouTube がレポートの指標値を計算するために使用するディメンションを指定します。
主要なディメンション
YouTube アナリティクス API は、利用規約で定義されている非推奨ポリシーの対象となりますが、非コア ディメンション(および非コア指標)はポリシーの対象外です。このページの定義では、コア ディメンションであるディメンションはすべて明示的に識別されます。
API のコア ディメンションは次のとおりです。
詳しくは、非推奨ポリシーが適用される YouTube API のリストをご覧ください。
フィルタ
すべてのクエリ レポートでフィルタがサポートされています。フィルタは、取得したデータセットに存在する必要があるディメンション値を特定します。そのため、API レスポンスは、特定の値または値のセットに一致するデータのみを含むように制限されます。たとえば、すべての国のユーザー アクティビティ指標を取得する代わりに、フィルタを使用して特定の国のデータのみを取得できます。
クエリ レポートを取得するリクエストでは、省略可能な filters
リクエスト パラメータで、データをフィルタするディメンション値を指定します。たとえば、ヨーロッパのユーザー アクティビティ指標を取得するには、filters
パラメータの値を continent==150
に設定します。
重要: コンテンツ所有者のレポートを取得する API リクエストでは、レポート エンティティのディメンションのいずれかを使用するか、claimedStatus
ディメンションと uploaderType
ディメンションのサポートされている組み合わせを使用して、データをフィルタする必要があります。
サイズ
以降のセクションでは、YouTube アナリティクス API のクエリ レポートで使用されるディメンションを定義します。特に記載のない限り、これらのディメンションはチャンネル レポートとコンテンツ所有者レポートの両方で使用されます。フィルタとしてのみ使用できるディメンションも識別されます。
リソース
これらのディメンションは、チャンネルとコンテンツ所有者が YouTube で管理するリソースに対応しています。
注: API では、video
、playlist
、channel
の各ディメンションをフィルタとして使用する場合に、複数の値を指定できます。これを行うには、filters
パラメータの値を、API レスポンスをフィルタする動画、再生リスト、チャンネルの 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
ディメンションは、コンテンツ所有者のレポートでよく使用されます。これは、コンテンツ所有者のレポートでは通常、複数のチャンネルのデータが集計されるためです。 - グループ (フィルタのみ)
- YouTube アナリティクス グループの ID。この値は、YouTube アナリティクス 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-1 国コードもあるため、このディメンションでは、米国の海外領土を識別する ISO 3166-2 値はサポートされていません。また、米国以外の国の地域区分もサポートされていません。
- 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
に設定し、国連のリストからREGION_CODE
の値を指定します。
例
次のサンプル リクエストでは、地域に関するディメンションまたはフィルタを使用しています。
チャンネルの例
- 基本統計情報: チャンネルの国別の視聴回数(など)
-
地域
- チャンネルの動画の国別再生時間の指標
- チャンネルの動画のアノテーションに関する国別の指標
- 米国の州とワシントン DC の州固有の指標。
- チャンネルの再生リストの国別視聴時間指標
- 上位 10 件 - 米国で最も多く作成されたプレイリスト
- 再生場所: さまざまな再生場所からの毎日の視聴回数と視聴時間
- トラフィック ソース: ある国のさまざまなトラフィック ソースからの視聴回数と総再生時間
- ユーザー属性: カリフォルニア州の視聴者のユーザー属性(年齢層と性別)
-
人気の動画
- トップ 10 – 特定の国における再生回数が多い動画
- トップ 10 - ヨーロッパで最も視聴された動画
コンテンツ所有者の例
- 基本的な統計情報: 自分でアップロードしたすべての動画の国別の視聴回数など
-
地域
- 自身がアップロードしたコンテンツの国別再生時間の指標
- 自身がアップロードしたコンテンツのアノテーションに関する国別の指標
- 米国の州とワシントン DC の州固有の指標。
- コンテンツ所有者のプレイリストの国別視聴時間指標
- 上位 10 件 - 米国で最も多く作成されたプレイリスト
- 再生場所: さまざまな再生場所からの毎日の視聴回数と視聴時間
- ユーザー属性: カリフォルニア州の視聴者のユーザー属性(年齢層と性別)
- 人気の動画: 上位 10 本 - ヨーロッパで最も視聴されたコンテンツ所有者の動画
- 収益/広告のパフォーマンス: 国別の収益と広告のパフォーマンスに関する指標
期間
これらのディメンションは、レポートで日、週、月などの期間に基づいてデータを集計する必要があることを示します。startDate
と endDate
のリクエスト パラメータは、レポートにデータを含める期間を指定します。実際には、リクエストで指定されたすべての指標がクエリの実行時に利用可能である最終日までのデータがレポートで返されます。レポートでは、日付は YYYY-MM-DD
形式で表示されます。
重要: すべての日付は、指定された日、月、年の太平洋時間(UTC-7 または UTC-8)の午前 12 時から午後 11 時 59 分までの期間を指します。そのため、夏時間で時計が進められる日付は 23 時間の期間を表し、時計が戻される日付は 25 時間の期間を表します。
[月] ディメンションは、指定した月と年の初日の午前 12 時(太平洋時間(UTC-7 または UTC-8))から始まる期間を指します。
- 日 (コア ディメンション)
- このディメンションを使用すると、レポートのデータは日単位で集計され、各行には 1 日分のデータが含まれます。他のディメンションを使用して、データをさらに細かく分類することもできます。たとえば、トラフィック ソース レポートでは、ユーザーが動画にアクセスした方法に基づいて、1 日あたりの視聴回数の統計情報を集計できます。This is a core dimension and is subject to the Deprecation Policy.
- month (コア ディメンション)
- レポートのデータは、暦月ごとに集計されます。日次レポートと同様、他のフィルタを使用してデータをさらに細かく分類することができます。レポートでは、日付は
YYYY-MM
形式で表示されます。
注: API クエリでmonth
ディメンションを使用する場合は、start-date
パラメータとend-date
パラメータの両方を月の初日に設定する必要があります。This is a core dimension and is subject to the Deprecation Policy.
例
次のサンプル リクエストでは、時間ディメンションまたはフィルタを使用します。
チャンネルの例
-
時間ベース
- チャンネルの動画の日別再生時間の指標
- チャンネルの動画のアノテーションに関する日別の指標
- チャンネルの 1 日の再生リストの視聴回数
- 再生場所: さまざまな再生場所からの毎日の視聴回数と視聴時間
- トラフィック ソース: さまざまなトラフィック ソースからの 1 日あたりの視聴回数と総再生時間
-
デバイス/OS
- Android オペレーティング システムの端末のタイプに関する日別の指標
- 携帯端末のオペレーティング システムに関する日別の指標
- オペレーティング システムと端末のタイプに関する日別の指標
-
時間ベース
コンテンツ所有者の例
-
時間ベース
- 自身がアップロードしたコンテンツの日別再生時間の指標
- 申し立てが行われたコンテンツのアノテーションに関する指標
- コンテンツ所有者の 1 日の再生リストの視聴回数
- 再生場所: さまざまな再生場所からの毎日の視聴回数と視聴時間
- トラフィック ソース: さまざまなトラフィック ソースからの 1 日あたりの視聴回数と総再生時間
-
デバイス/OS
- 申し立てが行われた動画の端末のタイプに関する日別の指標
- 申し立てが行われた動画が携帯端末で再生されたときのオペレーティング システムに関する日別の指標
- オペレーティング システムと端末のタイプに関する日別の指標
- 収益/広告のパフォーマンス: 日別の収益と広告のパフォーマンスに関する指標
-
時間ベース
再生場所
これらのディメンションでは、ユーザー アクティビティが発生したページやアプリに関する分析情報を確認できます。
- 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 Android アプリなどの YouTube 公式アプリで発生した視聴回数を表します。 -
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
- ショート動画の視聴画面で前の動画から縦方向にスワイプして視聴者が移動した。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
- ポッドキャストのリンク先ページのアイテムから発生した視聴回数。sdig
- チャンネル登録の更新メールからの視聴回数。uploaded
- トップページの登録チャンネル フィードに表示されたuploaded
アイテムからの再生回数。/
- YouTube のトップページから発生したその他の視聴回数。/my_subscriptions
- YouTube の [チャンネル登録] ページから発生した視聴回数。
YT_CHANNEL
- 視聴者が動画を視聴したチャンネル ページ。YT_OTHER_PAGE
- 視聴者が動画にアクセスした YouTube ページ。YT_SEARCH
- 視聴者を動画に誘導した検索キーワード。VIDEO_REMIXES
- 視聴回数につながった動画。
例
以下のサンプル リクエストでは、トラフィック ソース ディメンションを使用しています。
チャンネルの例
-
トラフィック ソース
- 特定の国におけるトラフィック ソース別の再生回数および再生時間
- さまざまなトラフィック ソースからの毎日の視聴回数と総再生時間
- トップ 10 – 動画のトラフィックを最も多く生成した YouTube 検索キーワード
- 上位 10 個 - 動画へのトラフィックを最も多く生み出している Google 検索キーワード
- ある国のさまざまなトラフィック ソースからの再生リストの視聴回数と総再生時間
- さまざまなトラフィック ソースからの毎日の再生リストの視聴回数と総再生時間
-
トラフィック ソース
コンテンツ所有者の例
-
トラフィック ソース
- トラフィック ソース別の再生回数と再生時間
- さまざまなトラフィック ソースからの毎日の視聴回数と総再生時間
- トップ 10 – 動画のトラフィックを最も多く生成した YouTube 検索キーワード
- 上位 10 個 - 動画へのトラフィックを最も多く生み出している Google 検索キーワード
- ある国のさまざまなトラフィック ソースからの再生リストの視聴回数と総再生時間
- さまざまなトラフィック ソースからの毎日の再生リストの視聴回数と総再生時間
-
トラフィック ソース
デバイス
- deviceType
- このディメンションは、視聴が発生したデバイスの物理的なフォーム ファクタを識別します。次のリストは、API がデータを返すデバイスタイプを示しています。
deviceType
ディメンションをフィルタとして使用して、特定のタイプのデバイスのデータのみを含むようにオペレーティング システム レポートを制限することもできます。DESKTOP
GAME_CONSOLE
MOBILE
TABLET
TV
AUTOMOTIVE
WEARABLE
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 日の指標
-
デバイス/OS
コンテンツ所有者の例
-
デバイス/OS
- 申し立てが行われた動画の端末のタイプに関する日別の指標
- 申し立てが行われた動画が携帯端末で再生されたときのオペレーティング システムに関する日別の指標
- オペレーティング システムと端末のタイプに関する日別の指標
- Android オペレーティング システムでのプレイリストの視聴に関するデバイスタイプの毎日の指標
- モバイル デバイスでのプレイリストの視聴に関するオペレーティング システム別の 1 日の指標
-
デバイス/OS
ユーザー属性
ユーザー属性ディメンションを使用すると、視聴者の年齢層と性別の分布を把握できます。YouTube ヘルプセンターには、YouTube Analytics レポートのユーザー属性データに関する詳細情報が記載されています。
- 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 Messenger 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 INBOX
iOS システム アクティビティ ダイアログ IOS_SYSTEM_ACTIVITY_DIALOG
KAKAO Story KAKAO_STORY
Kakao(Kakao Talk) 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
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 は、各動画に対して 100 個のデータポイントを返します。比率の値は0.01
から1.0
の範囲です。動画の再生中にデータが測定されるタイミングは、動画ごとに均等に配置されます。つまり、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
- 動画プレーヤーの下部にオーバーレイとして表示されるリッチメディア広告または画像広告、動画再生ページの 300×250 の広告ユニット、またはその両方の組み合わせ。オーバーレイの実行時に、一定時間表示された後に自動的に閉じますが、ユーザーが手動で閉じることもできます。オーバーレイとバナーが同時に表示された場合、各広告は個別のインプレッションとしてカウントされます。 -
auctionInstream
- メイン動画の再生前、再生中、再生後に再生されるスキップ不可の動画広告。 -
auctionTrueviewInslate
- 動画の前に表示される選択肢の中から、視聴者が複数の動画広告のいずれかを選択します。See the TrueView documentation for more information. -
auctionTrueviewInstream
- メイン動画の再生前または途中に挿入されるスキップ可能な動画広告です。詳しくは、TrueView のドキュメントをご覧ください。 -
auctionUnknown
- AdWords オークションで購入されたものの、他の広告タイプに分類されていない広告。 -
reservedBumperInstream
- 最長 6 秒のスキップ不可の動画広告で、最後まで再生しないと動画を視聴することができません。純広告として販売されます。 -
reservedClickToPlay
- ユーザーがクリックして再生を開始する必要がある動画広告。広告のインプレッションは、ユーザーが再生を開始するかどうかに関係なく、Click-to-Play 広告が表示されるたびに記録されます。これらの広告は予約ベースで販売されます。 -
reservedDisplay
- 動画プレーヤーの下部にオーバーレイとして表示されるリッチメディア広告または画像広告、動画再生ページの 300×250 の広告ユニット、またはその両方の組み合わせ。オーバーレイの実行時に、一定時間表示された後に自動的に閉じますが、ユーザーが手動で閉じることもできます。オーバーレイとバナーが同時に表示された場合、各広告は個別のインプレッションとしてカウントされます。 -
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
ディメンションのサポートされている組み合わせを使用してデータをフィルタしています。