Videos: list

Retorna uma lista de vídeos que correspondem aos parâmetros de solicitação de API.

Impacto na 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/videos

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 video 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 video, a propriedade snippet contém as propriedades channelId, title, description, tags e categoryId. Assim, se você definir part=snippet, a resposta da API vai conter todas essas propriedades.

A lista a seguir contém os nomes part que podem ser incluídos no valor do parâmetro:
  • brandPartner
  • contentDetails
  • fileDetails
  • id
  • liveStreamingDetails
  • localizations
  • paidProductPlacementDetails
  • player
  • processingDetails
  • recordingDetails
  • snippet
  • statistics
  • status
  • suggestions
  • topicDetails
Filtros (especifique exatamente um dos seguintes parâmetros)
chart string
O parâmetro chart identifica o gráfico que você quer recuperar.

Os valores aceitáveis são:
id string
O parâmetro id especifica uma lista separada por vírgulas dos IDs de vídeos do YouTube para os recursos que estão sendo recuperados. Em um recurso video, a propriedade id especifica o ID do vídeo.
myRating string

Esse parâmetro só pode ser usado em uma solicitação devidamente autorizada. Defina o valor desse parâmetro como like ou dislike para instruir a API a retornar apenas vídeos que o usuário autenticado gostou ou não gostou.



O limite da API restringe o conjunto de resultados retornado a um máximo de 1.000 vídeos. Mesmo que a propriedade pageInfo.totalResults da resposta indique um total maior, a paginação usando o parâmetro pageToken permite apenas a recuperação dos 1.000 itens mais recentes.



O parâmetro aceita os seguintes valores:

  • dislike : retorna apenas vídeos que o usuário autenticado não gostou.
  • like : retorna apenas vídeos que o usuário autenticado gostou.
Parâmetros opcionais
hl string
O parâmetro hl instrui a API a recuperar metadados de recursos localizados para um idioma de aplicativo específico com suporte do site do YouTube. O valor de 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.
maxHeight unsigned integer
O parâmetro maxHeight especifica a altura máxima do player incorporado retornado na propriedade player.embedHtml. Use esse parâmetro para especificar que, em vez das dimensões padrão, o código de incorporação deve usar uma altura adequada para o layout do aplicativo. Se o parâmetro maxWidth também for fornecido, o player poderá ser mais curto que o maxHeight para não violar a largura máxima. Os valores aceitáveis são de 72 a 8192, inclusive.
maxResults unsigned integer
O parâmetro maxResults especifica o número máximo de itens que precisam ser retornados no conjunto de resultados.

Observação: esse parâmetro tem suporte para uso em conjunto com o parâmetro myRating, mas não com o parâmetro id. Os valores aceitáveis são de 1 a 50, inclusive. O valor padrão é 5.
maxWidth unsigned integer
O parâmetro maxWidth especifica a largura máxima do player incorporado retornado na propriedade player.embedHtml. Use esse parâmetro para especificar que, em vez das dimensões padrão, o código de incorporação deve usar uma largura adequada para o layout do aplicativo.

Se o parâmetro maxHeight também for fornecido, o player poderá ser mais estreito que maxWidth para não violar a altura máxima. Os valores aceitáveis são de 72 a 8192, inclusive.
onBehalfOfContentOwner string
Esse parâmetro só pode ser usado em uma solicitação devidamente autorizada. 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.

Observação: esse parâmetro tem suporte para uso em conjunto com o parâmetro myRating, mas não com o parâmetro id.
regionCode string
O parâmetro regionCode instrui a API a selecionar um gráfico de vídeo disponível na região especificada. Esse parâmetro só pode ser usado em conjunto com o parâmetro chart. O valor de parâmetro é um código de país ISO 3166-1 alfa-2.
videoCategoryId string
O parâmetro videoCategoryId identifica a categoria de vídeo para a qual o gráfico precisa ser recuperado. Esse parâmetro só pode ser usado em conjunto com o parâmetro chart. Por padrão, os gráficos não são restritos a determinada categoria. O valor padrão é 0.

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#videoListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    video 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#videoListResponse.
etag etag
O 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 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 vídeos 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. Consulte a documentação da mensagem de erro para mais detalhes.

Tipo de erro Detalhe do erro Descrição
badRequest (400) videoChartNotFound O gráfico de vídeo solicitado não é suportado ou não está disponível.
forbidden (403) forbidden A solicitação não está devidamente autorizada para acessar informações de arquivo de vídeo ou de processamento. As partes fileDetails, processingDetails e suggestions só estão disponíveis para o proprietário do vídeo.
forbidden (403) forbidden A solicitação não pode acessar informações de avaliação de usuários. Esse erro pode ocorrer porque a solicitação não está devidamente autorizada para usar o parâmetro myRating.
notFound (404) videoNotFound Não foi possível encontrar o vídeo que você está tentando recuperar. Verifique se o valor do parâmetro id da solicitação está correto.

Confira!

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