Channels: list

Observação: o valor de propriedade statistics.subscriberCount do recurso channel foi atualizado para refletir uma alteração na política do YouTube que afeta a maneira como as contagens de inscritos são exibidas. Consulte o Histórico de revisões ou a Central de Ajuda do YouTube para mais informações.

Retorna um conjunto de zero ou mais recursos channel que correspondem aos critérios da solicitação.

Impacto da 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/channels

Autorização

Uma solicitação que recupera a parte do auditDetails de um recurso channel precisa fornecer um token de autorização que contenha o escopo https://www.googleapis.com/auth/youtubepartner-channel-audit. Além disso, qualquer token que use esse escopo precisará ser revogado quando a RM decidir aceitar ou rejeitar o canal ou até duas semanas após a data de emissão do token.

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 channel que serão incluídas pela resposta da API.

Se o parâmetro identificar uma propriedade que contém propriedades filhas, elas serão incluídas na resposta. Por exemplo, em um recurso channel, a propriedade contentDetails contém outras propriedades, como uploads. Dessa forma, se você definir part=contentDetails, a resposta da API também vai conter todas essas propriedades aninhadas.

A lista a seguir contém os nomes de part que podem ser incluídos no valor do parâmetro:
  • auditDetails
  • brandingSettings
  • contentDetails
  • contentOwnerDetails
  • id
  • localizations
  • snippet
  • statistics
  • status
  • topicDetails
Filtros (especifique exatamente um dos parâmetros a seguir)
categoryId string
Esse parâmetro foi descontinuado. O parâmetro categoryId especificou uma categoria de guia do YouTube e pode ser usado para solicitar canais do YouTube associados a essa categoria.
forHandle string
O parâmetro forHandle especifica um identificador do YouTube, solicitando, assim, o canal associado a ele. O valor do parâmetro pode ser precedido com um símbolo @. Por exemplo, para recuperar o recurso do canal "Google para Desenvolvedores", defina o valor do parâmetro forHandle como GoogleDevelopers ou @GoogleDevelopers.
forUsername string
O parâmetro forUsername especifica um nome de usuário do YouTube, solicitando, assim, o canal associado a esse nome de usuário.
id string
O parâmetro id especifica uma lista separada por vírgulas dos IDs do canal do YouTube para os recursos que estiverem sendo recuperados. Em um recurso channel, a propriedade id especifica o ID do canal do YouTube.
managedByMe boolean
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.

Defina o valor desse parâmetro como true para instruir a API a retornar somente canais gerenciados pelo proprietário do conteúdo especificados pelo parâmetro onBehalfOfContentOwner. O usuário precisa ser autenticado como uma conta do CMS vinculada ao proprietário do conteúdo especificado, e onBehalfOfContentOwner precisa ser fornecido.
mine boolean
Esse parâmetro só pode ser usado em uma solicitação autorizada corretamente. Defina o valor desse parâmetro como true para instruir a API a retornar apenas canais de propriedade do usuário autenticado.
Parâmetros opcionais
hl string
O parâmetro hl instrui a API a recuperar metadados de recursos localizados para um idioma do aplicativo compatível com o site do YouTube. O valor do parâmetro precisa ser um código de idioma incluído na lista retornada pelo método i18nLanguages.list.

Se os detalhes do recurso localizado estiverem disponíveis nesse idioma, o objeto snippet.localized do recurso vai conter os valores localizados. No entanto, se os detalhes localizados não estiverem disponíveis, o objeto snippet.localized vai conter os detalhes do recurso no idioma padrão.
maxResults unsigned integer
O parâmetro maxResults especifica o número máximo de itens que precisam ser retornados no conjunto de resultados. Os valores aceitáveis são de 0 a 50, inclusive. O valor padrão é 5.
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.
pageToken string
O parâmetro pageToken identifica uma página específica no conjunto de resultados que será retornado. Em uma resposta da API, as propriedades nextPageToken e prevPageToken identificam outras páginas que podem ser recuperadas.

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#channelListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    channel 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#channelListResponse.
etag etag
A Etag desse recurso.
nextPageToken string
O token que pode ser usado como o valor do parâmetro pageToken para recuperar a próxima página do conjunto de resultados.
prevPageToken string
O token que pode ser usado como o valor do parâmetro pageToken para recuperar a página anterior do conjunto de resultados. Essa propriedade não será incluída na resposta da API se a solicitação de API correspondente definir o parâmetro managedByMe como true.
pageInfo object
O objeto pageInfo encapsula informações de paginação para o conjunto de resultados.
pageInfo.totalResults integer
O número total de resultados no conjunto de resultados.
pageInfo.resultsPerPage integer
O número de resultados incluídos na resposta da API.
items[] list
A lista dos canais que correspondem 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
badRequest (400) invalidCriteria É possível especificar no máximo um dos seguintes filtros:id, categoryId, mine, managedByMe, forHandle, forUsername. No caso da autenticação do proprietário do conteúdo pelo parâmetro onBehalfOfContentOwner, somente id ou managedByMe podem ser especificados.
forbidden (403) channelForbidden O canal especificado pelo parâmetro id não suporta a solicitação ou a solicitação não está devidamente autorizada.
notFound (404) categoryNotFound A categoria identificada pelo parâmetro categoryId não foi encontrada. Use o método guideCategories.list para recuperar uma lista de valores válidos.
notFound (404) channelNotFound O canal especificado no parâmetro id não foi encontrado.

Confira!

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