API リクエスト パラメータに一致するコメントのリストを返します。
割り当てへの影響: このメソッドを呼び出すと、割り当てコストは 1 単位になります。
一般的なユースケース
リクエスト
HTTP リクエスト
GET https://www.googleapis.com/youtube/v3/comments
パラメータ
次の表に、このクエリがサポートするパラメータを示します。このリストのパラメータはすべてクエリ パラメータです。
パラメータ | ||
---|---|---|
必須パラメータ | ||
part |
string part パラメータには、API レスポンスに含める 1 つ以上の comment リソース プロパティのカンマ区切りリストを指定します。次のリストには、パラメータ値に含めることができる part 名が含まれます。
|
|
フィルタ(次のパラメータのいずれか 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 このパラメータは、コメントを HTML 形式と書式なしテキストのどちらで返すかを指定します。デフォルト値は html です。有効な値は次のとおりです。
|
リクエスト本文
このメソッドを呼び出す場合は、リクエストの本文を指定しないでください。
レスポンス
成功すると、このメソッドは次の構造を含むレスポンスの本文を返します。
{ "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 |
指定されたコメントの中に見つかりません。リクエストの id および parentId パラメータの値が正しいことを確認します。 |
実習
APIs Explorer を使用してこの API を呼び出し、API のリクエストとレスポンスを確認します。