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.meet.readonly
  • https://www.googleapis.com/auth/drive.readonly

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