Videos: batchGetStats

检索与 API 请求参数匹配的视频统计信息列表。

配额影响: 调用此方法的配额费用为 1 个单位。

请求

HTTP 请求

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

授权

若要针对非公开视频使用此方法,必须进行身份验证,但对于公开视频则无需进行身份验证。如果提供了授权,则必须使用以下至少一个范围对请求进行授权(详细了解身份验证和授权)。

范围
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 参数用于指定一个或多个 videoStat 资源属性的逗号分隔列表,API 响应将包含这些属性。

以下列表包含您可以包含在参数值中的 part 名称:
  • contentDetails
  • id
  • snippet
  • statistics
可选参数
onBehalfOfContentOwner string
此参数只能在经过适当授权的请求中使用注意: 此参数仅供 YouTube 内容合作伙伴使用。

onBehalfOfContentOwner 参数表示请求的授权凭据标识的是一个 YouTube 内容管理系统 (CMS) 用户,该用户代表参数值中指定的内容所有者行事。此参数适用于拥有和管理许多不同 YouTube 频道的 YouTube 内容合作伙伴。它允许内容所有者进行一次身份验证,即可访问其所有视频和频道数据,而无需为每个频道提供身份验证凭据。用户进行身份验证时使用的 CMS 账号必须与指定的 YouTube 内容所有者相关联。

请求正文

调用此方法时,请勿提供请求正文。

响应

如果成功,此方法将返回采用以下结构的响应正文:

{
  "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 方法的错误消息。不过,此方法仍可能会返回错误消息文档中列出的一般 API 错误。