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 1 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 aceitos por 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 recursos channelSection que a resposta da API vai incluir.

Se o parâmetro identificar uma propriedade que contém 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 para a seção. Se você definir part=snippet, a resposta da API também vai conter todas essas propriedades aninhadas.

A lista a seguir contém os nomes part que podem ser incluídos no valor de 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 vai 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 desse 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
Esse parâmetro foi descontinuado. O parâmetro hl oferecia 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 está agindo 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 de recurso da API. O valor será youtube#channelSectionListResponse.
etag etag
O Etag desse recurso.
items[] list
Uma lista de ChannelSections que correspondem aos critérios da solicitação.

Erros

A tabela a seguir identifica as 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 solicitadas.
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 Não foi possível encontrar o canal associado à solicitação.
notFound (404) channelSectionNotFound Não foi possível encontrar a seção do canal associada à solicitação.

Confira!

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