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 チャンネル セクションで注目する再生リスト ID のリスト。 channelSection リソースの snippet.type プロパティが singlePlaylist または multiplePlaylists の場合、再生リスト ID のリストを指定する必要があります。このプロパティは他のタイプのセクションで指定しないでください。タイプが singlePlaylist の場合、このリストにはプレイリスト ID を 1 つだけ指定する必要があります。 |
contentDetails.channels[] |
list チャンネルのセクションに表示される 1 つ以上のチャンネル ID のリスト。 channelSection リソースの snippet.type プロパティが multipleChannels の場合、チャネル ID のリストを指定する必要があります。このプロパティは他のタイプのセクションで指定しないでください。自分のチャンネルをリストに含めることはできません。 |