このドキュメントでは、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。アセットとは、そのシステムにおける知的財産を表します。アセット ID は、YouTube ウェブサイト上の 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 国コードもあるためです。また、米国以外の国の区分もサポートしていません。
期間
- date (コア ディメンション)
- このディメンションでは、レポートの各行の指標に関連付けられている日付が特定されます。一括レポートにおける日付とは、太平洋時間の午前 12 時から、指定した年、月、日の午後 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 つ視聴してから、そのチャンネルに登録し、同じ日に別の動画を視聴したとします。 チャンネルのレポートでは、一方のビューのsubscribed_status
値はsubscribed
で、もう一方のビューではsubscribed_status
の値がunsubscribed
であることが示されています。
トラフィック ソース
- traffic_source_type
- このディメンションでは、ユーザー アクションの指標に関連付けられた参照 URL タイプを識別します。参照 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
キッズ: 探検 learning
キッズ: 学習 music
音楽フィード my-history
再生履歴 my-subscriptions
定期購入 my-uploads
マイ アップロード podcasts
ポッドキャストのコンテンツ ページ shows
キッズ: 番組 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
ショート動画
視聴者がショート動画の視聴中に、前の動画を縦にスワイプすることで参照されたことを示します。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
Playlist 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 この行には、第三者によってアップロードされた申し立てが行われたコンテンツのデータが含まれています。