comment
资源包含一条 YouTube 评论的相关信息。comment
资源可以表示关于视频或频道的评论。此外,该评论可以是顶级评论或对顶级评论的回复。
方法
对于 comments
资源,该 API 支持以下方法:
- list
- 返回与 API 请求参数匹配的注释列表。立即试用。
- 插入
- 创建对现有评论的回复。注意:如需创建顶级评论,请使用
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.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 格式指定。 |