Comments

comment 资源包含有关单个 YouTube 评论的信息。comment 资源可以表示与视频或频道相关的评论。此外,评论可以是顶级评论,也可以是对顶级评论的回复。

方法

该 API 支持对 comments 资源使用以下方法:

list
返回与 API 请求参数匹配的评论列表。立即试用
insert
创建对现有评论的回复。注意:如需创建顶级注释,请使用 commentThreads.insert 方法。立即试用
update
修改评论。 立即试用
delete
删除评论。 立即试用
setModerationStatus
用于设置一个或多个评论的审核状态。与评论相关联的频道或视频的所有者必须授权该 API 请求。 立即试用
markAsSpam
注意:此方法已废弃,不再受支持。
表示调用方认为一个或多个评论应被标记为垃圾内容。

资源表示法

以下 JSON 结构显示了 comments 资源的格式:

{
  "kind": "youtube#comment",
  "etag": etag,
  "id": string,
  "snippet": {
    "authorDisplayName": string,
    "authorProfileImageUrl": string,
    "authorChannelUrl": string,
    "authorChannelId": {
      "value": string
    },
    "channelId": string,
    "textDisplay": string,
    "textOriginal": string,
    "parentId": string,
    "canRate": boolean,
    "viewerRating": string,
    "likeCount": unsigned integer,
    "moderationStatus": string,
    "publishedAt": datetime,
    "updatedAt": datetime
  }
}

属性

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

属性
kind string
用于标识 API 资源的类型。该值将为 youtube#comment
etag etag
此资源的 ETag。
id string
YouTube 用于唯一标识评论的 ID。
snippet object
snippet 对象包含有关评论的基本详细信息。
snippet.authorDisplayName string
发布评论的用户的显示名称。
snippet.authorProfileImageUrl string
发布评论的用户的头像网址。
snippet.authorChannelUrl string
评论作者的 YouTube 频道的网址(如果有)。
snippet.authorChannelId object
此对象封装了评论作者的 YouTube 频道相关信息(如果有)。
snippet.authorChannelId.value string
评论作者的 YouTube 频道 ID(如果有)。
snippet.channelId string
与评论关联的 YouTube 频道的 ID。
snippet.textDisplay string
评论的文本。您可以以纯文本或 HTML 格式检索文本。(comments.listcommentThreads.list 方法都支持 textFormat 参数,用于指定所选文本格式。)

即使是纯文本也可能与原始评论文本不同。例如,它可能会将视频链接替换为视频标题。
snippet.textOriginal string
评论的原始文本,即评论最初发布或上次更新时的内容。只有在经过身份验证的用户是评论作者的情况下,系统才会将原始文本返回给该用户。
snippet.parentId string
父级评论的唯一 ID。只有在评论是作为对其他评论的回复而提交时,才会设置此属性。
snippet.canRate boolean
此设置表示当前观看者是否可以对评论进行评分。
snippet.viewerRating string
观看者对此评论的评分。此属性不会识别 dislike 评分,但此行为可能会发生变化。与此同时,如果观看者对评论给予了好评,则属性值为 like。在所有其他情况下(包括用户对评论给予负分或未对评论评分),此值均为 none

此属性的有效值如下:
  • like
  • none
snippet.likeCount unsigned integer
评论获得的点赞(正面评分)总数。
snippet.moderationStatus string
评论的审核状态。只有在频道所有者或视频所有者授权 API 请求后,系统才会返回此属性。此外,如果 API 请求使用了 id 过滤条件参数,则不会设置此属性。

此属性的有效值为:
  • heldForReview
  • likelySpam
  • published
  • rejected
snippet.publishedAt datetime
评论的原始发布日期和时间。该值采用 ISO 8601 格式指定。
snippet.updatedAt datetime
评论的最后更新日期和时间。该值采用 ISO 8601 格式指定。