Um recurso channelSection
contém informações sobre um conjunto de
vídeos que um canal optou por destacar. Por exemplo, uma seção pode mostrar os envios mais recentes
e os mais acessados ou os vídeos de uma ou mais playlists.
Um canal pode criar até 10 seções.
Métodos
A API oferece suporte aos seguintes métodos para recursos channelSections
:
- list
- Retorna uma lista de
channelSection
recursos que correspondem aos critérios de solicitação da API. Teste agora mesmo. - inserir
- Adiciona uma seção de canal ao canal do usuário autenticado. Um canal pode criar até 10 seções. Faça um teste agora.
- update
- Atualiza uma seção do canal. Faça um teste agora.
- excluir
- Exclui uma seção de 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 de recurso da API. O valor será youtube#channelSection . |
etag |
etag A Etag desse 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 O 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 de canal que tenha um valor snippet.type de multiplePlaylists ou multipleChannels . Você também precisa especificar um título ao inserir ou atualizar qualquer um desses tipos de seções. Se você especificar um título para outros tipos de seções de canais, 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 Posição da seção na página do canal. Essa propriedade usa um índice com base em 0. O valor 0 identifica a primeira seção que aparece no canal, o valor 1 indica a segunda seção 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 na seção. |
contentDetails.playlists[] |
list Uma lista de um ou mais IDs de playlists que aparecem 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 , essa lista precisará especificar exatamente um ID de playlist. |
contentDetails.channels[] |
list Uma lista de um ou mais IDs de canais que aparecem em uma seção do canal. Você precisará especificar uma lista de IDs de canal se a propriedade snippet.type do recurso channelSection for multipleChannels . Essa propriedade não precisa ser especificada para outros tipos de seções. Não é possível incluir seu próprio canal na lista. |