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 または plainText に設定すると、ユーザーが残したコメントを HTML 形式または書式なしテキストで返すように API に指示できます。デフォルト値は 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 リクエストとレスポンスを確認します。