Method: comments.list

列出檔案的註解。詳情請參閱「管理留言和回覆」。

必要條件：必須設定 fields 參數。如要傳回所需欄位，請參閱「傳回特定欄位」。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
fileId

string

檔案的 ID。

查詢參數

參數
includeDeleted

boolean

是否要包含已刪除的留言。刪除的留言不會包含原始內容。
pageSize

integer

要傳回的留言數量上限。服務傳回的產品數量可能會少於這個值。

如未指定，最多將傳回 20 則留言。

許可的最大值為 100；超出的數值將一律指定為 100。
pageToken

string

這個符記可用於接續下一頁的先前清單要求。這應設為前一個回應中的「nextPageToken」值。
startModifiedTime

string

結果留言的「modifiedTime」最小值 (RFC 3339 日期時間)。

要求主體

要求主體必須為空白。

回應主體

檔案的註解清單。

如果成功，回應主體會含有以下結構的資料：

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

object (Comment)

留言清單。如果 nextPageToken 已填入值，則這個清單可能不完整，應擷取其他結果頁面。
kind

string

表示資源的種類。值：固定字串 "drive#commentList"。
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

部分範圍受到限制，應用程式必須通過安全評估才能使用。詳情請參閱授權指南。