GuideCategories: list

Retorna uma lista de categorias que podem ser associadas a canais do YouTube. Faça um teste agora.

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 uma lista separada por vírgulas de uma ou mais propriedades de recurso guideCategory que serão incluídas pela resposta da API. Os nomes part que podem ser incluídos no valor do parâmetro são id e snippet.

Se o parâmetro identificar uma propriedade que contenha propriedades criança, estas serão incluídas na resposta. Por exemplo, em um recurso guideCategory, a propriedade snippet contém outras propriedades, como o título da categoria. Se você definir part=snippet, a resposta da API também conterá todas essas propriedades aninhadas.
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 estiverem 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 para retornar a lista de categorias de vídeo guia disponíveis no país especificado. O valor do parâmetro é um código de país ISO 3166-1 Alpha 2.
Parâmetros opcionais
hl string
O parâmetro hl especifica a linguagem que será usada para valores de texto na resposta da API. O valor padrão é en-US.

Corpo de solicitação

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

Resposta

Se for bem-sucedido, este método retorna um corpo de resposta com a seguinte estrutura:

{
  "kind": "youtube#guideCategoryListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    guideCategories resource
  ]
}

Propriedades

A tabela a seguir define as propriedades que aparecem neste recurso:

Propriedades
kind string
O tipo do recurso da API. O valor será youtube#guideCategoryListResponse.
etag etag
A Etag deste recurso.
nextPageToken string
O token que pode ser utilizado como o valor do parâmetro pageToken para recuperar a página seguinte do conjunto de resultados.
prevPageToken string
O token que pode ser utilizado como o valor do parâmetro pageToken para recuperar a página anterior do 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. Neste mapa, o ID da categoria é a chave do mapa, e seu 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 notFound A categoria de guia determinada pelo parâmetro id não pode ser encontrada. Use o método guideCategories.list para recuperar uma lista de valores válidos.

Conheça agora.

Use o Explorador de API para chamar este método em dados ativos e ver a solicitação e a resposta da API.