ChannelSections: list

API リクエストの条件に一致する channelSection リソースのリストを返します。

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

一般的なユースケース

リクエスト

HTTP リクエスト

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

パラメータ

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

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

子プロパティを含むプロパティがパラメータで識別される場合、子プロパティはレスポンスに含まれます。たとえば、channelSection リソースの snippet プロパティには、セクションの表示タイトルなど、他のプロパティも含まれます。part=snippet を設定すると、API レスポンスにはネストされたプロパティもすべて含まれます。

次のリストは、パラメータ値に含めることができる part 名を示します。
  • contentDetails
  • id
  • snippet
フィルタ（次のパラメータのいずれか 1 つのみを指定）
channelId string
channelId パラメータは YouTube チャンネル ID を指定します。リクエストでこのパラメータの値を指定すると、API は指定されたチャンネルのセクションのみを返します。
id string
id パラメータは、取得する channelSection リソースを一意に識別する ID のカンマ区切りのリストを指定します。channelSection リソースでは、id プロパティにセクションの ID を指定します。
mine boolean
このパラメータは、適切に承認されたリクエストでのみ使用できます。認証されたユーザーの YouTube チャンネルに関連付けられているチャンネル セクションのフィードを取得するには、このパラメータの値を true に設定します。
オプション パラメータ
hl string
このパラメータは非推奨になりました。 hl パラメータは、チャンネル セクションのローカライズされたメタデータを取得するためのサポートを提供します。ただし、YouTube Studio と YouTube アプリでは、この機能のサポートは終了しています。
onBehalfOfContentOwner string
このパラメータは、適切に承認されたリクエストでのみ使用できます。注: このパラメータは YouTube コンテンツ パートナー専用です。

onBehalfOfContentOwner パラメータは、リクエストの認証情報が、パラメータ値で指定されたコンテンツ所有者の代理である YouTube CMS ユーザーを識別することを示します。このパラメータは、複数の YouTube チャンネルを所有、管理している YouTube コンテンツ パートナーを対象にしています。このパラメータを使用すると、コンテンツ所有者は一度認証されれば、すべての動画やチャンネル データにアクセスできるようになります。チャンネルごとに認証情報を指定する必要はありません。ユーザー認証に使用する CMS アカウントは、指定された YouTube コンテンツ所有者にリンクされていなければなりません。

リクエスト本文

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

レスポンス

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

{
  "kind": "youtube#channelSectionListResponse",
  "etag": etag,
  "items": [
    channelSection Resource
  ]
}

プロパティ

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

プロパティ
kind string
API リソースのタイプを識別します。値は youtube#channelSectionListResponse です。
etag etag
このリソースの Etag。
items[] list
リクエスト条件に一致する ChannelSections のリスト。

エラー

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

エラーのタイプ エラーの詳細 説明
forbidden (403) channelSectionForbidden リクエストしたユーザーは、リクエストされたチャンネル セクションにアクセスできません。
invalidValue (400) idInvalid リクエストに無効なチャンネル セクション ID が指定されています。
invalidValue (400) invalidCriteria フィルタ条件が無効であるため、リクエストを完了できませんでした。
notFound (404) channelNotFound リクエストに関連付けられているチャンネルが見つかりません。
notFound (404) channelSectionNotFound リクエストに関連付けられているチャンネル セクションが見つかりません。

試してみよう:

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