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

CommentThreads: list

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

配額影響：呼叫這個方法的配額為 1 個單位。

常見用途

要求

HTTP 要求

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

參數

下表列出此查詢支援的參數。這裡列出的參數全都是查詢參數。

參數
必要參數
`part`	`string` `part` 參數會指定一份以半形逗號分隔的清單，其中包含 API 回應會包含的一或多個 `commentThread` 資源屬性。以下清單列出您可以加入參數值的 `part` 名稱： `id` `replies` `snippet`
篩選器 (請僅指定下列其中一個參數)
`allThreadsRelatedToChannelId`	`string` `allThreadsRelatedToChannelId` 參數會指示 API 傳回與指定頻道相關聯的所有註解執行緒。
`id`	`string` `id` 參數會指定要擷取的資源留言執行緒 ID 清單 (以半形逗號分隔)。
`videoId`	`string` `videoId` 參數會指示 API 傳回與指定影片 ID 相關聯的註解執行緒。
選用參數
`maxResults`	`unsigned integer` `maxResults` 參數會指定結果集應傳回的項目數量上限。注意：這個參數不支援與 `id` 參數搭配使用。可接受的值為 `1` 到 `100` (含頭尾)。預設值為 `20`。
`moderationStatus`	`string` 這個參數只能在正確的授權要求中使用。設定這個參數，將傳回的留言執行緒限制為特定審核狀態。注意：這個參數無法與 `id` 參數搭配使用。預設值為 `published`。可接受的值如下： `heldForReview`：擷取正在等待管理員審核的留言串。如果最高層級的留言或至少其中一則留言有待審查的回覆，則留言串會包含在回應中。 `likelySpam`：擷取分類為垃圾內容的留言串。如果頂層留言或至少其中一則回覆可能為垃圾內容，則留言串會包含在回應中。 `published`：擷取已發布留言的執行緒。此為預設值。如果頂層留言已發布，則留言串可以加入回應中。
`order`	`string` `order` 參數會指定 API 回應列出註解執行緒的順序。有效值如下： `time` - 留言討論串依時間排序。此為預設行為。 `relevance` - 留言串依關聯性排序。注意：這個參數不支援與 `id` 參數搭配使用。
`pageToken`	`string` `pageToken` 參數可在結果集中指明應傳回的特定網頁。在 API 回應中，`nextPageToken` 屬性會識別可擷取的下一頁結果。注意：這個參數不支援與 `id` 參數搭配使用。
`searchTerms`	`string` `searchTerms` 參數會指示 API 限制 API 回應，僅使用含有指定搜尋字詞的註解。注意：這個參數無法與 `id` 參數搭配使用。
`textFormat`	`string` 將這個參數的值設為 `html` 或 `plainText`，指示 API 傳回 html 格式或純文字格式使用者留下的註解。預設值為 `html`。可接受的值如下： `html`：傳回 HTML 格式的註解。這是預設值。 `plainText`：以純文字格式傳回註解。

要求主體

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

回應

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

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

屬性

下表定義了這項資源中顯示的屬性：

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

錯誤

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

錯誤類型	錯誤詳細資料	說明
`badRequest (400)`	`operationNotSupported`	「`id`」篩選器僅適用於以 Google+ 為依據的留言功能。
`badRequest (400)`	`processingFailure`	API 伺服器無法成功處理要求。雖然這可能是暫時性錯誤，但通常表示要求的輸入內容無效。檢查要求主體中的 `commentThread` 資源結構，確保資源有效。
`forbidden (403)`	`commentsDisabled`	由 `videoId` 參數識別的影片已停用留言功能。
`forbidden (403)`	`forbidden`	權限不足，無法擷取一或多個要求的註解執行緒。要求可能未獲適當授權。
`notFound (404)`	`channelNotFound`	找不到 `allThreadsRelatedToChannelId` 參數識別的頻道。
`notFound (404)`	`commentThreadNotFound`	找不到一或多個指定的註解串。檢查要求的 `id` 參數值，確認參數正確無誤。
`notFound (404)`	`videoNotFound`	找不到透過 `videoId` 參數辨識的影片。

試試看！

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