comment 资源包含有关单个 YouTube 评论的信息。comment 资源可以表示有关视频或频道的评论。此外,该评论可以是顶级评论,也可以是对顶级评论的回复。
方法
该 API 支持以下适用于 comments 资源的方法:
资源表示法
以下 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,
"imageUrl": string
}
}属性
下表定义了此资源中显示的属性:
| 属性 | |
|---|---|
kind |
string用于标识 API 资源的类型。该值为 youtube#comment。 |
etag |
etag相应资源的 ETag。 |
id |
stringYouTube 用于唯一标识相应评论的 ID。 |
snippet |
objectsnippet 对象包含有关评论的基本详细信息。 |
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.list 和 commentThreads.list 方法都支持 textFormat 参数,用于指定所选的文本格式。)即使是纯文本也可能与原始评论文本不同。例如,它可能会将视频链接替换为视频标题。 |
snippet.textOriginal |
string评论的原始纯文本,即评论最初发布或上次更新时的文本。只有经过身份验证的用户是相应评论的作者时,系统才会向其返回原始文本。 |
snippet.parentId |
string父评论的唯一 ID。仅当评论是作为对另一条评论的回复提交时,才会设置此属性。 |
snippet.canRate |
boolean此设置用于指明当前查看者是否可以对评论进行评分。 |
snippet.viewerRating |
string观看者对此评论给出的评分。此属性不会标识 dislike 评分,不过此行为可能会发生变化。与此同时,如果观看者对评论给出了好评,则该属性值为 like。在所有其他情况下,该值为 none,包括用户对相应评论给出了负面评分或未对相应评论进行评分。此属性的有效值为:
|
snippet.likeCount |
unsigned integer相应评论获得的点赞(正面评价)总数。 |
snippet.moderationStatus |
string评论的审核状态。只有在 API 请求获得频道或视频所有者的授权(频道或视频中包含所请求的评论)后,系统才会返回此属性。此外,如果 API 请求使用了 id 过滤条件参数,则不会设置此属性。此属性的有效值为:
|
snippet.publishedAt |
datetime评论最初发布时的日期和时间。该值以 ISO 8601 格式指定。 |
snippet.updatedAt |
datetime相应评论上次更新的日期和时间。该值以 ISO 8601 格式指定。 |
snippet.imageUrl |
string附加到评论的图片或 GIF 动画的网址(如有)。仅当评论包含图片或 GIF 时,此属性才会存在。该网址以签名链接的形式提供,存留时间 (TTL) 为 6 小时,会在检索 6 小时后过期。 |