REST Resource: comments

资源:注释

对 Google 云端硬盘中的文件的评论。

某些资源方法(例如 comments.update)需要 commentId。使用 comments.list 方法检索文件中评论的 ID。

JSON 表示法
{
  "commentId": string,
  "kind": string,
  "createdDate": string,
  "modifiedDate": string,
  "fileId": string,
  "status": string,
  "anchor": string,
  "replies": [
    {
      object (CommentReply)
    }
  ],
  "author": {
    object (User)
  },
  "deleted": boolean,
  "selfLink": string,
  "htmlContent": string,
  "content": string,
  "context": {
    "type": string,
    "value": string
  },
  "fileTitle": string
}
字段
commentId

string

仅限输出。评论的 ID。

kind

string

仅限输出。始终为 drive#comment

createdDate

string

仅限输出。首次创建此评论的日期。

modifiedDate

string

仅限输出。上次修改此评论或其任何回复的日期。

fileId

string

仅限输出。此评论处理的文件。

status

string

仅限输出。此评论的状态。只需回复具有所需状态的评论,即可更改状态。

  • open - 评论仍处于开放状态。
  • resolved - 该评论已通过其一条回复解决。
anchor

string

以 JSON 字符串表示的文档区域。如需详细了解如何定义锚点属性,请参阅添加评论和回复

replies[]

object (CommentReply)

仅限输出。此帖子的回复。

author

object (User)

仅限输出。评论的作者。系统不会填充作者的电子邮件地址和权限 ID。

deleted

boolean

仅限输出。此评论是否已删除。如果评论已被删除,该内容将被清除,且该评论仅代表曾经存在的评论。

htmlContent

string

仅限输出。此评论的 HTML 格式的内容。

content

string

用于创建此评论的纯文本内容。这并非 HTML 安全,仅应作为修改评论内容的基础。

context

object

正被评论的文件的上下文。

context.type

string

上下文片段的 MIME 类型。

context.value

string

所评论文件片段的数据表示形式。例如,对于文本文件,该参数是评论所要讨论的实际文本。

fileTitle

string

仅限输出。此评论对应的文件的标题。

方法

delete

删除评论。

get

根据 ID 获取评论。

insert

在给定文件上创建新评论。

list

列出文件的评论。

patch

更新现有评论。

update

更新现有评论。