Method: comments.list

列出文件的评论。

HTTP 请求

GET https://www.googleapis.com/drive/v3/files/{fileId}/comments

网址采用 gRPC 转码语法。

路径参数

参数
fileId

string

文件的 ID。

查询参数

参数
includeDeleted

boolean

是否包含已删除的评论。删除的评论将不会包含其原始内容。

pageSize

integer

每页返回的评论数量上限。

pageToken

string

用于在下一页中继续执行上一个列表请求的令牌。此字段应设置为“nextPageToken”的值从上一个响应中返回的信息。

startModifiedTime

string

“modifyTime”的最小值(RFC 3339 日期时间)。

请求正文

请求正文必须为空。

响应正文

一个文件评论列表。

如果成功,响应正文将包含结构如下的数据:

JSON 表示法
{
  "kind": string,
  "comments": [
    {
      object (Comment)
    }
  ],
  "nextPageToken": string
}
字段
kind

string

指明资源的类型。值:固定字符串 "drive#commentList"

comments[]

object (Comment)

评论列表。如果填充了 nextPageToken,则此列表可能不完整,应再提取一页结果。

nextPageToken

string

下一页评论的页面令牌。如果已达到评论列表的末尾,则不会显示此项。如果令牌因任何原因而被拒绝,则应将其舍弃,并且应从结果的第一页重新开始分页。页面令牌通常在几个小时内有效。不过,如果添加或移除了新项,您的预期结果可能会有所不同。

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/drive.meet.readonly
  • https://www.googleapis.com/auth/drive.readonly

部分范围受到限制,需要对应用进行安全评估才能使用。有关详情,请参阅授权指南