このドキュメントでは、YouTube Analytics API がサポートするディメンションを定義します。この API は、ターゲットを絞ったリアルタイムのクエリをサポートして、カスタム YouTube アナリティクス レポートを生成します。
ディメンションとは、ユーザー アクションが発生した日付やユーザーが所在する国など、データの集計に使用される一般的な条件です。
各クエリレポートでは、サポートしているディメンションを確認できます。たとえば、ユーザーのアクティビティを時間別に取得する場合は、データが報告される期間を [日] または [月] を選択します。レポートの各行には、ディメンション値の一意の組み合わせがあります。
クエリレポートを取得するには、YouTube Analytics API の reports.query
メソッドを呼び出します。リクエストで dimensions
パラメータを使用して、YouTube がレポートの指標値を計算するために使用するディメンションを指定します。
主要な要素
YouTube Analytics API には、利用規約で定義されているサポート終了ポリシーが適用されますが、コア以外のディメンション(およびコア以外の指標)には、このポリシーは適用されません。このページでの定義では、主要なディメンションであるディメンションはすべて、そのように明示されています。
API の主要な要素は以下のとおりです。
詳しくは、非推奨ポリシーの対象となる YouTube API の一覧をご覧ください。
フィルタ
すべてのクエリレポートでフィルタがサポートされています。フィルタは、取得したデータセットに存在する必要があるディメンション値を識別します。そのため、特定の値または値のセットに一致するデータのみが含まれるように API レスポンスを制限します。たとえば、すべての国のユーザー アクティビティの指標を取得する代わりに、フィルタを使用して特定の国のデータのみを取得できます。
クエリレポートを取得するリクエストでは、オプションの filters
リクエスト パラメータを使用して、データをフィルタリングするディメンション値を指定します。たとえば、ヨーロッパのユーザー アクションの指標を取得するには、filters
パラメータの値を continent==150
に設定します。
重要: コンテンツ所有者レポートを取得する API リクエストでは、レポート エンティティのディメンションのいずれかを使用するか、claimedStatus
と uploaderType
のサポートされているディメンションの組み合わせを使用してデータをフィルタする必要があります。
ディメンション
以下のセクションでは、YouTube Analytics API のクエリレポートで使用されるディメンションを定義します。特に明記されていない限り、これらのディメンションは、チャンネル レポートとコンテンツ所有者レポートの両方で使用されます。フィルタとしてしか使用できないディメンションも特定されます。
関連情報
これらのディメンションは、チャンネルとコンテンツ所有者が YouTube で管理するリソースに対応しています。
注: API では、video
、playlist
、channel
ディメンションをフィルタとして使用する場合、複数の値を指定できます。これを行うには、filters
パラメータ値に、API レスポンスをフィルタする動画、再生リスト、またはチャンネル ID のカンマ区切りのリストを設定します。パラメータ値には最大 500 個の ID を指定できます。
- 動画 (コア ディメンション)
- YouTube 動画の ID。YouTube Data API では、これは
video
リソースのid
プロパティの値です。This is a core dimension and is subject to the Deprecation Policy. - 再生リスト
- YouTube 再生リストの ID。YouTube Data API では、これは
playlist
リソースのid
プロパティの値です。 - チャンネル (コア ディメンション) (コンテンツ所有者レポートでのみ使用)
- YouTube チャンネルの ID。YouTube Data API では、これは
channel
リソースのid
プロパティの値です。This is a core dimension and is subject to the Deprecation Policy.
コンテンツ所有者レポートでは、通常、複数のチャンネルのデータを集計するため、channel
ディメンションが頻繁に使用されます。 - group (フィルタのみ)
- YouTube アナリティクス グループの ID。この値は、YouTube Analytics API の
groups.list
メソッドを使用して取得できます。group
フィルタを使用すると、API レスポンスには、そのグループ内のすべての動画、再生リスト、チャンネルのデータが含まれます。
例
次のサンプル リクエストでは、レポート エンティティのディメンションまたはフィルタを使用しています。
チャンネルの例
コンテンツ所有者の例
地理的エリア
これらのディメンションにより、ユーザー アクション、広告のパフォーマンス、推定収益関連の指標に関連する地域を特定できます。
- 国 (コア ディメンション)
- レポートの行の指標に関連付けられている国。ディメンション値は、
US
、CN
(中国)、FR
(フランス)など、2 文字の ISO-3166-1 国コードです。国コードZZ
は、関連する国を YouTube が特定できなかった指標を報告するために使用されます。This is a core dimension and is subject to the Deprecation Policy. - province
- レポートの行の指標に関連付けられている米国の州または地域。ディメンション値は、米国の州またはコロンビア特別区を識別する ISO 3166-2 コードです(例:
US-MI
(ミシガン)、US-TX
(テキサス))。州コードUS-ZZ
は、関連する米国の州を YouTube が特定できなかった指標を報告するために使用されます。 API リクエストのdimensions
パラメータ値にprovince
が含まれている場合、filters
パラメータ値にcountry==US
を含めることで、データを米国に限定する必要もあります。注: このディメンションでは、米国海外領土を表す ISO 3166-2 値はサポートされていません。これらの地域には独自の ISO 3166-1 国コードもあるためです。また、米国以外の国の区分もサポートしていません。
- city
- レポートの行の指標に関連付けられた推定の都市。このディメンションでは、2022 年 1 月 1 日以降のデータを利用できます。
- currency (フィルタのみ)
-
国際連合(UN)の統計的地域コード。API は次の値をサポートします。
値 002
アフリカ 019
南北アメリカ(北アメリカ、ラテンアメリカ、南アメリカ、カリブ海) 142
アジア 150
ヨーロッパ 009
オセアニア filters
パラメータの値をcontinent==REGION_CODE
に設定し、上記のリストからREGION_CODE
値を指定します。 - subContinent (フィルタのみ)
-
地理的な小地域を識別する国連の統計的地域コード。国際連合統計部には、下位地域と、各地域に関連付けられている国が表示されます。
このディメンションはデータのフィルタリングにのみ使用できます。このディメンションを使用するには、
filters
パラメータの値をsubContinent==REGION_CODE
に設定し、UN リストからREGION_CODE
値を指定します。
例
次のサンプル リクエストでは、地域ディメンションまたはフィルタを使用しています。
チャンネルの例
- 基本統計情報: チャンネルの国別の視聴回数など
-
地域
- チャンネルの動画の国別再生時間の指標
- チャンネルの動画のアノテーションに関する国別の指標
- 米国の州とワシントン D.C. の州別の指標
- チャンネルの再生リストに関する国別の総再生時間の指標
- トップ 10 – 米国で最も始まったプレイリスト
- 再生場所: さまざまな再生場所での 1 日の視聴回数と総再生時間です。
- トラフィック ソース: 国内のさまざまなトラフィック ソースからの再生回数と総再生時間。
- ユーザー属性: カリフォルニア州の視聴者のユーザー属性(年齢層と性別)
-
人気の動画
- トップ 10 – 特定の国における再生回数が多い動画
- トップ 10 – ヨーロッパで特に再生回数の多い動画
コンテンツ所有者の例
- 基本統計情報: 自分でアップロードした動画の国別の視聴回数(およびその他の情報)
-
地域
- 自身がアップロードしたコンテンツの国別再生時間の指標
- 自身がアップロードしたコンテンツのアノテーションに関する国別の指標
- 米国の州とワシントン D.C. の州別の指標
- コンテンツ所有者の再生リストに関する国別の総再生時間指標
- トップ 10 – 米国で最も始まったプレイリスト
- 再生場所: さまざまな再生場所での 1 日の視聴回数と総再生時間です。
- ユーザー属性: カリフォルニア州の視聴者のユーザー属性(年齢層と性別)
- 人気の動画: トップ 10 - ヨーロッパでコンテンツ所有者が最も多く視聴した動画
- 収益/広告のパフォーマンス: 国ごとの収益と広告のパフォーマンスの指標
期間
これらのディメンションは、レポートが期間(日、週、月など)に基づいてデータを集計する必要があることを示します。リクエスト パラメータの startDate
と endDate
には、レポートに含めるデータの期間を指定します。実際にレポートでは、クエリが行われた時点でリクエストで指定されたすべての指標が利用可能な最終日までのデータが返されます。レポートでは、日付は YYYY-MM-DD
形式でリストされます。
重要: すべての日付とは、太平洋時間の午前 12 時(UTC-7 または UTC-8)から午後 11 時 59 分までの太平洋時間を指します。そのため、夏時間で時計を前方に調整する日付は 23 時間を表し、時計を後方に調整する日付は 25 時間を表します。
「月」ディメンションは、指定された月と年の最初の日の午前 12 時(UTC-7 または UTC-8)から始まります。
- 日 (コア ディメンション)
- このディメンションを使用すると、レポートのデータが 1 日ごとに集計され、各行に 1 日分のデータが含まれます。他のディメンションを使って、データをさらに細分化することもできます。たとえば、トラフィック ソース レポートでは、ユーザーが動画にアクセスした方法に基づいて、毎日の視聴に関する統計情報が集計されます。This is a core dimension and is subject to the Deprecation Policy.
- 月 (コア ディメンション)
- レポートのデータは、暦月ごとに集計されます。日次レポートと同様、他のフィルタを使用してデータをさらに細かく分類することができます。レポートには、
YYYY-MM
形式で日付が記載されます。
注: API クエリでmonth
ディメンションを使用する場合、start-date
パラメータとend-date
パラメータの両方を月の初日に設定する必要があります。This is a core dimension and is subject to the Deprecation Policy.
例
次のサンプル リクエストでは、時間ディメンションまたはフィルタを使用しています。
チャンネルの例
-
時間ベース
- チャンネルの動画の日別再生時間の指標
- チャンネルの動画のアノテーションに関する日別の指標
- チャンネルの 1 日の再生リストの視聴回数
- 再生場所: さまざまな再生場所での 1 日の視聴回数と総再生時間です。
- トラフィック ソース: さまざまなトラフィック ソースからの 1 日の視聴回数と総再生時間です。
-
デバイス/OS
- Android オペレーティング システムの端末のタイプに関する日別の指標
- 携帯端末のオペレーティング システムに関する日別の指標
- オペレーティング システムと端末のタイプに関する日別の指標
-
時間ベース
コンテンツ所有者の例
-
時間ベース
- 自身がアップロードしたコンテンツの日別再生時間の指標
- 申し立てが行われたコンテンツのアノテーションに関する指標
- コンテンツ所有者の 1 日の再生リストの視聴回数
- 再生場所: さまざまな再生場所での 1 日の視聴回数と総再生時間です。
- トラフィック ソース: さまざまなトラフィック ソースからの 1 日の視聴回数と総再生時間です。
-
デバイス/OS
- 申し立てが行われた動画の端末のタイプに関する日別の指標
- 申し立てが行われた動画が携帯端末で再生されたときのオペレーティング システムに関する日別の指標
- オペレーティング システムと端末のタイプに関する日別の指標
- 収益/広告のパフォーマンス: 日々の収益と広告のパフォーマンスの指標。
-
時間ベース
再生場所
これらのディメンションにより、ユーザー アクションが発生したページまたはアプリケーションに関する分析情報が得られます。
- insightPlaybackLocationType
-
レポートのデータは、動画の再生が発生したページまたはアプリケーションのタイプに基づいて集計されます。このディメンションで使用できる値は次のとおりです。
-
BROWSE
– YouTube のホームページやホーム画面、ユーザーの登録チャンネル フィード、または YouTube の別のブラウジング機能で発生した視聴回数を表します。 -
CHANNEL
– チャンネル ページで発生した視聴回数を表すデータです。 -
EMBEDDED
– データが、<iframe>
または<object>
埋め込みを使用して動画が埋め込まれている別のウェブサイトまたはアプリケーションで発生した視聴回数を表します。 -
EXTERNAL_APP
– サードパーティ アプリケーション内で発生したビューを表し、<iframe>
または<object>
埋め込み以外の方法で動画が再生されます。たとえば、YouTube Android Player API を使用するアプリケーションでの再生は、この値を使用して分類されます。 -
MOBILE
– YouTube のモバイルサイト、または承認済みの YouTube API クライアント(モバイル デバイスを含む)で発生した視聴回数を表します。2013 年 9 月 10 日以降、YouTube アナリティクス レポートで
MOBILE
の再生として分類されなくなりました。以前のデータもこのカテゴリに分類されるため、この値はレポートに残る場合があります。ただし、この日付以降は、再生が行われるアプリのタイプに応じて、モバイルでの再生がWATCH
、EMBEDDED
、EXTERNAL_APP
のいずれかに分類されます。 -
SEARCH
– YouTube 検索結果ページで直接発生した視聴回数を示すデータです。 -
WATCH
– 動画の YouTube 動画再生ページや公式 YouTube アプリ(Android 向け YouTube アプリなど)で発生した視聴回数を示すデータです。 -
YT_OTHER
– 他の方法で分類されていないビューを表すデータです。
-
- insightPlaybackLocationDetail
- データは、プレーヤーがいるページに基づいて集計されます。このレポートは埋め込みプレーヤーで発生した再生回数のみに対応しており、指定した動画が最も多く再生された埋め込みプレーヤーを識別します。このため、上位の埋め込みプレーヤーに関連付けられた URL またはアプリケーションを識別することにより、再生場所レポートよりもきめ細かいビューが提供されます。
例
以下のサンプル リクエストでは、再生場所ディメンションを使用しています。
チャンネルの例
-
再生場所
- 各再生場所における再生回数と再生時間
- さまざまな再生場所での 1 日の視聴回数と総再生時間
- トップ 10 – 埋め込み動画の再生を最も多く生成したサードパーティのサイト
- さまざまな再生場所での再生リストの視聴回数と総再生時間
- さまざまな再生場所での 1 日の再生リストの視聴回数と総再生時間
-
再生場所
コンテンツ所有者の例
-
再生場所
- 各再生場所における再生回数と再生時間
- さまざまな再生場所での 1 日の視聴回数と総再生時間
- トップ 10 – 埋め込み動画の再生を最も多く生成したサードパーティのサイト
- さまざまな再生場所での再生リストの視聴回数と総再生時間
- さまざまな再生場所での 1 日の再生リストの視聴回数と総再生時間
-
再生場所
再生の詳細
- creatorContentType
- このディメンションでは、データ行のユーザー アクション指標に関連付けられているコンテンツの種類が示されます。このディメンションでは、2019 年 1 月 1 日以降のデータを利用できます。
次の表にディメンション値を示します。
値 LIVE_STREAM
視聴されたコンテンツが YouTube ライブ配信であった。 SHORTS
視聴されたコンテンツが YouTube ショート動画である。 STORY
視聴されたコンテンツが YouTube ストーリーだった。 VIDEO_ON_DEMAND
視聴されたコンテンツが、他のディメンション値のいずれにも当てはまらない YouTube 動画であった。 UNSPECIFIED
視聴されたコンテンツのコンテンツ タイプが不明。 - liveOrOnDemand
- このディメンションは、データ行のユーザー アクティビティ指標がライブ配信の視聴に関連付けられているかどうかを示します。このディメンションでは、2014 年 4 月 1 日以降のデータを利用できます。
次の表にディメンション値を示します。
値 LIVE
この行のデータは、ライブ配信中に発生したユーザー アクティビティを示しています。 ON_DEMAND
この行のデータは、ライブ配信中に発生しなかったユーザー アクティビティを示しています。 - subscribedStatus
- このディメンションは、データ行のユーザー アクティビティ指標が、動画または再生リストのチャンネルに登録している視聴者に関連付けられているかどうかを示します。
有効な値は
SUBSCRIBED
とUNSUBSCRIBED
です。
ディメンションの値は、ユーザー アクションが発生した時点の正確さです。たとえば、あるチャンネルに登録していないユーザーが、そのチャンネルの動画を 1 つ視聴してから、チャンネル登録して、同じ日に別の動画を視聴したとします。 チャンネルのレポートでは、一方のビューのsubscribedStatus
値はSUBSCRIBED
で、もう一方のビューではsubscribedStatus
の値がUNSUBSCRIBED
であることが示されています。 - youtubeProduct
- このディメンションでは、ユーザー アクションが発生した YouTube サービスを特定できます。このディメンションのデータは 2015 年 7 月 18 日時点のものです。
次の表にディメンション値を示します。
値 CORE
YouTube の専門アプリケーション(YouTube Gaming、YouTube Kids、YouTube Music)のいずれかでは発生しなかったユーザー アクティビティ。例外: 2021 年 3 月 1 日より前に YouTube Music で発生したユーザー アクティビティは CORE
に含まれます。GAMING
ユーザー アクションが YouTube Gaming で発生した。 KIDS
ユーザー アクティビティは YouTube Kids で発生しました。 MUSIC
2021 年 3 月 1 日以降に YouTube Music でユーザー アクティビティが発生しました。 CORE
には、2021 年 3 月 1 日より前のデータが含まれます。リアルタイムのデータは記録されません。UNKNOWN
ユーザー アクションが 2015 年 7 月 18 日より前に発生している。
トラフィック ソース
- insightTrafficSourceType
- レポートのデータは、参照ユーザーの種類(ユーザーが動画にアクセスした方法)に基づいて集計されます。このディメンションで使用できる値は次のとおりです。
ADVERTISING
– 視聴者が広告から動画を参照した場合。このトラフィック ソースに基づいてフィルタする場合、insightTrafficSourceDetail
フィールドにアドバタイズの種類が示されます。ANNOTATION
– 視聴者が別の動画のアノテーションをクリックして動画にアクセスした回数。CAMPAIGN_CARD
– コンテンツ所有者が視聴したコンテンツの宣伝に使用した、申し立てを受けたユーザー アップロード動画からの視聴。このトラフィック ソースはコンテンツ所有者レポートでのみサポートされています。END_SCREEN
– 視聴回数が別の動画の終了画面から参照された場合。EXT_URL
– 動画再生回数が別のウェブサイトのリンクから参照された場合。このトラフィック ソースに基づいてフィルタすると、insightTrafficSourceDetail
フィールドでウェブページが特定されます。このトラフィック ソースには Google 検索の検索結果からの参照が含まれます。HASHTAGS
– VOD のハッシュタグ ページまたはショート動画のハッシュタグ ピボット ページからの視聴。LIVE_REDIRECT
- 動画再生回数はライブ リダイレクトから参照されています。NO_LINK_EMBEDDED
– 視聴時に動画が別のウェブサイトに埋め込まれていた場合。NO_LINK_OTHER
– YouTube がトラフィックの参照 URL を識別できなかった。このカテゴリには動画への直接トラフィック(ノーリファラー)とモバイル アプリのトラフィックが含まれます。NOTIFICATION
– 動画再生回数が YouTube からのメールまたは通知から参照された場合。PLAYLIST
– 再生リストの一部として動画が再生されている最中に発生した動画再生回数。これには再生リストページからのトラフィックが含まれます。PRODUCT_PAGE
- 動画再生回数が商品ページから参照された場合。PROMOTED
– 動画再生が、YouTube の「スポットライト動画」ページなどの無料の YouTube プロモーションから参照された場合。RELATED_VIDEO
– 動画再生が別の動画再生ページの関連動画リストから参照された場合。このトラフィック ソースに基づいてフィルタする場合、insightTrafficSourceDetail
フィールドにはその動画の動画 ID を指定します。SHORTS
– 視聴者がショート動画の視聴中に、前の動画を縦にスワイプすることで参照されました。SOUND_PAGE
– ショート動画のサウンド ピボット ページからの視聴。SUBSCRIBER
– 動画再生回数が YouTube トップページのフィードまたは YouTube の定期購入機能から参照された場合。このトラフィック ソースに基づいてフィルタする場合、insightTrafficSourceDetail
フィールドには、トップページ フィード アイテムまたは視聴の参照元となったその他のページを指定します。YT_CHANNEL
– チャンネル ページで発生した動画再生回数。このトラフィック ソースに基づいてフィルタする場合、insightTrafficSourceDetail
フィールドにそのチャンネルのチャンネル ID を指定します。YT_OTHER_PAGE
– 動画再生回数が、YouTube ページに表示された検索結果または関連動画リンク以外のリンクから参照された場合。このトラフィック ソースに基づいてフィルタすると、insightTrafficSourceDetail
フィールドでページが識別されます。YT_SEARCH
– 動画再生回数が YouTube 検索結果から参照された場合。このトラフィック ソースに基づいてフィルタする場合、insightTrafficSourceDetail
フィールドに検索キーワードを指定します。VIDEO_REMIXES
– 動画再生回数は、YouTube ショート プレーヤーのリミックス動画リンクから参照されました。このトラフィック ソースに基づいてフィルタする場合、insightTrafficSourceDetail
フィールドには視聴者が参照された動画を指定します。
- insightTrafficSourceDetail
- レポートのデータは、指定した動画および指定したトラフィック ソースの種類について、視聴回数が最も多く発生した参照 URL に基づいて集計されます。このレポートを利用できるトラフィック ソースは次のとおりです。各トラフィック ソースの「
insightTrafficSourceDetail
」ディメンションから得られる情報が、このリストに表示されます。ADVERTISING
– 視聴につながった広告のタイプ。有効な値は次のとおりです。- Click-to-Play エンゲージメント広告
- エンゲージメント促進広告
- Google 検索広告
- トップページ YVA
- 予約済みのスキップ可能なインストリーム
- TrueView インサーチとインディスプレイ
- TrueView インストリーム
- 該当カテゴリのない YouTube 広告
- サムネイル表示
CAMPAIGN_CARD
– レポートで特定されている動画に視聴者を誘導した申し立てが行われた動画。END_SCREEN
– レポートで特定されている動画に視聴者を誘導した動画。EXT_URL
– 視聴者を動画に紹介したウェブサイト。HASHTAGS
– 視聴回数につながったハッシュタグ。NOTIFICATION
– トラフィックを参照したメールまたは通知。RELATED_VIDEO
– レポートに含まれる動画に視聴者を誘導した関連動画。SOUND_PAGE
– 視聴につながった動画。SUBSCRIBER
– レポートに含まれる動画に視聴者を誘導したトップページ フィード アイテムまたは YouTube の登録チャンネル機能。有効な値は次のとおりです。activity
– トップページの登録チャンネル フィードに表示された動画のうち、アップロードやソーシャル チャンネル以外のアクティビティ(高評価、お気に入り、お知らせメッセージ、再生リストの追加など)によって発生した視聴回数。blogged
– トップページの登録チャンネル フィードのアイテムのうち、人気のブログからのリンクによって発生した視聴回数。mychannel
– トップページに表示される他のフィード([高評価]、[再生履歴]、[後で見る] など)の視聴回数。podcasts
– ポッドキャストのリンク先ページ内のアイテムから発生した視聴回数。sdig
– 購読の更新メールから受信したビュー。uploaded
– トップページの登録チャンネル フィードに表示されたuploaded
個のアイテムからの再生回数。/
– YouTube トップページからのその他の視聴回数。/my_subscriptions
– YouTube のユーザーの [登録チャンネル] ページから獲得した視聴回数。
YT_CHANNEL
– 視聴者が動画を視聴したチャンネル ページ。YT_OTHER_PAGE
– 視聴者が動画を参照した YouTube ページ。YT_SEARCH
– 視聴者を動画に誘導した検索キーワード。VIDEO_REMIXES
– 視聴につながった動画。
例
以下のサンプル リクエストでは、トラフィック ソース ディメンションを使用しています。
チャンネルの例
-
トラフィック ソース
- 特定の国におけるトラフィック ソース別の再生回数および再生時間
- さまざまなトラフィック ソースからの 1 日の視聴回数と総再生時間
- トップ 10 – 動画のトラフィックを最も多く生成した YouTube 検索キーワード
- トップ 10 – 動画のトラフィックを最も多く生成した Google 検索キーワード
- 各国のさまざまなトラフィック ソースからの再生リストの視聴回数と総再生時間
- さまざまなトラフィック ソースからの 1 日の再生リストの視聴回数と総再生時間
-
トラフィック ソース
コンテンツ所有者の例
-
トラフィック ソース
- トラフィック ソース別の再生回数および再生時間
- さまざまなトラフィック ソースからの 1 日の視聴回数と総再生時間
- トップ 10 – 動画のトラフィックを最も多く生成した YouTube 検索キーワード
- トップ 10 – 動画のトラフィックを最も多く生成した Google 検索キーワード
- 各国のさまざまなトラフィック ソースからの再生リストの視聴回数と総再生時間
- さまざまなトラフィック ソースからの 1 日の再生リストの視聴回数と総再生時間
-
トラフィック ソース
デバイス
- deviceType
- このディメンションは、視聴が発生したデバイスの物理フォーム ファクタを示します。
次のリストは、API がデータを返す対象のデバイスタイプを示しています。また、
deviceType
ディメンションをフィルタとして使用し、オペレーティング システムのレポートに特定の種類のデバイスのデータのみが含まれるように制限することもできます。DESKTOP
GAME_CONSOLE
MOBILE
TABLET
TV
UNKNOWN_PLATFORM
- operatingSystem
- このディメンションは、ビューが発生したデバイスのソフトウェア システムを示します。
次のリストは、API がデータを返すオペレーティング システムを示しています。
operatingSystem
をフィルタとして使用し、デバイスタイプのレポートに特定のオペレーティング システムのデータのみが含まれるように制限することもできます。ANDROID
BADA
BLACKBERRY
CHROMECAST
DOCOMO
FIREFOX
HIPTOP
IOS
KAIOS
LINUX
MACINTOSH
MEEGO
NINTENDO_3DS
OTHER
PLAYSTATION
PLAYSTATION_VITA
REALMEDIA
SMART_TV
SYMBIAN
TIZEN
VIDAA
WEBOS
WII
WINDOWS
WINDOWS_MOBILE
XBOX
例
以下のサンプル リクエストでは、端末ディメンションを使用しています。
チャンネルの例
-
デバイス/OS
- Android オペレーティング システムの端末のタイプに関する日別の指標
- 携帯端末のオペレーティング システムに関する日別の指標
- オペレーティング システムと端末のタイプに関する日別の指標
- Android オペレーティング システム上の再生リストの視聴に関する、デバイスタイプ別の指標(日単位)
- モバイル デバイスでの再生リストの視聴に関するオペレーティング システムに関する日別の指標
-
デバイス/OS
コンテンツ所有者の例
-
デバイス/OS
- 申し立てが行われた動画の端末のタイプに関する日別の指標
- 申し立てが行われた動画が携帯端末で再生されたときのオペレーティング システムに関する日別の指標
- オペレーティング システムと端末のタイプに関する日別の指標
- Android オペレーティング システム上の再生リストの視聴に関する、デバイスタイプ別の指標(日単位)
- モバイル デバイスでの再生リストの視聴に関するオペレーティング システムに関する日別の指標
-
デバイス/OS
ユーザー属性
ユーザー属性のディメンションを使用すると、オーディエンスの年齢層と性別の分布を把握できます。YouTube Analytics レポートのユーザー属性データについて詳しくは、YouTube ヘルプセンターをご覧ください。
- ageGroup(コア ディメンション)
- このディメンションでは、レポートデータに関連付けられたログイン ユーザーの年齢層を確認できます。API では以下の年齢層が使用されます。
- age13-17
- age18-24
- age25-34
- age35-44
- age45-54
- age55-64
- age65-
- gender (コア ディメンション)
- このディメンションでは、レポートデータに関連付けられているログイン ユーザーの性別を確認できます。
有効な値は
female
、male
、user_specified
です。This is a core dimension and is subject to the Deprecation Policy.
例
以下のサンプル リクエストでは、ユーザー属性ディメンションを使用しています。
チャンネルの例
-
ユーザー属性
- カリフォルニア州の視聴者のユーザー属性(年齢層と性別)
- カリフォルニア州の再生リストの視聴者ユーザー属性(年齢層と性別)
-
ユーザー属性
コンテンツ所有者の例
-
ユーザー属性
- カリフォルニア州の視聴者のユーザー属性(年齢層と性別)
- カリフォルニア州の再生リストの視聴者ユーザー属性(年齢層と性別)
-
ユーザー属性
エンゲージメントとコンテンツ共有
- sharingService (コア ディメンション)
- このディメンションは、動画の共有に使用されたサービスを識別します。YouTube(または YouTube プレーヤー)で [共有] ボタンを使用して、動画を共有することができます。This is a core dimension and is subject to the Deprecation Policy.
有効なディメンション値を次の表に示します。
共有サービス API 値 Ameba AMEBA
Android メール ANDROID_EMAIL
Android メッセンジャー ANDROID_MESSENGER
Android のメッセージ機能 ANDROID_MMS
Blackberry Messenger BBM
Blogger BLOGGER
クリップボードにコピー COPY_PASTE
サイワールド CYWORLD
Digg DIGG
Dropbox DROPBOX
Embed EMBED
メールアドレス MAIL
Facebook FACEBOOK
Facebook Messenger FACEBOOK_MESSENGER
Facebook のページ FACEBOOK_PAGES
フォトカ FOTKA
Gmail GMAIL
goo GOO
Google+ GOOGLEPLUS
SMS を利用 GO_SMS
GroupMe GROUPME
ハングアウト HANGOUTS
hi5 HI5
HTC テキスト メッセージ HTC_MMS
Google 受信トレイ INBOX
iOS システム アクティビティ ダイアログ IOS_SYSTEM_ACTIVITY_DIALOG
KAKAO のストーリー KAKAO_STORY
Kakao(Kakao Talk) KAKAO
Kik KIK
LGE のメール LGE_EMAIL
線 LINE
LinkedIn LINKEDIN
LiveJournal LIVEJOURNAL
メネアーム MENEAME
mixi MIXI
Motorola のメッセージ MOTOROLA_MESSAGING
Myspace MYSPACE
Naver NAVER
ニアバイシェア NEARBY_SHARE
NUjij NUJIJ
Odnoklassniki(の役割) ODNOKLASSNIKI
Other OTHER
Pinterest PINTEREST
楽天市場 RAKUTEN
Google.com REDDIT
Skype SKYPE
スカイロック SKYBLOG
Sony Conversations SONY_CONVERSATIONS
StumbleUpon STUMBLEUPON
Telegram TELEGRAM
テキスト メッセージ TEXT_MESSAGE
トゥエンティ TUENTI
tumblr. TUMBLR
Twitter TWITTER
不明 UNKNOWN
Verizon メッセージ VERIZON_MMS
Viber VIBER
VKontakte(が考慮されます) VKONTAKTE
WeChat WECHAT
Weibo WEIBO
WhatsApp WHATS_APP
ウィコップ WYKOP
Yahoo! 日本 YAHOO
のヒント YOUTUBE_GAMING
YouTube Kids YOUTUBE_KIDS
YouTube Music YOUTUBE_MUSIC
YouTube TV YOUTUBE_TV
詳しくは、ヘルプ ドキュメントをご覧ください。
例
以下のサンプル リクエストでは、ソーシャル ディメンションを使用しています。
視聴者維持率
- elapsedVideoTimeRatio
- このディメンションでは、動画の長さに対する動画の経過時間の割合を指定します。維持率のディメンションと指標は、視聴者維持率の推移を測定するために使用されます。
elapsedVideoTimeRatio
ディメンションは、時間の測定値です。たとえば、値が0.4
の場合、対応するレポートデータは、動画が 40% 経過した後の維持率データを示します。
API は、0.01
~1.0
の範囲の比率の値を使用して、動画ごとに 100 個のデータポイントを返します。動画再生中にデータが測定される時間は、動画ごとに均等に離されます。つまり、2 分間の動画の場合、データポイントの間隔は 1.2 秒です。ただし、2 時間の動画の場合、データポイントの間隔は 72 秒です。ディメンションの値は、区間の終了値(排他的終了値)を示します。 - audienceType (フィルタのみ)
- ディメンション値は、レポートデータに関連付けられたトラフィックの種類を示します。
サポートされる値は
ORGANIC
、AD_INSTREAM
、AD_INDISPLAY
です。これらのトラフィック ソースの種類について詳しくは、YouTube ヘルプセンターをご覧ください。
注:audienceType
フィルタでは 2013 年 9 月 25 日以降のデータを確認できます。フィルタを使用して以前の日付のデータを取得しようとするクエリでは、API はデータを返しません。このフィルタを使用しないクエリは、2008 年 7 月 1 日以降の日付で機能します。
例
次のサンプル リクエストでは、視聴者維持率ディメンションを使用しています。
広告のパフォーマンス
- adType
adType
ディメンションは、広告のパフォーマンス レポートで使用され、動画の再生中に配信された広告のタイプに基づいてリクエストされた指標を集計します。 以下に、使用可能なディメンション値を示します。YouTube の広告フォーマットについて詳しくは、YouTube ヘルプセンターをご覧ください。
-
auctionBumperInstream
– オークションによって配置される最大 6 秒のスキップ不可の動画広告で、最後まで見ないと動画を視聴できません。 -
auctionDisplay
– 動画プレーヤーの下部にオーバーレイとして、または動画再生ページに 300×250 の広告ユニット、あるいはその両方で表示されるリッチメディアまたはイメージ広告。オーバーレイの実行時に、一定時間表示された後に自動的に閉じますが、ユーザーが手動で閉じることもできます。オーバーレイとバナーが同時に表示された場合、各広告は個別のインプレッションとしてカウントされます。 -
auctionInstream
– メイン動画の再生前、再生中、または再生後に表示されるスキップ不可の動画広告。 -
auctionTrueviewInslate
– 動画の前に表示される選択肢から動画広告を 1 つ視聴者が選択します。See the TrueView documentation for more information. -
auctionTrueviewInstream
– メイン動画の再生前または途中で表示されるスキップ可能な動画広告。 詳しくは、TrueView のドキュメントをご覧ください。 -
auctionUnknown
– AdWords オークションで購入されたものの、他の広告タイプに分類されていない広告。 -
reservedBumperInstream
– 最長 6 秒のスキップ不可の動画広告で、予約ベースで販売されます。最後まで再生しないと動画を視聴できません。 -
reservedClickToPlay
– 再生を開始するためにユーザーがクリックする必要がある動画広告。広告のインプレッションは、ユーザーが再生を開始するかどうかに関係なく、Click-to-Play 広告が表示されるたびに記録されます。これらの広告は予約ベースで販売されます。 -
reservedDisplay
– 動画プレーヤーの下部にオーバーレイとして、または動画再生ページに 300×250 の広告ユニット、あるいはその両方で表示されるリッチメディアまたはイメージ広告。オーバーレイの実行時に、一定時間表示された後に自動的に閉じますが、ユーザーが手動で閉じることもできます。オーバーレイとバナーが同時に表示された場合、各広告は個別のインプレッションとしてカウントされます。 -
reservedInstream
– メイン動画の再生前、再生中、または再生後に挿入されるスキップ不可の動画広告。 -
reservedInstreamSelect
-
reservedMasthead
– トップページに表示される大きな広告。動画やグラフィック要素を含めることができます。 -
reservedUnknown
– 他の広告タイプに分類できない予約ベースで販売された広告。 -
unknown
– この広告タイプを分類できませんでした。
-
例
次のサンプル レポートは、広告のパフォーマンスまたは収益の指標を取得します。
チャンネルの例
-
収益/広告
- チャンネルの収益と広告のパフォーマンスに関する指標
- 日々の収益と広告のパフォーマンスに関する指標
- 国別の収益と広告の掲載結果の指標
- トップ 10 – 収益が最も高い動画
- 広告タイプ別の広告の掲載結果の指標
-
収益/広告
コンテンツ所有者の例
-
収益/広告
- 申し立てが行われたコンテンツの収益と広告の掲載結果の指標
- 日々の収益と広告のパフォーマンスに関する指標
- 国別の収益と広告の掲載結果の指標
- トップ 10 – 収益が最も高い動画
- 広告タイプ別の広告の掲載結果の指標
-
収益/広告
再生リスト
- isCurated (フィルタのみ)
- このフィルタは、再生リストのコンテキスト内で発生した動画再生回数に関するデータを取得していることを示します。このフィルタは再生リスト レポートに必須で、値を
1
に設定する必要があります。
例
再生リスト レポートを取得するすべてのサンプル リクエストでは、isCurated
フィルタを使用します。
コンテンツ所有者ディメンション
以下のディメンションは、コンテンツ所有者レポートでのみサポートされています。
- claimStatus(コンテンツ所有者レポートでのみ使用)
- このディメンションを使用すると、申し立てが行われたコンテンツの指標のみが API レスポンスに含まれるように指定できます。このディメンションで有効な値は
claimed
のみです。filters
パラメータによってクエリがclaimedStatus==claimed
に制限されている場合、API は申し立てが行われたコンテンツのデータのみを取得します。このディメンションの使用方法の詳細については、uploaderType
ディメンションの定義の表をご覧ください。
- uploaderType(コア ディメンション) (コンテンツ所有者レポートでのみ使用)
- このディメンションでは、指定したコンテンツ所有者がアップロードしたコンテンツや第三者がアップロードしたコンテンツ(ユーザーがアップロードした動画など)の指標を API レスポンスに含めるかどうかを指定できます。有効な値は
self
とthirdParty
です。これは主要なディメンションであり、非推奨ポリシーの対象となります。
以下の表に、claimedStatus
ディメンションとuploaderType
ディメンションのサポートされる組み合わせを示します。これらはどちらもfilters
パラメータで使用されます。
claimedStatus
値uploaderType
値説明 [未設定] self コンテンツ所有者によってアップロードされた、申し立てを行ったコンテンツと申し立てなしのコンテンツの YouTube アナリティクス データを取得します。 申し立て済み [未設定] コンテンツ所有者または第三者によってアップロードされた、申し立てが行われたコンテンツのデータを取得します。 申し立て済み self コンテンツ所有者によってアップロードされた、申し立てが行われたコンテンツのデータを取得します。 申し立て済み thirdParty 第三者によってアップロードされた申し立てが行われたコンテンツのデータを取得します。
例
コンテンツ所有者レポートのサンプル API リクエストの多くは、claimedStatus
ディメンションと uploaderType
ディメンションのサポートされている組み合わせを使用してデータをフィルタしています。