channelSection
リソースには、チャンネルがおすすめとして選択した一連の動画に関する情報が含まれます。たとえば、チャンネルの最新アップロード、特に人気の高いアップロード、1 つまたは複数の再生リストの動画などをセクションとして表示できます。
1 つのチャンネルに最大 10 個のセクションを作成できます。
Methods
API は、channelSections
リソースに対して次のメソッドをサポートしています。
リソース表現
次の JSON 構造は、channelSections
リソースの形式を示しています。
{ "kind": "youtube#channelSection", "etag": etag, "id": string, "snippet": { "type": string, "channelId": string, "title": string, "position": unsigned integer }, "contentDetails": { "playlists": [ string ], "channels": [ string ] } }
プロパティ
次の表は、このリソースで使用されているプロパティの定義を示したものです。
プロパティ | |
---|---|
kind |
string API リソースのタイプを識別します。値は youtube#channelSection です。 |
etag |
etag このリソースの Etag。 |
id |
string チャンネル セクションを一意に識別するために YouTube によって使用される ID。 |
snippet |
object snippet オブジェクトには、チャンネル セクションに関する基本情報(タイプやタイトルなど)が格納されます。 |
snippet.type |
string チャンネル セクションのタイプ。 このプロパティの有効な値は次のとおりです。
|
snippet.channelId |
string チャンネル セクションを公開したチャンネルを一意に識別するために YouTube によって使用される ID。 |
snippet.title |
string セクションのタイトル。設定できるのは、 snippet.type の値が multiplePlaylists または multipleChannels であるチャンネル セクションのタイトルのみです。実際、これらのタイプのセクションを挿入または更新するときにタイトルを指定する必要があります。他のタイプのチャンネル セクションにタイトルを指定した場合、値は無視されます。このプロパティの値の最大長は 100 文字で、< と > を除く有効な UTF-8 文字をすべて使用できます。 |
snippet.position |
unsigned integer チャンネル ページでのセクションの位置。このプロパティは 0 ベースのインデックスを使用します。値 0 はチャンネルに最初に表示されるセクションを示し、値 1 は 2 番目のセクションを示します。チャンネル セクションを挿入するときにこのプロパティに値を指定しない場合、デフォルトの動作では新しいセクションが最後に表示されます。 |
contentDetails |
object contentDetails オブジェクトには、チャンネル セクションのコンテンツに関する詳細(このセクションで紹介している再生リストやチャンネルのリストなど)が含まれます。 |
contentDetails.playlists[] |
list チャンネル セクションで紹介される 1 つ以上の再生リスト ID のリスト。 channelSection リソースの snippet.type プロパティが singlePlaylist または multiplePlaylists の場合は、再生リスト ID のリストを指定する必要があります。他のタイプのセクションには、このプロパティを指定しないでください。タイプが singlePlaylist の場合、このリストには再生リスト ID を 1 つだけ指定する必要があります。 |
contentDetails.channels[] |
list チャンネル セクションに表示される 1 つ以上のチャンネル ID のリスト。 channelSection リソースの snippet.type プロパティが multipleChannels の場合、チャネル ID のリストを指定する必要があります。他のタイプのセクションにはこのプロパティを指定しないでください。自分のチャンネルをリストに含めることはできません。 |