Comments

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

方法

对于 comments 资源,该 API 支持以下方法:

list
返回与 API 请求参数匹配的注释列表。立即试用
insert
创建对现有评论的回复。注意:如需创建顶级评论,请使用 commentThreads.insert 方法。立即试用
update
修改评论。 立即试用
删除
删除评论。 立即试用
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 格式指定。