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

結果註解的「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.readonly

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