Comments: list

傳回符合 API 要求參數的留言清單。

配額影響：呼叫這個方法會產生 1 個單位的配額費用。

常見用途

要求

HTTP 要求

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

參數

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

參數
必要參數
part	string part 參數會指定一或多個 comment 資源屬性，並以逗號分隔，API 回應會包含這些屬性。 下列清單包含可加入參數值的 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 要求和回應。