Comments: list

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

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

一般的なユースケース

リクエスト

HTTP リクエスト

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

パラメータ

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

パラメータ
必須パラメータ
part string
part パラメータには、API レスポンスに含める 1 つ以上の comment リソース プロパティをカンマ区切りのリストで指定します。

次のリストは、パラメータ値に含めることができる part 名を示しています。
  • id
  • snippet
フィルタ（次のパラメータのうち 1 つだけを指定）
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 - コメントを書式なしテキスト形式で返します。

リクエストの本文

このメソッドを呼び出す場合は、リクエストの本文を指定しないでください。

Response

成功すると、このメソッドは次の構造を含むレスポンスの本文を返します。

{
  "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 指定された 1 つ以上のコメントが見つかりません。リクエストの id パラメータと parentId パラメータの値が正しいことを確認します。

試してみよう:

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