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

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