Method: comments.list

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

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

HTTP 要求

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

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

路徑參數

參數
fileId

string

檔案的 ID。

查詢參數

參數
includeDeleted

boolean

是否納入已刪除的留言。系統會移除原始留言，但不會刪除留言內容。
pageSize

integer

每頁傳回的留言數量上限。
pageToken

string

用於在下一頁繼續先前列出要求的符記。這個值應設為上一個回應中的「nextPageToken」值。
startModifiedTime

string

結果註解的「modifiedTime」最小值 (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

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