本頁面由 Cloud Translation API 翻譯而成。

Comments: list

傳回符合 API 要求參數的註解清單。

配額影響：呼叫此方法的配額費用為 1 單位。

常見用途

要求

HTTP 要求

GET https://www.googleapis.com/youtube/v3/comments

參數

下表列出這項查詢支援的參數。上方列出的所有參數都是查詢參數。

參數
必要參數
`part`	`string` `part` 參數指定以逗號分隔的一或多個清單，其中包含 API 回應將包含的 `comment` 資源屬性。以下清單包含可包含在參數值中的 `part` 名稱： `id` `snippet`
篩選器 (請僅指定下列其中一個參數)
`id`	`string` `id` 參數會擷取以逗號分隔的資源 ID 清單，並擷取擷取的資源。在 `comment` 資源中，`id` 屬性可指定註解的 ID。
`parentId`	`string` `parentId` 參數會指定應擷取回覆內容的留言 ID。注意：YouTube 目前只支援頂層留言。但日後可能會支援回覆功能。
選用參數
`maxResults`	`unsigned integer` `maxResults` 參數會指定要在結果集中傳回的項目數量上限。注意：這個參數無法與 `id` 參數搭配使用。可接受的值為 `1` 到 `100` (含首尾)。預設值為 `20`。
`pageToken`	`string` `pageToken` 參數可指定要傳回結果集中的網頁。在 API 回應中，`nextPageToken` 屬性可識別可供擷取的結果的下一頁。注意：這個參數無法與 `id` 參數搭配使用。
`textFormat`	`string` 此參數表示 API 是否應傳回採用 HTML 格式的文字，或者以純文字格式傳回的註解。預設值為 `html`。可接受的值為： `html` — 以 HTML 格式傳回註解。這是預設值。 `plainText` — 以純文字格式傳回註解。

要求主體

呼叫此方法時請不要提供要求主體。

回應

如果成功的話，這個方法會傳回回應內文，其結構如下：

{
  "kind": "youtube#commentListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    comment Resource
  ]
}

屬性

下表定義此資源中顯示的屬性：

屬性
`kind`	`string` 識別 API 資源類型。這個值會是 `youtube#commentListResponse`。
`etag`	`etag` 這項資源的 Etag。
`nextPageToken`	`string` 這個符記可用做 `pageToken` 參數的值，以擷取結果集的下一頁。
`pageInfo`	`object` `pageInfo` 物件會封裝結果集的分頁資訊。
`pageInfo.totalResults`	`integer` 結果集中的結果總數。
`pageInfo.resultsPerPage`	`integer` API 回應中包含的結果數量。
`items[]`	`list` 符合要求條件的註解清單。

錯誤

下表說明 API 在回應此方法時可能傳回的錯誤訊息。詳情請參閱錯誤訊息說明文件。

錯誤類型	錯誤詳細資料	說明
`badRequest (400)`	`operationNotSupported`	這個 ID 篩選器只能和 Google+ 留言功能相容。
`forbidden (403)`	`forbidden`	權限不足，無法擷取一或多項要求的留言。要求可能未獲適當授權。
`notFound (404)`	`commentNotFound`	找不到一或多則指定的留言。檢查要求的 `id` 和 `parentId` 參數值，確保這些參數正確無誤。

試試看！

使用 APIs Explorer 呼叫這個 API 並查看 API 要求和回應。