GuideCategories: list

注: これは非推奨のお知らせです。

guideCategories リソースと guideCategories.list メソッドは、2020 年 9 月 9 日をもって非推奨となりました。

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

割り当てへの影響: このメソッドの呼び出しには、1 ユニットの割り当て費用が発生します。

リクエスト

HTTP リクエスト

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

パラメータ

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

パラメータ
必須パラメータ
part string
part パラメータは、API レスポンスに含める guideCategory リソース プロパティを指定します。パラメータ値を snippet に設定します。
フィルタ （次のパラメータのいずれか 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 です。

リクエストの本文

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

Response

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

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

プロパティ

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

プロパティ
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 (404) notFound id パラメータで指定されたガイド カテゴリが見つかりません。guideCategories.list メソッドを使用して、有効な値のリストを取得します。

試してみよう:

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