CommentThreads: list

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

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

常见应用场景

请求

HTTP 请求

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

参数

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

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

以下列表包含您可以在参数值中添加的 part 名称：
  • id
  • replies
  • snippet
过滤条件 （指定以下参数中的一个）
allThreadsRelatedToChannelId string
allThreadsRelatedToChannelId 参数指示 API 返回与指定频道关联的所有评论串。
id string
id 参数用于指定应检索的资源的评论串 ID 的英文逗号分隔列表。
videoId string
videoId 参数指示 API 返回与指定视频 ID 关联的评论串。
可选参数
maxResults unsigned integer
maxResults 参数用于指定结果集中应返回的最大项数。

注意： 此参数不支持与 id 参数结合使用。可接受的值介于 1 到 100 之间（含这两个值）。默认值为 20。
moderationStatus string
此参数只能在经过适当授权的请求中使用。设置此参数可将返回的评论串限制为特定的审核状态。

注意： 此参数不支持与 id 参数结合使用。默认值为 published。

可接受的值包括：
  • heldForReview – 检索等待审核员审核的评论串。如果顶级评论或对该评论的至少一条回复正在等待审核，则该评论串可以包含在响应中。
  • likelySpam – 检索被归类为疑似垃圾内容的评论串。如果顶级评论或对该评论的至少一条回复被认为是疑似垃圾内容，则该评论串可以包含在响应中。
  • published \- 检索已发布评论的串。此设置为默认值。如果评论串的顶级评论已发布，则该评论串可以包含在响应中。
order string
order 参数用于指定 API 响应应列出评论串的顺序。有效值为：
  • time - 评论串按时间排序。这是默认行为。
  • relevance - 评论串按相关性排序。
注意： 此参数不支持与 id 参数结合使用。
pageToken string
pageToken 参数用于标识结果集中应返回的特定页面。在 API 响应中，nextPageToken 属性用于标识可以检索的下一页结果。

注意： 此参数不支持与 id 参数结合使用。
searchTerms string
searchTerms 参数指示 API 将 API 响应限制为仅包含包含指定搜索字词的评论。

注意： 此参数不支持与 id 参数结合使用。
textFormat string
将此参数的值设置为 html 或 plainText，以指示 API 返回用户以 HTML 格式或纯文本格式留下的评论。默认值为 html。

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

请求正文

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

响应

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

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

属性

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

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

错误

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

错误类型 错误详情 说明
badRequest (400) operationNotSupported id 过滤条件仅与基于 Google+ 的评论兼容。
badRequest (400) processingFailure API 服务器未能成功处理请求。虽然这可能是暂时性错误，但通常表示请求的输入无效。检查请求正文中的 commentThread 资源结构，确保其有效。
forbidden (403) commentsDisabled 由 videoId 参数标识的视频已停用评论。
forbidden (403) forbidden 由于权限不足，无法检索一个或多个请求的评论串。该请求可能未获得适当授权。
notFound (404) channelNotFound 找不到由 allThreadsRelatedToChannelId 参数标识的频道。
notFound (404) commentThreadNotFound 找不到一个或多个指定的评论串。检查请求的 id 参数的值，确保其正确无误。
notFound (404) videoNotFound 找不到由 videoId 参数标识的视频。

试试看！

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