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 表示法
{
  "kind": string,
  "selfLink": string,
  "nextLink": string,
  "items": [
    {
      object (Comment)
    }
  ],
  "nextPageToken": string
}
欄位
kind

string

一律為 drive#commentList

items[]

object (Comment)

註解清單。如果填入 nextPageToken,則可能不完整,系統應該會擷取額外的結果頁面。

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.readonly

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