VideoCategories: list

YouTube 動画に関連付けることができるカテゴリのリストを返します。

割り当てへの影響: このメソッドを呼び出すと、割り当てコストは 1 単位になります。

一般的なユースケース

リクエスト

HTTP リクエスト

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

パラメータ

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

パラメータ
必須パラメータ
part string
part パラメータでは、API レスポンスに含める videoCategory リソース プロパティを指定します。パラメータ値を snippet に設定します。
フィルタ(次のパラメータのいずれか 1 つのみを指定)
id string
id パラメータでは、取得するリソースの動画カテゴリ ID のカンマ区切りのリストを指定します。
regionCode string
regionCode パラメータは、指定した国で利用可能な動画カテゴリのリストを返すように API に指示します。パラメータ値は ISO 3166-1 alpha-2 の国コードです。
オプション パラメータ
hl string
hl パラメータでは、API レスポンスのテキスト値に使用する言語を指定します。デフォルト値は en_US です。

リクエスト本文

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

レスポンス

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

{
  "kind": "youtube#videoCategoryListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    videoCategory resource
  ]
}

プロパティ

次の表は、このリソースで使用されているプロパティの定義を示したものです。

プロパティ
kind string
API リソースのタイプを識別します。値は youtube#videoCategoryListResponse です。
etag etag
このリソースの Etag。
nextPageToken string
結果セットの次のページを取得するために pageToken パラメータの値として使用できるトークン。
prevPageToken string
結果セットの前のページを取得するために、pageToken パラメータの値として使用できるトークン。
pageInfo object
pageInfo オブジェクトは、結果セットのページ情報をカプセル化します。
pageInfo.totalResults integer
結果セット内の結果の合計数。
pageInfo.resultsPerPage integer
API レスポンスに含まれる結果の数。
items[] list
YouTube 動画に関連付けることができる動画カテゴリのリスト。このマップでは、動画カテゴリ ID はマップキーであり、その値は対応する videoCategory リソースです。

エラー

次の表に、このメソッドの呼び出しに応じて API から返される可能性のあるエラー メッセージを示します。詳細については、エラー メッセージのドキュメントを参照してください。

エラーのタイプ エラーの詳細 説明
notFound (404) videoCategoryNotFound id パラメータで特定された動画カテゴリが見つかりません。有効な値のリストを取得するには、videoCategories.list メソッドを使用します。

実習

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