Youtube Analytics APIで定義されている全ての`metrics`内容。(TypeScript)

metricsMaster.ts

/**
 * Youtube Analytics API > `query`内で指定可能なメトリクス一覧。
 * 公式Docs: https://developers.google.com/youtube/analytics/metrics?hl=ja
 */
export const MetricsMaster = {
  viewVideo: {
    /**
     * 動画の閲覧回数。
     * プレイリストが対象のレポートの場合「プレイリスト内部から再生された回数」に絞り込まれた回数となる。
     * ※これ以降の指標も、特に断りなければ「プレイリストが対象のレポートの場合、プレイリスト内部から再生された回数に絞り込まれた回数を示す
     */
    views: "views",
    /**
     * Youtube Premium(旧Youtube Red)メンバーの視聴回数。
     */
    redViews: "redViews",
    /**
     * 動画orプレイリスト再生時にログインしていた視聴者の割合。
     */
    viewerPercentage: "viewerPercentage",
  },
  watchTime: {
    /**
     * 動画の視聴分数。
     */
    estimatedMinutesWatched: "estimatedMinutesWatched",
    /**
     * Youtube Premium(旧Youtube Red)メンバーの動画の視聴分数。
     */
    estimatedRedMinutesWatched: "estimatedRedMinutesWatched",
    /**
     * 動画の平均視聴秒数。
     * ※2021/12/31以降、ループクリップ動画の視聴秒数はカウントされていない。
     */
    averageViewDuration: "averageViewDuration",
    /**
     * バックグラウンドで動画を見ている間に見られた動画の平気割合。
     * ※2021/12/31以降、ループクリップ動画の視聴はカウントされていない。
     */
    averageViewPercentage: "averageViewPercentage",
  },
  Engagement: {
    /**
     * 動画のコメント数。
     */
    comments: "comments",
    /**
     * 高評価数。
     */
    likes: "likes",
    /**
     * 低評価数。
     */
    dislikes: "dislikes",
    /**
     * 動画の「シェア」(共有ボタン)回数。
     */
    shares: "shares",
    /**
     * チャンネル登録回数。
     * ※現在のチャンネル登録者数ではなく、あくまで「チャンネル登録をした回数」。
     * ディメンションやフィルターで特定動画を指定していると、その動画「から」チャンネル登録した回数を指す。
     */
    subscribersGained: "subscribersGained",
    /**
     * チャンネル登録解除回数。
     * ディメンションやフィルターで特定動画を指定していると、その動画「から」チャンネル登録解除した回数を指す。
     */
    subscribersLost: "subscribersLost",
    /**
     * 動画が再生リストに追加された回数。
     * 「後で見る」に追加された数も含む。
     * 2014/10/01より前の回数は取得不可能。
     */
    videosAddedToPlaylists: "videosAddedToPlaylists",
    /**
     * 動画が再生リストから削除された回数。
     * 「後で見る」から削除された数も含む。
     * 2014/10/01より前の回数は取得不可能。
     */
    videosRemovedFromPlaylists: "videosRemovedFromPlaylists",
  },
  /**
   * ※当値はWeb版からの再生のみカウント、アプリ版からの再生はおそらく非カウント。
   */
  playList: {
    /**
     * 再生リストが再生された回数。
     */
    playlistStarts: "playlistStarts",
    /**
     * 再生リスト内の1動画平均視聴者数。
     */
    viewsPerPlaylistStart: "viewsPerPlaylistStart",
    /**
     * 再生リスト内の動画の平均視聴時間分数。
     */
    averageTimeInPlaylist: "averageTimeInPlaylist",
  },
  annotation: {
    /**
     * アノテーションのインプレッション数。
     */
    annotationImpressions: "annotationImpressions",
    /**
     * アノテーションが表示された回数。
     */
    annotationClickableImpressions: "annotationClickableImpressions",
    /**
     * アノテーションがクリックされた回数。
     */
    annotationClicks: "annotationClicks",
    /**
     * アノテーションがクリックされた回数 / インプレッション数。
     */
    annotationClickThroughRate: "annotationClickThroughRate",
    /**
     * アノテーションが閉じられる表示がされた回数。
     */
    annotationClosableImpressions: "annotationClosableImpressions",
    /**
     * 閉じられたアノテーション数。
     */
    annotationCloses: "annotationCloses",
    /**
     * アノテーションが閉じられた回数 / インプレッション数。
     */
    annotationCloseRate: "annotationCloseRate",
  },
  card: {
    /**
     * カードのインプレッション数。
     */
    cardImpressions: "cardImpressions",
    /**
     * カードがクリックされた回数。
     */
    cardClicks: "cardClicks",
    /**
     * カードがクリックされた回数 / インプレッション数。
     */
    cardClickRate: "cardClickRate",
    /**
     * カードのティザーメッセージが表示された回数。
     */
    cardTeaserImpressions: "cardTeaserImpressions",
    /**
     * カードのティザーメッセージがクリックされた回数。
     */
    cardTeaserClicks: "cardTeaserClicks",
    /**
     * カードのティザーメッセージがクリックされた回数 / インプレッション数。
     */
    cardTeaserClickRate: "cardTeaserClickRate",
  },
  audienceRetention: {
    /**
     * ディメンション`elapsedVideoTimeRatio`とセットで使う。
     * 動画の`elapsedVideoTimeRatio`までで示される地点まで、動画を視聴していた視聴者の絶対比率。
     * 例: ある動画の視聴者全員のうち、半分が動画の半分まで行く前に再生をやめ、半分は最後まで見たとする。
     * そしてelapsedVideoTimeRatio=0.5(=動画の半分の地点を示す)で当メトリクスを取得すると、値は`0.5`となる。
     */
    audienceWatchRatio: "audienceWatchRatio",
    /**
     * ディメンション`elapsedVideoTimeRatio`とセットで使う。
     * elapsedVideoTimeRatioで示される地点での継続視聴者率が、同じ動画時間の全てのYoutube上の動画と比較して高いかどうかを示す。
     * 値が`0`: 他の全ての動画と比較して、継続視聴者率が低い
     * 値が`0.5`: 平均的な継続視聴者率
     * 値が`1`: 他の全ての動画と比較して、最も継続視聴者率が高い
     */
    relativeRetentionPerformance: "relativeRetentionPerformance",
  },
  estimatedRevenue: {
    /**
     * 選択した期間と地域における、Googleが販売する広告ソースと非広告ソースからの推定純収益の合計。
     * パートナー販売およびパートナー提供の広告は含まれない。
     * 月末調整の対象となる。
     */
    estimatedRevenue: "estimatedRevenue",
    /**
     * 選択した期間と地域における、Googleが販売する広告ソースからの推定純収益の合計。
     * パートナー販売およびパートナー提供の広告は含まれない。
     * 月末調整の対象となる。
     */
    estimatedAdRevenue: "estimatedAdRevenue",
    /**
     * 対象のレポートorディメンションの YouTube Premium(旧YouTube Red)サブスクリプションから得られる推定収益の合計。
     * 音楽コンテンツと音楽以外のコンテンツの両方からの収益を反映している。
     * 月末調整の対象となる。
     */
    estimatedRedPartnerRevenue: "estimatedRedPartnerRevenue",
  },
  adPerformance: {
    /**
     * 対象期間と地域内の、Google or DoubleClickが販売した全広告からの推定総収益(米ドル)。
     * 総収益であって、推定収益or純収益とは異なる。
     * パートナーが提供する広告は含まれない。
     * 総収益は月末調整の対象となる。
     */
    grossRevenue: "grossRevenue",
    /**
     * 広告インプレッション1000回あたりの推定総収益。
     */
    cpm: "cpm",
    /**
     * 配信された、検証済みの広告インプレッション数。
     */
    adImpressions: "adImpressions",
    /**
     * 視聴者が動画を再生し、最低1つの広告インプレッションが表示されたインスタンスの数。
     * 視聴者にプレロール広告が表示されたが、動画が開始される前に広告の視聴をやめた場合、収益化された再生はカウントされる。
     * この数値の予想される推定誤差は ±2.0%。
     */
    monetizedPlaybacks: "monetizedPlaybacks",
    /**
     * 再生数1000回あたりの推定総収益。
     */
    playbackBasedCpm: "playbackBasedCpm",
  },
};