Um recurso channelSection
contém informações sobre um conjunto de
vídeos que um canal escolheu destacar. Por exemplo, uma seção pode apresentar os envios mais recentes
de um canal, vídeos mais famosos ou vídeos de uma ou mais playlists.
O canal pode criar até 10 estantes.
Métodos
A API é compatível com os seguintes métodos para recursos channelSections
:
- list
- Retorna uma lista de recursos
channelSection
que correspondem aos critérios da solicitação de API. Faça um teste. - inserir
- Adiciona uma seção do canal ao canal do usuário autenticado. Um canal pode criar até 10 estantes. Faça um teste agora.
- update
- Atualiza uma seção de canal. Faça um teste agora.
- delete
- Exclui uma seção do canal. Faça um teste agora.
Representação de recurso
A estrutura JSON a seguir mostra o formato de um recurso channelSections
:
{ "kind": "youtube#channelSection", "etag": etag, "id": string, "snippet": { "type": string, "channelId": string, "title": string, "position": unsigned integer }, "contentDetails": { "playlists": [ string ], "channels": [ string ] } }
Propriedades
A tabela a seguir define as propriedades que aparecem neste recurso:
Propriedades | |
---|---|
kind |
string Identifica o tipo do recurso da API. O valor será youtube#channelSection . |
etag |
etag A ETag deste recurso. |
id |
string O ID que o YouTube usa para identificar de forma exclusiva a seção do canal. |
snippet |
object O objeto snippet contém detalhes básicos sobre a seção do canal, como tipo e título. |
snippet.type |
string Tipo da seção do canal. Os valores válidos para essa propriedade são:
|
snippet.channelId |
string O ID que o YouTube usa para identificar de forma exclusiva o canal que publicou a seção do canal. |
snippet.title |
string O título da seção. Só é possível definir o título de uma seção do canal que tenha um valor de snippet.type para multiplePlaylists ou multipleChannels e, de fato, é necessário especificar um título ao inserir ou atualizar um desses tipos de seção. Se você especificar um título para outros tipos de seções do canal, o valor será ignorado.O valor desta propriedade tem um comprimento máximo de 100 caracteres e pode conter todos os caracteres UTF-8 válidos, exceto < e >. |
snippet.position |
unsigned integer A posição da seção na página do canal. Essa propriedade usa um índice com base em zero. O valor 0 identifica a primeira seção que aparece no canal, o valor 1 identifica a segunda e assim por diante.Se você não especificar um valor para essa propriedade ao inserir uma seção do canal, o comportamento padrão será mostrar a nova seção por último. |
contentDetails |
object O objeto contentDetails contém detalhes sobre o conteúdo da seção do canal, como uma lista de playlists ou canais em destaque. |
contentDetails.playlists[] |
list Lista de um ou mais IDs de playlists apresentados em uma seção do canal. É necessário especificar uma lista de IDs de playlist se a propriedade snippet.type do recurso channelSection for singlePlaylist ou multiplePlaylists . Essa propriedade não deve ser especificada para outros tipos de seções. Se o tipo for singlePlaylist , a lista precisará especificar exatamente um ID de playlist. |
contentDetails.channels[] |
list Lista de um ou mais IDs de canais em destaque em uma seção do canal. Se a propriedade snippet.type do recurso channelSection for multipleChannels , será necessário especificar uma lista de IDs de canal. Essa propriedade não deve ser especificada para outros tipos de seções. Não é possível incluir seu próprio canal na lista. |