Method: comments.list

列出檔案的註解。

HTTP 要求

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

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

路徑參數

參數
fileId

string

檔案的 ID。

查詢參數

參數
includeDeleted

boolean

如果設定了這項參數,系統會傳回所有留言和回覆,包括已刪除的留言和回覆 (內容已移除)。

maxResults

integer

回應中要納入的討論數量上限,用於分頁。

pageToken

string

用於分頁瀏覽大型結果集的接續符記。如要取得下一頁的結果,請將這個參數設為前一個回應中的「nextPageToken」值。

updatedMin

string

系統只會傳回在此時間戳記之後更新的討論。格式為 RFC 3339 時間戳記。

要求主體

要求主體必須為空白。

回應主體

Google 雲端硬碟檔案的註解清單。

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

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

object (Comment)

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

kind

string

這個值一律為 drive#commentList

nextPageToken

string

下一頁留言的頁面符記。如果已到達留言清單結尾,就不會顯示這個按鈕。如果系統基於任何原因拒絕符記,就應捨棄該符記,並從第一頁結果重新開始分頁。

授權範圍

需要下列其中一種 OAuth 範圍:

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

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