Videos: batchGetStats

API リクエスト パラメータに一致する動画の統計情報のリストを取得します。

割り当てへの影響: このメソッドの呼び出しには、1 ユニットの割り当てコストがかかります。

リクエスト

HTTP リクエスト

GET https://www.googleapis.com/youtube/v3/videos:batchGetStats

承認

一般公開されていない動画に対してこのメソッドを使用するには認証が必要ですが、一般公開されている動画の場合は必要ありません。承認が提供されている場合、リクエストは少なくとも次のうち 1 つのスコープで承認される必要があります（認証と承認の詳細をご確認ください）。

スコープ
https://www.googleapis.com/auth/youtubepartner
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtube.readonly

パラメータ

次の表に、このクエリでサポートされているパラメータを示します。このリストのパラメータはすべてクエリ パラメータです。

パラメータ
必須パラメータ
id string
id パラメータには、取得するリソースの YouTube 動画 ID のカンマ区切りのリストを指定します。videoStat リソースでは、id プロパティに動画の ID を指定します。
part string
part パラメータには、API レスポンスに含める 1 つ以上の videoStat リソース プロパティのカンマ区切りのリストを指定します。

パラメータ値に含めることができる part 名は次のとおりです。
  • contentDetails
  • id
  • snippet
  • statistics
オプション パラメータ
onBehalfOfContentOwner string
このパラメータは、適切に承認されたリクエストでのみ使用できます。注: このパラメータは、YouTube コンテンツ パートナー専用です。

onBehalfOfContentOwner パラメータは、リクエストの認証情報が、パラメータ値で指定されたコンテンツ所有者の代理として行動する YouTube CMS ユーザーを識別することを示します。このパラメータは、複数の YouTube チャンネルを所有、管理している YouTube コンテンツ パートナーを対象にしています。このパラメータを使用すると、コンテンツ所有者は一度認証されれば、すべての動画やチャンネル データにアクセスできるようになります。チャンネルごとに認証情報を指定する必要はありません。ユーザー認証に使用する CMS アカウントは、指定された YouTube コンテンツ所有者にリンクされていなければなりません。

リクエストの本文

このメソッドを呼び出す場合は、リクエストの本文を指定しないでください。

Response

成功すると、このメソッドは次の構造を含むレスポンスの本文を返します。

{
  "kind": "youtube#batchGetStatsResponse",
  "etag": etag,
  "items": [
    {
      "kind": "youtube#videoStats",
      "etag": etag,
      "id": string,
      "snippet": {
        "publishTime": datetime
      },
      "statistics": {
        "viewCount": unsigned long,
        "likeCount": unsigned long,
        "commentCount": unsigned long
      },
      "contentDetails": {
        "duration": string,
        "durationMillis": unsigned long
      }
    }
  ],
  "summary": {
    "requestedVideoCount": unsigned long,
    "succeededVideoCount": unsigned long,
    "failedVideoCount": unsigned long,
    "failedVideoIds": [
      string
    ]
  }
}

プロパティ

次の表は、このリソースで使用されているプロパティの定義を示したものです。

プロパティ
kind string
API リソースのタイプを識別します。値は youtube#batchGetStatsResponse になります。
etag etag
このリソースの Etag。
items[] list
リクエスト条件に一致する動画の統計情報のリスト。
items[].id string
YouTube が動画を一意に識別するために使用する ID。
items[].snippet.publishTime datetime
動画がアップロードされた日時。
items[].statistics.viewCount unsigned long
動画が再生された回数。
items[].statistics.likeCount unsigned long
動画を高く評価したユーザーの数。
items[].statistics.commentCount unsigned long
動画のコメント数。
items[].contentDetails.duration string
動画の長さ。
items[].contentDetails.durationMillis unsigned long
動画の長さ（ミリ秒単位）。
summary object
batchGetStats リクエストの概要。
summary.requestedVideoCount unsigned long
リクエストされた動画の数。
summary.succeededVideoCount unsigned long
成功した動画の数。
summary.failedVideoCount unsigned long
失敗した動画の数。
summary.failedVideoIds[] list
失敗した動画の ID。

エラー

この API メソッドに固有のエラー メッセージは定義されていません。ただし、このメソッドは、エラー メッセージのドキュメントに記載されている一般的な API エラーを返す可能性があります。