このドキュメントでは、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-1 国コードもあるため、このディメンションでは、米国の海外領土を識別する ISO 3166-2 値はサポートされていません。また、米国以外の国の地域区分もサポートされていません。
期間
- date (コア ディメンション)
- このディメンションは、レポートの各行の指標に関連付けられている日付を示します。一括レポートでは、日付は指定された日、月、年の太平洋時間の午前 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
- このディメンションは、ユーザー アクティビティ指標に関連付けられているリファラー タイプを識別します。リファラー タイプは、レポートのデータ行に関連付けられている動画またはチャンネルにユーザーがアクセスした方法を示します。次の表に、ディメンション値を示します。
値 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とは異なります。ソースタイプ18は、再生リスト内のすべての動画を一覧表示するページから視聴が発生したことを示します。17通知
視聴者が YouTube からのメールまたは通知からアクセスしました。クエリ レポートでは、このトラフィック ソースタイプはNOTIFICATIONとして識別されます。使用できる値は次のとおりです。値 inboxpushsdigチャンネル登録者向けダイジェストに含まれる通知から発生した視聴回数 uploaded_other動画がアップロードされたときにチャンネル登録者に送信された、メールや受信トレイの通知などのプッシュ通知以外の通知からの視聴回数 uploaded_push動画がアップロードされたときにチャンネル登録者に送信されたプッシュ通知からの視聴回数 18再生リスト ページ
再生リスト内のすべての動画が一覧表示されるページから発生した視聴回数。クエリ レポートでは、このトラフィック ソースの種類はYT_PLAYLIST_PAGEとして識別されます。
このトラフィック ソースは、ソースタイプ14とは異なります。ソースタイプ14は、動画が再生リストの一部として再生されているときに視聴が発生したことを示します。19申し立てが行われたコンテンツからのプログラミング
コンテンツ所有者が視聴されたコンテンツの宣伝に使用した、申し立てが行われたユーザー アップロード動画から発生した視聴回数。クエリ レポートでは、このトラフィック ソースはCAMPAIGN_CARDとして識別されます。このトラフィック ソースは、コンテンツ所有者レポートでのみサポートされています。20インタラクティブな動画の終了画面
別の動画の終了画面から発生した視聴回数。クエリ レポートでは、このトラフィック ソースタイプはEND_SCREENとして識別されます。23ストーリー
ストーリーの視聴画面で前の動画から縦方向にスワイプして視聴者が参照した。24ショート動画
ショート動画の視聴画面で前の動画から縦方向にスワイプして視聴者がアクセスした。25商品ページ
商品ページの動画から別のチャンネルに視聴者が移動しました。26ハッシュタグ ページ
VOD ハッシュタグ ページまたはショート動画ハッシュタグ ピボット ページから発生した視聴回数。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- ディメンション値は、Google ナレッジグラフ ID である商品 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 32VegaOS
ユーザー属性
ユーザー属性ディメンションを使用すると、視聴者の年齢層と性別の分布を把握できます。YouTube ヘルプセンターには、YouTube Analytics レポートのユーザー属性データに関する詳細情報が記載されています。
- 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(ВКонтакте) 37楽天(楽天市場) 38LiveJournal 39Odnoklassniki(Одноклассники) 40tumblr. 42LinkedIn 43Google+ 44Weibo 45Pinterest 46メール 47Facebook Messenger 49WhatsApp 50ハングアウト 51Gmail 52Kakao(Kakao Talk) 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 Inbox 84Android Messenger 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ウェブサイト - 関連付けられたウェブサイトにリンクします。 504Channel - 要素は別のチャンネルにリンクします。 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 この行には、第三者によってアップロードされた申し立て済みのコンテンツのデータが含まれます。