このページは Cloud Translation API によって翻訳されました。

CommentThreads: list

API リクエストのパラメータに一致するコメントスレッドのリストを返します。

割り当てへの影響: このメソッドの呼び出しには、1 ユニットの割り当てコストが発生します。

一般的なユースケース

リクエスト

HTTP リクエスト

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

パラメータ

次の表に、このクエリでサポートされているパラメータを示します。このリストのパラメータはすべてクエリパラメータです。

パラメータ
必須パラメータ
`part`	`string` `part` パラメータは、API レスポンスに含める 1 つ以上の `commentThread` リソースプロパティのカンマ区切りリストを指定します。次のリストには、パラメータ値に含めることができる `part` 名が含まれています。 `id` `replies` `snippet`
フィルタ（次のパラメータのいずれか 1 つのみを指定）
`allThreadsRelatedToChannelId`	`string` `allThreadsRelatedToChannelId` パラメータは、指定されたチャンネルに関連付けられているすべてのコメントスレッドを返すように API に指示します。
`id`	`string` `id` パラメータには、取得するリソースのコメントスレッド ID のカンマ区切りのリストを指定します。
`videoId`	`string` `videoId` パラメータは、指定された動画 ID に関連付けられたコメントスレッドを返すように API に指示します。
オプションパラメータ
`maxResults`	`unsigned integer` `maxResults` パラメータは、結果セットで返されるアイテムの最大数を指定します。注: このパラメータは、`id` パラメータと組み合わせて使用することはできません。有効な値は `1`～`100` です。デフォルト値は `20` です。
`moderationStatus`	`string` このパラメータは、適切に承認されたリクエストでのみ使用できます。このパラメータを設定すると、返されるコメントスレッドを特定の管理状態に制限できます。注: このパラメータは、`id` パラメータと組み合わせて使用することはできません。デフォルト値は `published` です。指定できる値は次のとおりです。 `heldForReview` – モデレーターによる確認待ちのコメントスレッドを取得します。最上位のコメントまたはコメントに対する 1 つ以上の返信が確認待ちの場合、コメントスレッドを返信に追加できます。 `likelySpam` – スパムの可能性があると分類されたコメントスレッドを取得します。最上位のコメントまたはそのコメントに対する返信の少なくとも 1 つがスパムの可能性があると判断された場合、コメントスレッドが返信に含まれます。 `published` – 公開されたコメントのスレッドを取得します。これはデフォルト値です。最上位のコメントが公開されている場合は、そのコメントスレッドを回答に含めることができます。
`order`	`string` `order` パラメータは、API レスポンスがコメントスレッドをリストする順序を指定します。有効な値は次のとおりです。 `time` - コメントスレッドは時間順に表示されます。これはデフォルトの動作です。 `relevance` - コメントスレッドは関連性の高い順に並べられます。注: このパラメータは、`id` パラメータと組み合わせて使用することはできません。
`pageToken`	`string` `pageToken` パラメータは、結果セットの特定のページを返します。API レスポンスでは、`nextPageToken` プロパティに、取得可能な結果の次のページを指定します。注: このパラメータを `id` パラメータと併用することはできません。
`searchTerms`	`string` `searchTerms` パラメータは、指定した検索キーワードを含むコメントのみが API レスポンスに含まれるように制限するよう API に指示します。注: このパラメータは、`id` パラメータと併用できません。
`textFormat`	`string` ユーザーが追加したコメントを HTML 形式または書式なしテキストで返すように API に指示するには、このパラメータの値を `html` または `plainText` に設定します。デフォルト値は `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`	必要な権限がないため、リクエストされた 1 つ以上のコメントスレッドを取得できません。リクエストが適切に認証されない可能性があります。
`notFound (404)`	`channelNotFound`	`allThreadsRelatedToChannelId` パラメータで特定されたチャンネルが見つかりませんでした。
`notFound (404)`	`commentThreadNotFound`	指定された 1 つ以上のコメントスレッドが見つかりません。リクエストの `id` パラメータの値が正しいことを確認してください。
`notFound (404)`	`videoNotFound`	`videoId` パラメータで特定される動画が見つかりませんでした。

試してみよう:

APIs Explorer を使用してこの API を呼び出し、API のリクエストとレスポンスを確認します。