Channels: list

Observação:o valor da propriedade statistics.subscriberCount do recurso channel foi atualizado para refletir uma mudança na política do YouTube que afeta a forma como as contagens de inscritos são mostradas. Para mais informações, consulte a Histórico de revisões ou a Central de Ajuda do YouTube.

Retorna uma coleção de zero ou mais recursos channel que correspondem aos critérios de solicitação.

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

Autorização

Uma solicitação que recupera a parte 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 precisa ser revogado quando a MCN decidir aceitar ou rejeitar o canal ou em até duas semanas após a 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 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 channel, a propriedade contentDetails contém outras propriedades, como uploads. Portanto, 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 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
Este parâmetro foi descontinuado. O parâmetro categoryId especificava uma categoria do guia do YouTube e podia ser usado para solicitar canais do YouTube associados a essa categoria.
forHandle string
O parâmetro forHandle especifica um identificador do YouTube, solicitando o canal associado a ele. O valor do parâmetro pode ser precedido por um símbolo @. Por exemplo, para recuperar o recurso do canal "Google for Developers", 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 o canal associado a ele.
id string
O parâmetro id especifica uma lista separada por vírgulas dos IDs dos canais do YouTube dos recursos que estão 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.

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 apenas os canais gerenciados pelo proprietário do conteúdo especificado pelo parâmetro onBehalfOfContentOwner. O usuário precisa ser autenticado como uma conta do CMS vinculada ao proprietário do conteúdo especificado, e o onBehalfOfContentOwner precisa ser fornecido.
mine boolean
Esse parâmetro só pode ser usado em uma solicitação autorizada. Defina o valor desse parâmetro como true para instruir a API a retornar apenas os canais pertencentes ao usuário autenticado.
Parâmetros opcionais
hl string
O parâmetro hl instrui a API a extrair metadados de recursos localizados para uma língua de aplicativo específica com suporte do 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 detalhes do recurso no idioma padrão dele.
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 aceitos vão de 0 a 50. O valor padrão é 5.
onBehalfOfContentOwner string
Esse parâmetro só pode ser usado em uma solicitação autorizada adequada.

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 precisa ser retornada. 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 do recurso da API. O valor será youtube#channelListResponse.
etag etag
A Etag deste recurso.
nextPageToken string
O token que pode ser usado como o valor do parâmetro pageToken para recuperar a próxima página no conjunto de resultados.
prevPageToken string
O token que pode ser usado como o valor do parâmetro pageToken para recuperar a página anterior no conjunto de resultados. Essa propriedade não é 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
Uma lista de canais 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. Para mais detalhes, consulte API Data do YouTube: erros.

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 de autenticação do proprietário do conteúdo pelo parâmetro onBehalfOfContentOwner, apenas id ou managedByMe podem ser especificados.
forbidden (403) channelForbidden O canal especificado pelo parâmetro id não é compatível com a solicitação ou a solicitação não está autorizada corretamente.
notFound (404) categoryNotFound Não foi possível encontrar a categoria identificada pelo parâmetro categoryId. Use o método guideCategories.list para recuperar uma lista de valores válidos.
notFound (404) channelNotFound Não foi possível encontrar o canal especificado no parâmetro id.

Confira!

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