API リクエスト条件に一致する channelSection
リソースのリストを返します。
割り当てへの影響: このメソッドを呼び出すと、割り当てコストは 1 単位になります。
一般的なユースケース
リクエスト
HTTP リクエスト
GET https://www.googleapis.com/youtube/v3/channelSections
パラメータ
次の表に、このクエリがサポートするパラメータを示します。このリストのパラメータはすべてクエリ パラメータです。
パラメータ | ||
---|---|---|
必須パラメータ | ||
part |
string part パラメータでは、API レスポンスに含める 1 つ以上の channelSection リソース プロパティのカンマ区切りリストを指定します。このパラメータで子プロパティを含むプロパティを指定すると、その子プロパティがレスポンスに含まれます。たとえば、 channelSection リソースでは、snippet プロパティに、セクションの表示タイトルなど、他のプロパティが含まれています。part=snippet を設定すると、API レスポンスには、そのネストされたプロパティがすべて含まれます。次のリストには、パラメータ値に指定できる part 名が含まれています。
|
|
フィルタ(次のパラメータのいずれか 1 つのみを指定) | ||
channelId |
string channelId パラメータでは YouTube チャンネル ID を指定します。リクエストでこのパラメータの値を指定すると、API は指定されたチャンネルのセクションのみを返します。 |
|
id |
string id パラメータには、取得する channelSection リソースを一意に識別する ID のカンマ区切りのリストを指定します。channelSection リソースで、id プロパティにセクション ID を指定します。 |
|
mine |
boolean このパラメータは、適切に承認されたリクエストでのみ使用できます。このパラメータの値を true に設定すると、認証済みユーザーの YouTube チャンネルに関連付けられたチャンネル セクションのフィードを取得できます。 |
|
オプション パラメータ | ||
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 リクエスト条件に一致する ChannelSection のリスト。 |
エラー
次の表に、このメソッドの呼び出しに応じて API から返される可能性のあるエラー メッセージを示します。詳細については、エラー メッセージのドキュメントを参照してください。
エラーのタイプ | エラーの詳細 | 説明 |
---|---|---|
forbidden (403) |
channelSectionForbidden |
リクエストしたユーザーは、リクエストされたチャンネル セクションにアクセスできません。 |
invalidValue (400) |
idInvalid |
リクエストに無効なチャネル セクション ID が指定されています。 |
invalidValue (400) |
invalidCriteria |
フィルタ条件が無効であるため、リクエストを完了できませんでした。 |
notFound (404) |
channelNotFound |
リクエストに関連付けられているチャンネルが見つかりません。 |
notFound (404) |
channelSectionNotFound |
リクエストに関連付けられたチャンネル セクションが見つかりません。 |
実習
APIs Explorer を使用してこの API を呼び出し、API のリクエストとレスポンスを確認します。