GuideCategories: list

YouTube チャンネルに関連付けることができるカテゴリのリストを返します。 今すぐ試す

リクエスト

HTTP リクエスト

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

パラメータ

下記の表は、このクエリでサポートされているパラメータの一覧です。このリストのパラメータはすべてクエリ パラメータです。

パラメータ
必須パラメータ
part string
part パラメータには、API レスポンスに含める 1 つまたは複数の guideCategory リソース プロパティをカンマ区切りリストの形式で指定します。このパラメータに指定できる part 名は idsnippet です。

このパラメータに子プロパティを持つプロパティが指定されている場合、その子プロパティもレスポンスに含まれます。たとえば、guideCategory リソースの snippet プロパティに、カテゴリのタイトルなど、他のプロパティが含まれているとします。この場合、part=snippet と設定すると、API レスポンスには、ネストされているプロパティもすべて含まれることになります。
フィルタ(以下のパラメータのいずれか 1 つのみを指定します)
id string
id パラメータには、取得するリソースの YouTube チャンネルのカテゴリ ID をカンマ区切りリストの形式で指定します。guideCategory リソースの id プロパティには、YouTube チャンネルのカテゴリ ID を指定します。
regionCode string
regionCode パラメータは、指定された国で使用できるガイド カテゴリのリストを返すように API に指示します。パラメータの値は ISO 3166-1 alpha-2 の国コードです。
省略可能なパラメータ
hl string
hl パラメータには、API レスポンスのテキスト値で使用する言語を指定します。デフォルト値は en-US です。

リクエストの本文

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

レスポンス

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

{
  "kind": "youtube#guideCategoryListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    guideCategories リソース
  ]

}

プロパティ

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

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

エラー

次の表は、このメソッドを呼び出したときに API からレスポンスとして返される可能性のあるエラー メッセージの一覧です。詳細については、エラー メッセージのドキュメントを参照してください。

エラー タイプ エラーの詳細 説明
notFound notFound id パラメータにより特定されるガイド カテゴリは見つかりません。guideCategories.list メソッドを使用して、有効な値のリストを取得してください。

実際に試してみる

API Explorer を使用し、ライブ データに対してこのメソッドを呼び出して、API リクエストとレスポンスを確認してください。