管理评论和回复

“评论”是指用户针对某个文件(例如特定内容的查看者)提供的反馈。 提供关于如何改写句子的文字处理文档。有两个 评论类型:锚定评论未锚定评论。锚定广告 评论与特定位置相关联,例如 特定版本的文档中的文字处理文档。相反, 则未锚定评论仅与文档相关联。

回复附加在评论中,表示用户对 评论。借助 Drive API,您的用户可在 创建文档。带回复的评论统称为 进行讨论

添加非锚定评论

如需向文档添加非锚定注释,请使用 fileId 参数和comments.create 包含评论的 comments 资源。

评论以纯文本形式插入,但响应正文会提供 htmlContent 字段,包含按显示格式设置的内容。

添加评论回复

要添加对评论的回复,请调用 replies.create 方法。 fileId 参数和 replies 资源 包含该回复。

回复以纯文本形式插入,但响应正文提供 htmlContent 字段,包含按显示格式设置的内容。

向文档的最新修订版本添加锚定评论

添加评论时,您可能希望将其锚定到文件中的某个区域。一个 anchor,定义文件中要添加注释的文件修订版本和区域 引用的内容。comments 资源定义了 anchor 字段(采用 JSON 字符串形式)。

如需添加锚定评论,请执行以下操作:

  1. (可选)调用 revisions.list 方法列出文档的每个 revisionID。只有在出现以下情况时才需要执行此步骤: 您希望将注释锚定到最新修订版本之外的任何其他修订版本。 如果要使用最新版本,请为 revisionID 使用 head

  2. 调用 comments.create 方法 带有 fileID 参数,即一个 comments 资源(包含注释)和 JSON 定位字符串(包含 revisionID (r) 和区域 (a)。

如何定义区域取决于您处理的文档内容类型 如需了解详情,请参阅定义区域

定义区域

如前所述,JSON 锚字符串包含 revisionID (r) 和 区域 (a)。区域 (a) 是包含区域分类器的 JSON 数组 用于指定评论锚定的格式和位置。分类器 可能是图片的二维矩形、文档中的一行文本, 或视频时长要定义区域,请选择区域 分类器。对于 例如,如果您的内容是文本,那么您可以使用 txtline 区域分类器。

如需查看 Drive API 中的区域分类器列表,请参阅区域 分类器

以下示例展示了将注释锚定到各行的 JSON 锚字符串 在文档的两个单独区域中使用:

  • 第一个区域从第 12 行 ('n':12) 开始,延伸三条线 ('l':3)。
  • 第二个区域仅涵盖第 18 行 ('n':18, 'l':1`)。
    {
      'r': 'REVISION_ID',
      'a': [
      {
        'line':
        {
          'n': 12,
          'l': 3,
        }
      },
      {
        'line':
        {
          'n': 18,
          'l': 1,
        }
      }]
    }

REVISION_ID 替换为 head 或特定应用的 ID 修订版本

将评论标为已解决

使用 comment.update 方法设置 comments 中的 resolved 属性 在评论处理完毕后,将资源发送给 true

当应用将 resolved 属性设置为 true 时,界面应指示 评论已处理完毕。例如,您的应用可能会:

  • 禁止进一步回复,并调暗之前的所有回复和原始回复 评论。
  • 隐藏已解决的评论。

删除评论

使用 comments.delete 方法 删除评论。删除评论后,云端硬盘会将评论标记为 以 "deleted": "true" 格式评论资源。

列出评论

使用 comments.list 方法列出 评论。如果您希望在结果中包含已删除的评论,请将 将 includedDeleted 字段更改为 true