Comments: list

返回与 API 请求参数匹配的评论列表。

配额影响： 调用此方法会消耗 1 个配额单位。

常见应用场景

请求

HTTP 请求

GET https://www.googleapis.com/youtube/v3/comments

参数

下表列出了此查询支持的参数。列出的所有参数都是查询参数。

参数
必需参数
part string
part 参数用于指定一个或多个 comment 资源属性的英文逗号分隔列表，API 响应将包含这些属性。

以下列表包含您可以包含在 part 参数值中的名称：
  • id
  • snippet
过滤条件 （准确指定以下参数之一）
id string
id 参数用于指定要检索的资源的评论 ID 的英文逗号分隔列表。在 comment 资源中，id 属性用于指定评论的 ID。
parentId string
parentId 参数用于指定应检索回复的评论的 ID。

注意： YouTube 目前仅支持对顶级评论进行回复。不过，未来可能会支持对回复进行回复。
可选参数
maxResults unsigned integer
maxResults 参数用于指定结果集中应返回的最大项数。

注意： 此参数不支持与 id 参数结合使用。可接受的值介于 1 到 100（含）之间。默认值为 20。
pageToken string
pageToken 参数用于标识结果集中应返回的特定页面。在 API 响应中，nextPageToken 属性用于标识可以检索的下一页结果。

注意： 此参数不支持与 id 参数结合使用。
textFormat string
此参数用于指明 API 应以 HTML 格式还是纯文本格式返回评论。默认值为 html。

可接受的值包括：
  • html \- 以 HTML 格式返回评论。这是默认值。
  • plainText \- 以纯文本格式返回评论。

请求正文

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

响应

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

{
  "kind": "youtube#commentListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    comment Resource
  ]
}

属性

下表定义了此资源中显示的属性：

属性
kind string
标识 API 资源的类型。该值将为 youtube#commentListResponse。
etag etag
此资源的 ETag。
nextPageToken string
可用作 pageToken 参数值的令牌，用于检索结果集中的下一页。
pageInfo object
pageInfo 对象用于封装结果集的分页信息。
pageInfo.totalResults integer
结果集中的结果总数。
pageInfo.resultsPerPage integer
API 响应中包含的结果数。
items[] list
与请求条件匹配的评论列表。

错误

下表列出了 API 在响应对此方法的调用时可能会返回的出错提示。如需了解详情，请参阅错误消息文档。

错误类型 错误详情 说明
badRequest (400) operationNotSupported ID 过滤条件仅与基于 Google+ 的评论兼容。
forbidden (403) forbidden 由于权限不足，无法检索一条或多条请求的评论。该请求可能未获得适当授权。
notFound (404) commentNotFound 找不到一条或多条指定的评论。请检查请求的 id 和 parentId 参数的值，确保其正确无误。

试试看！

您可以使用 APIs Explorer 调用此 API，查看 API 请求和响应。