GuideCategories: list

Observação:este é um anúncio de suspensão.

O recurso guideCategories e o método guideCategories.list foram suspensos em 9 de setembro de 2020.

Retorna uma lista de categorias que podem ser associadas a canais do YouTube.

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

Solicitação

Solicitação HTTP

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

Parâmetros

A tabela a seguir lista os parâmetros que esta consulta suporta. 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 as propriedades do recurso guideCategory que a resposta da API vai incluir. Defina o valor do parâmetro como snippet.
Filtros (especifique exatamente um dos seguintes parâmetros)
id string
O parâmetro id especifica uma lista separada por vírgulas dos IDs de categoria do canal do YouTube para os recursos que estão sendo recuperados. Em um recurso guideCategory, a propriedade id especifica o ID da categoria do canal do YouTube.
regionCode string
O parâmetro regionCode instrui a API a retornar a lista de categorias de guias disponíveis no país especificado. O valor do parâmetro é um código de país ISO 3166-1 alfa-2.
Parâmetros opcionais
hl string
O parâmetro hl especifica o idioma que será usado para valores de texto na resposta da API. O valor padrão é en-US.

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#guideCategoryListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    guideCategory 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#guideCategoryListResponse.
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.
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 categorias que podem ser associadas a canais do YouTube. Nesse mapa, o ID da categoria é a chave do mapa, e o valor é o recurso guideCategory correspondente.

Erros

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

Tipo de erro Detalhe do erro Descrição
notFound (404) notFound Não foi possível encontrar a categoria do guia identificada pelo parâmetro id. Use o método guideCategories.list para recuperar uma lista de valores válidos.

Confira!

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