このドキュメントでは、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 国コードもあるためです。また、米国以外の国の下位区分はサポートされていません。
期間
- 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 アプリ(YouTube Android アプリなど)で発生したアクティビティに関連しています。 1このデータは、 <iframe>または<object>埋め込みを使用して動画が埋め込まれた別のウェブサイトまたはアプリケーションで発生したアクティビティに関連しています。2データは、YouTube チャンネル ページで発生したアクティビティに関連しています。 5このデータは、リストされている他のロケーション タイプのいずれにも分類できない指標に関連しています。 7このデータは、YouTube のトップページまたはホーム画面、ユーザーの登録チャンネル フィード、またはその他の YouTube ブラウジング機能で発生した視聴回数に関連しています。 8このデータは、YouTube 検索結果ページで直接視聴された回数に関するものです。 10このデータは、YouTube ショート フィードでの視聴に関するものです。 11このデータは、縦型ライブ配信フィードで発生した視聴回数に関連しています。 12このデータは、YouTube Music の [サンプル] タブで発生した視聴回数に関連しています。 - 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
- このディメンションは、ユーザー アクティビティ指標に関連付けられた参照元タイプを示します。参照元タイプは、レポートのデータ行に関連付けられた動画またはチャンネルにユーザーがアクセスした方法を示します。次の表に、ディメンション値を示します。
値 説明 0ノーリファラーまたは不明
この値には、ページへのノーリファラーと、参照 URL が不明なページが含まれます。クエリレポートでは、このトラフィック ソースタイプはNO_LINK_OTHERまたはUNKNOWN_MOBILE_OR_DIRECTとして識別されます。1YouTube 広告
視聴者が広告から動画にアクセスした。トラフィック ソース レポートで、このディメンションの値が1の場合、traffic_source_detail ディメンションは、視聴者に表示された広告の種類を識別します。クエリレポートでは、このトラフィック ソースの種類はADVERTISINGとして識別されます。指定できる値は次のとおりです。値 説明 ctp_engagement_adClick-to-Play エンゲージメント広告 engagement_adエンゲージメント促進広告 googlemediaadsGoogle 検索広告 insearch_displayTrueView インサーチ、TrueView インディスプレイ 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として識別されます。指定できる値は次のとおりです。値 説明 creatorYouTube Studio 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ショート動画
ショート動画の視聴画面で、前の動画から縦方向にスワイプして参照された視聴者。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 (コア ディメンション)
- このディメンションは、レポートデータに関連付けられているログイン ユーザーの年齢層を識別します。これには、YouTube が 18 歳未満と推定したユーザーも含まれます。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 との会話 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 89YouTube の「友だちと一緒に視聴」 90Allo 91YouTube コミュニティ投稿 92YouTube コミュニティの再投稿 93KaiOS メッセージ 94マップのコピー / 貼り付け 95子どもと共有する 96ウェブシステム アクティビティ ダイアログ 97Snapchat 98Snapchat プレビューで YouTube Music を共有 99Snapchat カメラに共有 100Android システムの共有ダイアログ 101デバイス内の写真に保存する 102Instagram 103直接システム アクティビティ ダイアログ 104Discord 105Instagram Stories 106Facebook ストーリーズ 107Meet のライブ共有 108Samsung メッセージ 109WhatsApp Business 110Samsung Notes 111Google Keep 112Facebook Lite 113IMO 114YouTube Mango 115Facebook グループに共有 116Google Chat 117プレイリストの共同編集者を招待する 118Quick Share 119Quick Share(Samsung) 120表示された QR コード 121YouTube ショートのグリーン スクリーン 122広告なしで共有 123Google アプリ 124Google Chrome 125ブラインド リアクション 126招待リンク(Android) 127招待リンク(iOS) 128リミックス
詳しくは、ヘルプ ドキュメントをご覧ください。
アノテーション
- 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 この行には、第三者によってアップロードされた申し立て対象のコンテンツのデータが含まれます。