このドキュメントでは、YouTube Reporting API でサポートされるディメンションを定義します。この API は、チャンネルまたはコンテンツ所有者の YouTube アナリティクス データを含む一括レポートを取得します。
ディメンションとは、ユーザー アクションが発生した日付やユーザーが所在する国など、データの集計に使用される一般的な条件です。
各一括レポートでは、事前定義されたディメンションのリストがサポートされており、どのレポートでも、データの各行にディメンション値の組み合わせが一意になります。そのため、各行のディメンション値の組み合わせが、その行の主キーとして機能します。レポートに含めるディメンションを指定する必要も、指定するオプションもありません。
コア ディメンション
YouTube Reporting API には利用規約に定められているサポート終了ポリシーが適用されますが、コア以外のディメンション(およびコア以外の指標)にはこのポリシーは適用されません。このページの定義では、コア ディメンションであるすべてのディメンションが明示的に示されています。
次のリストは、API のコア ディメンションを示しています。これらはすべて YouTube Analytics API の主要なディメンションでもあります。
詳しくは、非推奨ポリシーの対象となる YouTube API のリストをご覧ください。
ディメンション
以下のセクションでは、YouTube Reporting API の一括レポートで使用されるディメンションについて説明します。特に断りのない限り、これらのディメンションはチャンネル レポートとコンテンツ所有者レポートの両方で使用されます。
リソース
以下のディメンションは、チャンネルとコンテンツ所有者が YouTube で管理するリソースに対応しています。
- video_id(コア ディメンション)
- YouTube 動画の ID。YouTube Data API では、これは
video
リソースのid
プロパティの値です。This is a core dimension and is subject to the Deprecation Policy. - playlist_id
- YouTube 再生リストの ID。YouTube Data API では、これは
playlist
リソースのid
プロパティの値です。 - channel_id(コア ディメンション)
- YouTube チャンネルの ID。YouTube Data API では、これは
channel
リソースのid
プロパティの値です。This is a core dimension and is subject to the Deprecation Policy. - asset_id(コンテンツ所有者レポートでのみ使用)
- YouTube の Content ID システムで管理されているアセットの ID。アセットとは、そのシステムにある知的財産を表します。YouTube ウェブサイトのアセット ID は、YouTube コンテンツ マネージャで確認できます。YouTube Content ID API を使用して取得することもできます。
地理的エリア
これらのディメンションにより、ユーザーのアクション、広告のパフォーマンス、推定収益の指標に関連する地域を特定できます。
- country_code(コア ディメンション)
- レポートの行の指標に関連付けられている国。ディメンション値は、
US
、CN
(中国)、FR
(フランス)などの 2 文字の ISO-3166-1 国コードです。国コードZZ
は、関連する国を YouTube が特定できなかった指標を報告するために使用されます。This is a core dimension and is subject to the Deprecation Policy. - province_code
- レポートの行の指標に関連付けられている米国の州または地域。ディメンション値は、米国の州またはコロンビア特別区を識別する ISO 3166-2 コードです(例:
US-MI
(ミシガン)、US-TX
(テキサス))。州コードUS-ZZ
は、関連する米国の州を YouTube が特定できなかった指標を報告するために使用されます。注: このディメンションでは、米国海外領土を指定する ISO 3166-2 値はサポートされていません。これらの地域には独自の ISO 3166-1 国コードがあるためです。また、米国以外の国の区分もサポートしていません。
期間
- 日付 (コア ディメンション)
- このディメンションでは、レポートの各行の指標に関連付けられている日付を確認できます。一括レポートにおける日付とは、太平洋時間午前 0 時に開始し、指定した日、月、年の午後 11 時 59 分に終わる期間を指します。太平洋時間は UTC-7 または UTC-8 です(時期によって異なります)。
通常、日付は 24 時間を表しますが、夏時間によって時計が前方調整される日付は 23 時間、時計が逆方向に調整される日付は 25 時間を表します。 This is a core dimension and is subject to the Deprecation Policy.
再生場所
これらのディメンションにより、ユーザー アクションが発生したページまたはアプリケーションに関する分析情報が得られます。
- playback_location_type
-
このディメンションは、ユーザー アクションが発生したページまたはアプリケーションのタイプを識別します。次の表にディメンション値を示します。
値 0
このデータは、動画の YouTube 動画再生ページや公式 YouTube アプリ(Android 向け YouTube アプリなど)で発生したアクティビティに関するものです。 1
このデータは、 <iframe>
または<object>
の埋め込みによって動画が埋め込まれている別のウェブサイトまたはアプリケーションで発生したアクティビティに関連するものです。2
このデータは、YouTube チャンネル ページで発生したアクティビティに関するものです。 5
データが、上記の他の地域タイプのいずれかに分類できない指標に関連しています。 7
このデータは、YouTube のトップページやホーム画面、ユーザーの登録チャンネル フィード、YouTube の別のブラウジング機能で行われた視聴に関連するものです。 8
このデータは、YouTube 検索結果ページで直接発生した視聴回数に関するものです。 10
このデータは YouTube ショート フィードで発生した視聴回数に関するデータです。 - playback_location_detail
- このディメンションでは、再生が発生した URL またはアプリケーションを指定します。このディメンションは、埋め込みプレーヤーで発生した視聴でのみサポートされています。つまり、ディメンションの値は、ディメンションの値が
1
の行にのみ入力されます。他の行では、このディメンションの値は空です。
再生の詳細
- live_or_on_demand
- このディメンションは、データ行のユーザー アクティビティ指標が、ライブ配信の視聴に関連付けられているかどうかを示します。このディメンションには、2014 年 4 月 1 日以降のデータを使用できます。
次の表にディメンション値を示します。
値 live
行のデータは、ライブ配信中に発生したユーザー アクティビティを表します。 onDemand
行のデータには、ライブ配信中に発生しなかったユーザー アクションが示されます。 - subscribed_status
- このディメンションは、データ行のユーザー アクティビティ指標が、動画または再生リストのチャンネルに登録している視聴者に関連付けられているかどうかを示します。
有効な値は
subscribed
とunsubscribed
です。
なお、ディメンションの値は、ユーザー アクションが発生した時点で正確です。たとえば、あるチャンネルに登録していないユーザーが、そのチャンネルの動画を 1 つ視聴してから、そのチャンネルに登録し、同じ日に別の動画を視聴したとします。 チャネルのレポートによると、1 つのビューのsubscribed_status
値はsubscribed
で、もう 1 つのビューのsubscribed_status
値はunsubscribed
です。
トラフィック ソース
- traffic_source_type
- このディメンションは、ユーザー アクションの指標に関連付けられている参照 URL タイプを識別します。リファラー タイプは、レポート内のデータ行に関連付けられた動画またはチャンネルにユーザーがアクセスした方法を表します。次の表にディメンション値を示します。
値 0
ノーリファラーまたは不明
この値は、特定のページへのノーリファラーと、参照 URL が不明なページへのノーリファラーを含みます。クエリレポートでは、このトラフィック ソースタイプはNO_LINK_OTHER
またはUNKNOWN_MOBILE_OR_DIRECT
と表示されます。1
YouTube 広告
視聴者が広告によって動画を参照した場合。トラフィック ソース レポートでは、このディメンションの値が1
の場合、traffic_source_detail のディメンションによって、視聴者に表示された広告のタイプを識別できます。クエリレポートでは、このトラフィック ソースタイプはADVERTISING
となります。有効な値は次のとおりです。値 ctp_engagement_ad
Click-to-Play エンゲージメント広告 engagement_ad
エンゲージメント促進広告 googlemediaads
Google 検索広告 insearch_display
TrueView インサーチとインディスプレイ instream
TrueView インストリーム instream-select
予約済みのスキップ可能なインストリーム unknown
該当カテゴリのない YouTube 広告 video_wall
サムネイル表示 yva
トップページ YVA 3
ブラウジング機能
動画やチャンネルに誘導する YouTube ページから視聴者が参照された場合。トラフィック ソース レポートでは、このディメンションの値が3
の場合、traffic_source_detail ディメンションで、トラフィックの参照元となった特徴が特定されます。クエリレポートでは、このトラフィック ソースタイプはSUBSCRIBER
となります。有効な値は次のとおりです。値 explore
Kids: 探索 learning
Kids: 学習 music
音楽フィード my-history
再生履歴 my-subscriptions
定期購入 my-uploads
マイ アップロード podcasts
ポッドキャストのリンク先ページ shows
Kids: 番組 watch-later
後で見る what-to-watch
あなたへのおすすめ 4
YouTube チャンネル
YouTube チャンネル ページからの視聴者です。トラフィック ソース レポートでは、このディメンションの値が4
の場合、traffic_source_detail ディメンションがそのチャネルのチャネル ID を示します。クエリレポートでは、このトラフィック ソースタイプはYT_CHANNEL
となります。5
YouTube 検索
視聴者は YouTube の検索結果から参照されました。トラフィック ソース レポートでは、このディメンションの値が5
の場合、traffic_source_detail のディメンションに関連する検索語句が指定されます。クエリレポートでは、このトラフィック ソースタイプはYT_SEARCH
となります。7
関連動画
視聴者が別の動画再生ページの関連動画リストから参照された場合。トラフィック ソース レポートでは、このディメンションの値が7
の場合、traffic_source_detail のディメンションがその動画の動画 ID を示します。クエリレポートでは、このトラフィック ソースタイプはRELATED_VIDEO
またはYT_RELATED
と表示されます。8
その他の YouTube 機能
視聴者は、記載されている他のトラフィック ソースの種類に当てはまらない YouTube ページから参照されています。トラフィック ソース レポートでは、このディメンションの値が8
の場合、traffic_source_detail ディメンションでページの URL が識別されます。クエリレポートでは、このトラフィック ソースタイプはYT_OTHER_PAGE
となります。有効な値は次のとおりです。値 g-crec
おすすめのチャンネル offline
オフライン promotion
パートナー プロモーション unknown
不明 widget
Android ホーム画面ウィジェット youtu.be
youtu.be ytremote
YouTube リモコン 9
外部サイト
別のウェブサイトのリンクから参照された視聴者です。このトラフィック ソースには、Google 検索結果からの参照も含まれます。トラフィック ソース レポートでは、このディメンションの値が9
の場合、traffic_source_detail ディメンションが外部ウェブページを識別します。クエリレポートでは、このトラフィック ソースタイプはEXT_URL
となります。11
動画カードとアノテーション
視聴者が別の動画のアノテーションまたはカードをクリックして参照された場合。クエリレポートでは、このトラフィック ソースタイプはANNOTATION
となります。14
再生リスト
再生リストの一部として動画が再生されている最中に発生した視聴回数です。クエリレポートでは、このトラフィック ソースの種類はPLAYLIST
として識別されます。
このトラフィック ソースはソースタイプ18
とは異なります。これは、再生リスト内のすべての動画がリストされているページで視聴されたことを示しています。17
通知
視聴者がメールまたは YouTube からの通知から参照した場合。クエリレポートでは、このトラフィック ソースタイプはNOTIFICATION
となります。有効な値は次のとおりです。値 inbox
push
sdig
チャンネル登録者のダイジェストに含まれる通知から発生した視聴回数 uploaded_other
動画のアップロード時にチャンネル登録者に送信される、プッシュ通知以外の通知(メールや受信トレイ通知など)から発生した視聴回数 uploaded_push
動画のアップロード時にチャンネル登録者に送信されたプッシュ通知から発生した視聴回数 18
再生リストページ
再生リスト内のすべての動画を一覧表示するページから発生した視聴です。クエリレポートでは、このトラフィック ソース タイプはYT_PLAYLIST_PAGE
として識別されます。
このトラフィック ソースはソースタイプ14
とは異なります。このトラフィック ソースは、動画が再生リストの一部として再生されている間に視聴されたことを示します。19
申し立てを受けたコンテンツからの番組編成
ユーザーがアップロードした、申し立てが行われた動画から発生した視聴回数は、コンテンツ所有者が視聴したコンテンツの宣伝に使用しました。クエリレポートでは、このトラフィック ソースはCAMPAIGN_CARD
と表示されます。このトラフィック ソースはコンテンツ所有者レポートでのみサポートされています。20
インタラクティブな動画終了画面
別の動画の終了画面から発生した視聴回数。クエリレポートでは、このトラフィック ソースタイプはEND_SCREEN
となります。23
ストーリー
ストーリーの表示画面で、視聴者が前の動画から縦にスワイプすることで参照された場合。24
ショート
YouTube ショートの視聴中に、前の動画から縦にスワイプすることで視聴者が参照されました。25
商品ページ
商品ページの動画で、視聴者を別のチャンネルに誘導します。26
ハッシュタグ ページ
VOD のハッシュタグ ページまたはショート動画のハッシュタグ ピボットページから発生した視聴回数。27
サウンドページ
ショート動画のサウンド ピボット ページから発生した視聴回数。28
ライブ リダイレクト
ライブ リダイレクトから発生した視聴。30
リミックス動画
YouTube ショート プレーヤーのリミックス動画リンクから発生した視聴回数。31
縦型ライブ配信フィード
縦型ライブ配信フィードからの視聴回数。32
関連動画
YouTube ショート プレーヤーの関連動画リンクから発生した視聴回数。 - traffic_source_detail
- このディメンションでは、行の traffic_source_type ディメンション値によって、トラフィック ソースに関する詳細情報を確認できます。このディメンション値は、次の traffic_source_type ディメンションの値に入力されます。
1
– ディメンション値は、視聴者に表示された広告の種類を識別します。設定可能な値のリストについては、traffic_source_type の定義をご覧ください。3
– ディメンション値は、参照トラフィックにつながった YouTube の対象物を示します。設定可能な値のリストについては、traffic_source_type の定義をご覧ください。4
– ディメンション値で、視聴者の参照元のチャンネル ID を指定します。5
– ディメンション値で、参照トラフィックにつながった検索語句を指定します。7
– ユーザーが参照した動画を識別するディメンション値。8
– ディメンション値は、参照トラフィックの発生元となった YouTube ページの種類を示します。設定可能な値のリストについては、traffic_source_type の定義をご覧ください。9
– ディメンション値で、トラフィックの参照元となった外部ページを識別します。17
– ディメンション値で、参照トラフィックにつながった通知の種類を識別します。設定可能な値のリストについては、traffic_source_type の定義をご覧ください。19
– ユーザーが参照した動画を識別するディメンション値。20
– ユーザーが参照した動画を識別するディメンション値。25
– ディメンション値で商品 ID(Google ナレッジグラフ ID)を識別します。26
– ディメンション値は、参照トラフィックにつながったハッシュタグを示します。27
– ユーザーが参照した動画を識別するディメンション値。28
– ディメンション値には、ライブ リダイレクトによる視聴者の参照元のチャンネル ID を指定します。30
– ディメンション値で、視聴者の参照元の動画を指定します。
デバイス
- device_type
- このディメンションは、視聴が発生したデバイスの物理的なフォーム ファクタを示します。
次の表に、有効なディメンション値を示します。
値 100
不明 101
パソコン 102
テレビ 103
ゲーム機 104
携帯電話 105
タブレット - operating_system
- このディメンションは、視聴が発生したデバイスのソフトウェア システムを示します。
次の表に、有効なディメンション値を示します。
値 1
Other 2
ウィンドウ 3
Windows Mobile 4
Android 5
iOS 6
Symbian 7
Blackberry 9
Macintosh 10
PlayStation 11
Bada 12
WebOS 13
Linux 14
Hiptop 15
MeeGo 16
Wii 17
Xbox 18
PlayStation Vita 19
スマートテレビ 20
ニンテンドー 3DS 21
Chromecast 22
Tizen 23
Firefox 24
RealMedia 25
KaiOS 26
Roku 27
Nintendo Switch 28
Apple tvOS 29
Fire OS 30
ChromeOS 31
Vidaa
ユーザー属性
ユーザー属性ディメンションを使用すると、視聴者の年齢層と性別分布を把握できます。YouTube Analytics レポートのユーザー属性データについて詳しくは、YouTube ヘルプセンターをご覧ください。
- age_group(コア ディメンション)
- このディメンションは、レポートデータに関連付けられたログイン ユーザーの年齢層を示します。この API では、次の年齢層が使用されます。
AGE_13_17
AGE_18_24
AGE_25_34
AGE_35_44
AGE_45_54
AGE_55_64
AGE_65_
- gender(コア ディメンション)
- このディメンションでは、レポートデータに関連付けられているログイン ユーザーの性別がわかります。
有効な値は
FEMALE
、MALE
、GENDER_OTHER
です。This is a core dimension and is subject to the Deprecation Policy.
エンゲージメントとコンテンツの共有
- sharing_service (コア ディメンション)
- このディメンションは、動画の共有に使用されたサービスを識別します。YouTube(または YouTube プレーヤー)で [共有] ボタンを使用して、動画を共有することができます。This is a core dimension and is subject to the Deprecation Policy.
有効なディメンション値を次の表に示します。
値 0
不明 1
Digg 4
Google.com 5
StumbleUpon 6
mixi 7
Yahoo! 日本 8
goo 9
Ameba 10
Facebook 11
Myspace 12
NUjij 18
トゥエンティ 20
メネアーム 21
ウィコップ 22
スカイロック 25
フォトカ 28
hi5 31
Twitter 32
サイワールド 34
Blogger 36
VKontakte(取り込み方法を考える) 37
楽天市場 38
LiveJournal 39
Odnoklassniki(オドノクラスニキ) 40
tumblr. 42
LinkedIn 43
Google+ 44
Weibo 45
Pinterest 46
メールアドレス 47
Facebook Messenger 49
WhatsApp 50
ハングアウト 51
Gmail 52
Kakao(Kakao Talk) 53
Other 55
クリップボードにコピー 59
Embed 60
テキスト メッセージ 61
Android のメッセージ機能 62
Verizon のメッセージ 63
HTC テキスト メッセージ 64
Sony Conversations 65
SMS を利用 66
LGE メール 67
線 68
Viber 69
Kik 70
Skype 71
Blackberry Messenger 72
WeChat 73
KAKAO のストーリー 74
Dropbox 75
Telegram 76
Facebook ページ 77
GroupMe 78
Android メール 79
Motorola のメッセージ 80
ニアバイシェア 81
Naver 82
iOS システム アクティビティ ダイアログ 83
Google 受信トレイ 84
Android メッセンジャー 85
YouTube Music 86
のヒント 87
YouTube Kids 88
YouTube TV
詳しくは、ヘルプ ドキュメントをご覧ください。
アノテーション
- annotation_type
- このディメンションは、動画中にアノテーションをどのように表示するかを示します。次の表に、有効なディメンション値を示します。
値 0
不明 1
注 3
スポットライト 4
タイトル 8
吹き出し 9
ラベル 10
画像・ロゴの透かし 11
おすすめ動画 12
おすすめのプレイリスト 30
今後実施すること - annotation_id
- アノテーションを一意に識別するために YouTube によって使用される ID。
カード
- card_type
- このディメンションは、ユーザーに表示されたカードの種類を識別します。次の表に、有効なディメンション値を示します。
値 0
不明 60
リンク 61
募金 62
動画 63
再生リスト 65
視聴者ファンディング 66
グッズ販売 68
関連付けられているウェブサイト 69
チャネル - card_id
- カードを一意に識別するために YouTube によって使用される ID。
終了画面
- end_screen_element_type
- このディメンションは、ユーザーに表示された終了画面要素のタイプを識別します。次の表に、終了画面の要素のタイプとその値を示します。
値 501
動画 - この要素は別の YouTube 動画を宣伝します。 502
再生リスト - YouTube の再生リストを宣伝する要素です。 503
ウェブサイト - 関連ウェブサイトにリンクする要素です。 504
チャンネル - 別のチャンネルにリンクする要素です。 505
チャンネル登録 - この要素はチャンネルへの登録を促します。 506
関連 507
クラウドファンディング - この要素は、承認済みのクラウドファンディング ウェブサイトにリンクしています。 508
商品 - 承認済みの商品ウェブサイトにリンクしています。 509
最近のアップロード - この要素は、チャンネルの最新アップロード動画にリンクしています。 510
視聴者に適したコンテンツ - end_screen_element_id
- 終了画面の要素を一意に識別するために YouTube が使用する ID。
字幕
- subtitle_language
- このディメンションは、視聴中に最も長く使用された字幕の言語を示します。字幕がおおむねオフになっていた字幕の視聴回数はカウントされません。このディメンションを含むレポートについて詳しくは、チャンネル レポートまたはコンテンツ所有者レポートのドキュメントをご覧ください。
- subtitle_language_autotranslated
- このディメンションでは、自動翻訳された字幕の言語のうち、視聴中に最も長い時間に使用されたものが示されます。字幕がおおむねオフになっていた字幕の視聴回数はカウントされません。このディメンションを含むレポートについて詳しくは、チャンネル レポートまたはコンテンツ所有者レポートのドキュメントをご覧ください。
広告のパフォーマンス
- ad_type
ad_type
ディメンションは広告のパフォーマンス レポートで使用され、動画再生中に配信された広告の種類に基づいてリクエストされた指標を集計します。 次の表に、有効なディメンション値を示します。YouTube の広告フォーマットについて詳しくは、YouTube ヘルプセンターをご覧ください。
値 説明 クエリレポートの値 1
スキップ可能な動画広告(オークション) auctionTrueviewInstream
2
ディスプレイ広告(オークション) auctionDisplay
3
スキップ不可の動画広告(オークション) auctionInstream
5
ディスプレイ広告(予約済み) reservedDisplay
6
スキップ不可の動画広告(純広告) reservedInstream
13
不明 unknown
15
スキップ可能な動画広告(純広告) reservedInstreamSelect
19
バンパー広告(オークション) auctionBumperInstream
20
バンパー広告(予約済み) reservedBumperInstream
注: クエリレポートは、以前に YouTube で使用されていた追加の広告タイプに対して返されることがあります。
コンテンツ所有者ディメンション
次のディメンションは、コンテンツ所有者レポートでのみ使用されます。
- claim_status(コンテンツ所有者レポートでのみ使用)
- このディメンションは、申し立てが行われたコンテンツの指標のみがデータ行に含まれていることを示します。このディメンションで有効な値は
claimed
のみです。このディメンションの使用方法の詳細については、uploader_type
ディメンションの定義の表をご覧ください。
- Uploader_type(コア ディメンション)(コンテンツ所有者レポートでのみ使用)
- このディメンションは、指定したコンテンツ所有者がアップロードしたコンテンツや第三者がアップロードしたコンテンツ(ユーザーがアップロードした動画など)の指標がデータ行に含まれているかどうかを示します。有効な値は
self
とthirdParty
です。これは主要なディメンションであり、非推奨ポリシーの対象となります。
以下の表は、claimed_status
ディメンションとuploader_type
ディメンションに対してサポートされている組み合わせを示しています。
claimed_status
値uploader_type
値説明 [未設定] self この行には、コンテンツ所有者によってアップロードされた、申し立てを行ったコンテンツと申し立てていないコンテンツに関する YouTube アナリティクスのデータが含まれます。 申し立て済み self 行には、コンテンツ所有者によってアップロードされた、申し立てが行われたコンテンツのデータが表示されます。 申し立て済み thirdParty 行には、第三者がアップロードした申し立てを受けたコンテンツのデータが含まれています。