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 に指示します。レスポンスには、チャンネルやチャンネル内の動画に関するコメントを含めることができます。
channelId string
channelId パラメータは、指定したチャンネルに関するコメントを含むコメント スレッドを返すように API に指示します。(回答は、チャンネルにアップロードされた動画に投稿されたコメントは含まれません)。
id string
id パラメータでは、取得するリソースのコメント スレッド ID のカンマ区切りのリストを指定します。
videoId string
videoId パラメータは、指定された動画 ID に関連付けられたコメント スレッドを返すように API に指示します。
オプション パラメータ
maxResults unsigned integer
maxResults パラメータは、結果セットで返される商品アイテムの最大数を指定します。

注: このパラメータは、id パラメータと組み合わせて使用することはできません。有効な値は 1100(指定した値を含む)です。デフォルト値は 20 です。
moderationStatus string
このパラメータは、適切に承認されたリクエストでのみ使用できます。このパラメータを設定すると、返されたコメント スレッドを特定の管理ステータスに制限できます。

注: このパラメータは、id パラメータとの併用ではサポートされません。デフォルト値は published です。

有効な値は次のとおりです。
  • heldForReview - モデレーターによる審査待ちとなっているコメント スレッドを取得します。トップレベル コメントまたはそのコメントに対する返信の少なくとも 1 つが審査待ちの場合、コメント スレッドをレスポンスに含めることができます。
  • likelySpam - スパムの可能性があると分類されたコメント スレッドを取得します。トップレベル コメントや、そのコメントに対する返信の少なくとも 1 つがスパムであると考えられる場合は、コメント スレッドをレスポンスに含めることができます。
  • published - 公開されたコメントのスレッドを取得します。これがデフォルト値です。トップレベルのコメントが公開されている場合は、コメント スレッドをレスポンスに含めることができます。
order string
order パラメータは、コメント スレッドを一覧表示する順番を指定します。有効な値は次のとおりです。
  • 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 権限が不足しているため、リクエストされたコメント スレッドを取得できません。リクエストが適切に認証されない可能性があります。
notFound (404) channelNotFound channelId パラメータまたは allThreadsRelatedToChannelId パラメータで特定されるチャネルが見つかりませんでした。
notFound (404) commentThreadNotFound 指定されたコメント スレッドが見つかりません。リクエストの id パラメータの値が正しいことを確認してください。
notFound (404) videoNotFound videoId パラメータで識別された動画が見つかりませんでした。

実習

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