ChannelSections: list

Retorna uma lista de recursos channelSection que correspondem aos critérios da solicitação de API.

Impacto na cota: uma chamada para esse método tem um custo de cota de uma unidade.

Casos de uso comuns

Solicitação

Solicitação HTTP

GET https://www.googleapis.com/youtube/v3/channelSections

Parâmetros

A tabela a seguir lista os parâmetros compatíveis com essa consulta. Todos os parâmetros listados são os parâmetros de consulta.

Parâmetros
Parâmetros obrigatórios
part string
O parâmetro part especifica uma lista separada por vírgulas de uma ou mais propriedades de recurso channelSection que a resposta da API incluirá.

Se o parâmetro identificar uma propriedade que contenha propriedades filhas, elas serão incluídas na resposta. Por exemplo, em um recurso channelSection, a propriedade snippet contém outras propriedades, como um título de exibição. Se você definir part=snippet, a resposta da API também conterá todas essas propriedades aninhadas.

A lista a seguir contém os nomes part que podem ser incluídos no valor do parâmetro:
  • contentDetails
  • id
  • snippet
Filtros (especifique exatamente um dos seguintes parâmetros)
channelId string
O parâmetro channelId especifica um ID de canal do YouTube. Se uma solicitação especificar um valor para esse parâmetro, a API retornará apenas as seções do canal especificado.
id string
O parâmetro id especifica uma lista separada por vírgulas de IDs que identificam exclusivamente os recursos channelSection que estão sendo recuperados. Em um recurso channelSection, a propriedade id especifica o ID da seção.
mine boolean
Esse parâmetro só pode ser usado em uma solicitação autorizada corretamente. Defina o valor deste parâmetro como true para recuperar um feed das seções do canal associadas ao canal do YouTube do usuário autenticado.
Parâmetros opcionais
hl string
Este parâmetro foi descontinuado. O parâmetro hl fornecia suporte para recuperar metadados localizados de uma seção do canal. No entanto, essa funcionalidade foi descontinuada no YouTube Studio e no app YouTube.
onBehalfOfContentOwner string
Esse parâmetro só pode ser usado em uma solicitação autorizada corretamente. Observação: esse parâmetro é destinado exclusivamente a parceiros de conteúdo do YouTube.

O parâmetro onBehalfOfContentOwner indica que as credenciais de autorização da solicitação identificam um usuário do CMS do YouTube que atua em nome do proprietário do conteúdo especificado no valor do parâmetro. Este parâmetro destina-se a parceiros de conteúdo do YouTube que possuem e gerenciam vários canais do YouTube diferentes. Ele permite que os proprietários de conteúdo autentiquem uma vez e tenham acesso a todos os dados de seu canal e de seus vídeos sem ter que fornecer credenciais de autenticação para cada canal. A conta do CMS com a qual o usuário autentica deve estar vinculada ao proprietário do conteúdo do YouTube especificado.

Corpo da solicitação

Não forneça um corpo de solicitação ao chamar este método.

Resposta

Se for bem-sucedido, esse método retornará um corpo de resposta com esta estrutura:

{
  "kind": "youtube#channelSectionListResponse",
  "etag": etag,
  "items": [
    channelSection Resource
  ]
}

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#channelSectionListResponse.
etag etag
A ETag deste recurso.
items[] list
Uma lista de ChannelSections que corresponde aos critérios de solicitação.

Erros

A tabela a seguir identifica mensagens de erro que a API pode retornar em resposta a uma chamada para esse método. Consulte a documentação mensagem de erro para mais detalhes.

Tipo de erro Detalhe do erro Descrição
forbidden (403) channelSectionForbidden O solicitante não tem permissão para acessar as seções do canal solicitado.
invalidValue (400) idInvalid A solicitação especifica um ID de seção de canal inválido.
invalidValue (400) invalidCriteria Não foi possível concluir a solicitação porque os critérios de filtro são inválidos.
notFound (404) channelNotFound O canal associado à solicitação não foi encontrado.
notFound (404) channelSectionNotFound A seção do canal associada à solicitação não foi encontrada.

Confira!

Use o APIs Explorer para chamar a API e ver a solicitação e a resposta da API.