このドキュメントでは、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 ウェブサイトの YouTube コンテンツ マネージャでアセット ID を確認できます。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 アプリ(YouTube Android アプリなど)で発生したアクティビティに関するものです。 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 回の視聴としてカウントされます。 チャンネルのレポートによると、1 つのビューのsubscribed_statusの値はsubscribed、もう 1 つのビューのsubscribed_statusの値はunsubscribedです。
トラフィック ソース
- traffic_source_type
- このディメンションは、ユーザー アクティビティ指標に関連付けられている参照元のタイプを識別します。参照元の種類は、レポートのデータ行に関連付けられている動画またはチャンネルにユーザーがアクセスした方法を表します。次の表に、ディメンション値を示します。
値 0直接、または不明
この値には、ページへの直接トラフィックと、参照元が不明なページが含まれます。クエリ レポートでは、このトラフィック ソースの種類はNO_LINK_OTHERまたはUNKNOWN_MOBILE_OR_DIRECTとして識別されます。1YouTube 広告
視聴者が広告によって動画に誘導された。トラフィック ソース レポートで、このディメンションの値が1の場合、traffic_source_detail ディメンションでは、視聴者に表示された広告のタイプが識別されます。クエリ レポートでは、このトラフィック ソースの種類はADVERTISINGと識別されます。使用できる値は次のとおりです。値 ctp_engagement_adClick-to-Play エンゲージメント広告 engagement_adエンゲージメント促進広告 googlemediaadsGoogle 検索広告 insearch_displayTrueView インサーチとインディスプレイ instreamTrueView インストリーム 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あなたへのおすすめ 4YouTube チャンネル
視聴者が YouTube チャンネル ページから誘導された。トラフィック ソース レポートで、このディメンションの値が4の場合、traffic_source_detail ディメンションでそのチャネルのチャネル ID が指定されます。クエリ レポートでは、このトラフィック ソースの種類はYT_CHANNELと識別されます。5YouTube 検索
視聴者は 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不明 widgetAndroid ホーム画面ウィジェット youtu.beyoutu.be ytremoteYouTube リモコン 9外部
視聴者が別のウェブサイトのリンクから誘導された。このトラフィック ソースには、Google 検索結果からの参照が含まれます。トラフィック ソース レポートで、このディメンションの値が9の場合、traffic_source_detail ディメンションで外部ウェブページが識別されます。クエリ レポートでは、このトラフィック ソースの種類はEXT_URLと識別されます。11動画カードとアノテーション
視聴者が別の動画のアノテーションまたはカードをクリックして参照した。クエリ レポートでは、このトラフィック ソースの種類はANNOTATIONと識別されます。14再生リスト
再生リストの一部として動画が再生されている間に発生した視聴回数。クエリ レポートでは、このトラフィック ソースの種類はPLAYLISTとして識別されます。
このトラフィック ソースは、再生リスト内のすべての動画を一覧表示するページから視聴が開始されたことを示すソースタイプ18とは異なります。17通知
視聴者は YouTube からのメールまたは通知から参照されました。クエリ レポートでは、このトラフィック ソースの種類はNOTIFICATIONと識別されます。使用できる値は次のとおりです。値 inboxpushsdigチャンネル登録者向けダイジェストに含まれる通知から発生した視聴回数 uploaded_other動画のアップロード時にチャンネル登録者に送信された、プッシュ通知以外の通知(メールや受信トレイの通知など)が起因する視聴回数 uploaded_push動画のアップロード時にチャンネル登録者に送信されたプッシュ通知がきっかけとなった視聴回数 18再生リスト ページ
再生リスト内のすべての動画を一覧表示するページから発生した視聴回数。クエリ レポートでは、このトラフィック ソースの種類はYT_PLAYLIST_PAGEと識別されます。
このトラフィック ソースは、動画が再生リストの一部として再生されている間に視聴されたことを示すソースタイプ14とは異なります。19申し立てを受けたコンテンツからの番組
視聴回数は、コンテンツ所有者が視聴されたコンテンツの宣伝に使用した、申し立てを受けたユーザーがアップロードした動画から発生しました。クエリ レポートでは、このトラフィック ソースはCAMPAIGN_CARDとして識別されます。このトラフィック ソースは、コンテンツ所有者レポートでのみサポートされています。20インタラクティブな動画終了画面
別の動画の終了画面から発生した視聴回数。クエリ レポートでは、このトラフィック ソースの種類はEND_SCREENと識別されます。23ストーリー
視聴者は、ストーリーの視聴中に前の動画から縦にスワイプして参照されました。24ショート動画
視聴者が、YouTube ショートの視聴環境で前の動画から縦にスワイプして参照した。25商品ページ
商品ページの動画から視聴者が別のチャンネルに誘導された。26ハッシュタグのページ
VOD ハッシュタグのページまたは YouTube ショートのハッシュタグ ピボット ページから発生した視聴回数。27サウンドページ
ショート動画のサウンド ピボット ページから発生した視聴回数。28ライブ リダイレクト
ライブ リダイレクトから発生した視聴回数。29ポッドキャスト
YouTube ポッドキャスト ページから発生した視聴回数。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その他 2Windows 3Windows Mobile 4Android 5iOS 6Symbian 7Blackberry 9Macintosh 10PlayStation 11Bada 12WebOS 13Linux 14Hiptop 15MeeGo 16Wii 17Xbox 18PlayStation Vita 19スマートテレビ 20ニンテンドー 3DS 21Chromecast 22Tizen 23Firefox 24RealMedia 25KaiOS 26Roku 27Nintendo Switch 28Apple tvOS 29Fire OS 30ChromeOS 31Vidaa
ユーザー属性
ユーザー属性のディメンションを使用すると、動画の視聴者の年齢層と性別を把握できます。YouTube Analytics レポートのユーザー属性データの詳細については、YouTube ヘルプセンターをご覧ください。
- age_group(コア ディメンション)
- このディメンションは、レポートデータに関連付けられているログイン ユーザーの年齢層を特定します。この API では、次の年齢グループが使用されます。
AGE_13_17AGE_18_24AGE_25_34AGE_35_44AGE_45_54AGE_55_64AGE_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不明 1Digg 4Google.com 5StumbleUpon 6mixi 7Yahoo! 日本 8goo 9Ameba 10Facebook 11Myspace 12NUjij 18Tuenti 20menéame 21Wykop 22Skyrock 25Fotka 28hi5 31Twitter 32Cyworld 34Blogger 36VKontakte(ВКонтакте) 37Rakuten(楽天市場) 38LiveJournal 39Odnoklassniki(Одноклассники) 40Tumblr です。 42LinkedIn 43Google+ 44Weibo 45Pinterest 46メール 47Facebook Messenger 49WhatsApp 50ハングアウト 51Gmail 52Kakao(KakaoTalk) 53その他 55クリップボードにコピー 59定着 60テキスト メッセージ 61Android メッセージ 62Verizon メッセージ 63HTC のテキスト メッセージ 64Sony Conversations 65Go SMS 66LGE メール 67線 68Viber 69Kik 70Skype 71BlackBerry Messenger 72WeChat 73KAKAO Story 74Dropbox 75Telegram 76Facebook ページ 77GroupMe 78Android メール 79Motorola Messaging 80ニアバイシェア 81Naver 82iOS システム アクティビティ ダイアログ 83Google 受信トレイ 84Android メッセージ 85YouTube Music 86YouTube Gaming 87YouTube Kids 88YouTube TV
詳しくは、ヘルプ ドキュメントをご覧ください。
アノテーション
- annotation_type
- このディメンションは、動画内でアノテーションが表示される方法を識別します。次の表に、使用可能なディメンション値を示します。
アノテーションの種類や動画にアノテーションを追加する方法について詳しくは、YouTube ヘルプセンターをご覧ください。値 0不明 1注 3スポットライト 4タイトル 8吹き出し 9ラベル 10画像・ロゴの透かし 11おすすめ動画 12おすすめの再生リスト 30Call-to-Action - annotation_id
- YouTube がアノテーションを一意に識別するために使用する ID。
カード
- card_type
- このディメンションは、ユーザーに表示されたカードの種類を識別します。次の表に、使用可能なディメンション値を示します。
さまざまな種類のカードと、動画にカードを追加する方法について詳しくは、YouTube ヘルプセンターをご覧ください。値 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スキップ可能な動画広告(オークション) auctionTrueviewInstream2ディスプレイ広告(オークション) auctionDisplay3スキップ不可の動画広告(オークション) auctionInstream5ディスプレイ広告(純広告) reservedDisplay6スキップ不可の動画広告(純広告) reservedInstream13不明 unknown15スキップ可能な動画広告(純広告) reservedInstreamSelect19バンパー広告(オークション) auctionBumperInstream20バンパー広告(予約済み) reservedBumperInstream注: クエリ レポートには、YouTube で以前に使用されていた一部の広告タイプも含まれる場合があります。
コンテンツ所有者ディメンション
次のディメンションは、コンテンツ所有者レポートでのみ使用されます。
- claimed_status(コンテンツ所有者レポートでのみ使用)
- このディメンションは、データの行に申し立て対象のコンテンツの指標のみが含まれていることを示します。このディメンションで有効な値は
claimedのみです。uploader_typeディメンションの定義の表に、このディメンションの使用方法の詳細が記載されています。
- uploader_type(コア ディメンション)(コンテンツ所有者レポートでのみ使用)
- このディメンションは、データの行に、指定したコンテンツ所有者によってアップロードされたコンテンツや、第三者(ユーザーがアップロードした動画など)によってアップロードされたコンテンツの指標が含まれているかどうかを示します。有効な値は
selfとthirdPartyです。これはコア ディメンションで、非推奨ポリシーが適用されます。
次の表に、claimed_statusディメンションとuploader_typeディメンションでサポートされている組み合わせを示します。
claimed_status値uploader_type値説明 [未設定] self この行には、コンテンツ所有者がアップロードした申し立て対象のコンテンツと申し立て対象外のコンテンツの YouTube アナリティクス データが含まれます。 申し立て済み self この行には、コンテンツ所有者がアップロードした申し立てを受けたコンテンツのデータが含まれます。 申し立て済み thirdParty この行には、第三者がアップロードした申し立て対象のコンテンツのデータが含まれます。