このドキュメントでは、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(コア ディメンション)
- レポート行の指標に関連付けられた国。ディメンション値は 2 文字の ISO-3166-1 国コードです(例:
US
、CN
(中国)、FR
(フランス))。国コード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-1 国コードもあるため、このディメンションは ISO 3166-2 値には対応していません。また、米国以外の国の下位区分もサポートされていません。
期間
- 日付(コア ディメンション)
- このディメンションでは、レポートの各行の指標に関連付けられた日付を識別します。一括処理
レポートの場合、この日付は太平洋時間午前 0 時から始まり、
指定した年、月、日の午後 11 時 59 分(太平洋時間)時期によっては
太平洋時間は UTC-7 または UTC-8 です。
日付は通常 24 時間を表しますが、時計を調整する日付は通常 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
で、1 つのビューのsubscribed_status
の値がunsubscribed
であることがわかります。
トラフィック ソース
- traffic_source_type
- このディメンションでは、ユーザー アクティビティの指標に関連付けられた参照 URL タイプを指定します。参照 URL の種類は、レポートのデータ行に関連付けられた動画またはチャンネルにユーザーがアクセスした方法を表します。次の表にディメンション値を示します。
値 0
直接または不明
この値には、ページへのノーリファラー トラフィックと、参照元が不明なページへのノーリファラーが含まれます。クエリレポートでは、このトラフィック ソース タイプは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
とは異なります。ソースタイプ18
は、再生リスト内のすべての動画をリストするページから再生されたことを示します。17
通知
視聴者は YouTube からのメールまたは通知から参照されました。クエリレポートでは、このトラフィック ソース タイプはNOTIFICATION
として識別されます。有効な値は次のとおりです。値 inbox
push
sdig
チャンネル登録者のダイジェストの一部である通知から発生した視聴回数 uploaded_other
メール通知や受信トレイ通知など、プッシュ通知以外から発生した視聴回数 動画がアップロードされたときにチャンネル登録者に送信 uploaded_push
動画視聴中にチャンネル登録者に送信されたプッシュ通知から発生した視聴回数 アップロード済み 18
再生リスト ページ
再生リスト内のすべての動画を一覧表示するページからの視聴です。クエリレポートでは、このトラフィック ソース タイプはYT_PLAYLIST_PAGE
と識別されます。
このトラフィック ソースはソースタイプ14
とは異なります。ソースタイプ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 ディメンション値に入力されます。
<ph type="x-smartling-placeholder">
- </ph>
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
その他 2
Windows 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
Tuenti 20
メネアム 21
Wykop 22
Skyrock 25
フォトカ 28
hi5 31
Twitter 32
サイワールド 34
Blogger 36
VKontakte( Our 末尾 37
楽天市場 38
LiveJournal 39
Odnoklassniki(プロセス) 40
。 42
LinkedIn 43
Google+ 44
Weibo 45
Pinterest 46
メール 47
Facebook Messenger 49
WhatsApp 50
ハングアウト 51
Gmail 52
Kakao(Kakao Talk) 53
その他 55
クリップボードにコピー 59
埋め込み 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 Messaging 80
ニアバイシェア 81
Naver 82
iOS のシステム アクティビティ ダイアログ 83
Google 受信トレイ 84
Android メッセンジャー 85
YouTube Music 86
YouTube Gaming 87
YouTube Kids 88
YouTube TV
詳しくは、ヘルプ ドキュメントをご覧ください。
アノテーション
- annotation_type
- このディメンションは、動画内でのアノテーションの表示方法を示します。次の表に、使用できるディメンション値を示します。
値 0
不明 1
注 3
スポットライト 4
タイトル 8
吹き出し 9
ラベル 10
画像・ロゴの透かし 11
おすすめ動画 12
おすすめの再生リスト 30
Call-to-Action - 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 で以前に使用された他の広告タイプについて返される場合があります。
コンテンツ所有者ディメンション
次のディメンションは、コンテンツ所有者レポートでのみ使用されます。
- predicted_status(コンテンツ所有者レポートでのみ使用)
- このディメンションは、申し立てを受けたコンテンツの指標のみがデータ行に含まれていることを示します。このディメンションの有効な値は
claimed
のみです。このディメンションの使用方法については、uploader_type
ディメンションの定義の表をご覧ください。
- Uploader_type(コア ディメンション)(コンテンツ所有者レポートでのみ使用)
- このディメンションは、指定したコンテンツ所有者がアップロードしたコンテンツの指標や、第三者によってアップロードされたコンテンツ(ユーザーがアップロードした動画など)の指標がデータ行に含まれているかどうかを示します。有効な値は
self
とthirdParty
です。このディメンションは中核的なディメンションであり、非推奨ポリシーの対象となります。claimed_status
ディメンションとuploader_type
ディメンションでサポートされている組み合わせを以下の表に示します。
claimed_status
値uploader_type
値説明 [未設定] self この行には、コンテンツ所有者がアップロードした申し立て済みコンテンツと申し立てられていないコンテンツに関する YouTube アナリティクスのデータが含まれます。 申し立て済み self この行には、コンテンツ所有者がアップロードした申し立てを受けたコンテンツのデータが含まれます。 申し立て済み thirdParty この行には、第三者によってアップロードされた、申し立てを受けたコンテンツのデータが含まれます。