VideoCategories: list

Retorna uma lista de categorias que podem ser associadas a vídeos do YouTube.

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

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 as propriedades do recurso videoCategory que serão incluídas pela resposta da API. Defina o valor do parâmetro como snippet.
Filtros (especifique exatamente um dos parâmetros a seguir)
id string
O parâmetro id especifica uma lista separada por vírgulas de IDs de categoria de vídeo para os recursos que você está recuperando.
regionCode string
O parâmetro regionCode instrui a API a retornar a lista de categorias de vídeo 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 a linguagem que precisa ser usada 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#videoCategoryListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    videoCategory 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#videoCategoryListResponse.
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.
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 de vídeo que podem ser associadas a vídeos do YouTube. Neste mapa, o ID da categoria de vídeo é a chave do mapa, e seu valor é o recurso videoCategory correspondente.

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
notFound (404) videoCategoryNotFound A categoria de vídeo identificada pelo parâmetro id não foi encontrada. Use o método videoCategories.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.