Esta página foi traduzida pela API Cloud Translation.

Videos: list

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

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/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 serão incluídas pela resposta da API. 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`. Dessa forma, se você definir `part=snippet`, a resposta da API vai conter todas essas propriedades. A lista a seguir contém os nomes de `part` que podem ser incluídos no valor do parâmetro: `contentDetails` `fileDetails` `id` `liveStreamingDetails` `localizations` `player` `processingDetails` `recordingDetails` `snippet` `statistics` `status` `suggestions` `topicDetails`
Filtros (especifique exatamente um dos parâmetros a seguir)
`chart`	`string` O parâmetro `chart` identifica o gráfico que você quer recuperar. Os valores aceitáveis são os seguintes: `mostPopular` – Retorna os vídeos mais populares para a região de conteúdo e a categoria de vídeo especificadas.
`id`	`string` O parâmetro `id` especifica uma lista separada por vírgulas dos IDs dos vídeos do YouTube para os recursos que estiverem 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 autorizada corretamente. Defina o valor desse parâmetro como `like` ou `dislike` para instruir a API a retornar apenas vídeos marcados com "Gostei" ou "Não gostei" pelo usuário autenticado. Os valores aceitáveis são: `dislike` – Retorna somente os vídeos que o usuário autenticado não gostou. `like` – Retorna somente o vídeo 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 do aplicativo compatível com o 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 os detalhes do recurso no idioma padrão.
`maxHeight`	`unsigned integer` O parâmetro `maxHeight` especifica a altura máxima do player incorporado retornado na propriedade `player.embedHtml`. Você pode usar esse parâmetro para especificar que, em vez das dimensões padrão, o código de incorporação deve usar uma altura apropriada para o layout do seu aplicativo. Se o parâmetro `maxWidth` também for fornecido, o player poderá ser menor do que `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 pode ser usado 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`. Você pode usar 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 seu 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 autorizada corretamente. 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 será retornado. Em uma resposta da API, as propriedades `nextPageToken` e `prevPageToken` identificam outras páginas que podem ser recuperadas. Observação:esse parâmetro pode ser usado 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. Este parâmetro pode ser usado apenas em conjunto com o parâmetro `chart`. O valor do 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. Este parâmetro pode ser usado apenas 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` 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` A lista de vídeos que correspondem aos critérios de solicitação.

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
`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 a acessar arquivos de vídeo ou processar informações. As partes `fileDetails`, `processingDetails` e `suggestions` estão disponíveis apenas para o proprietário do vídeo.
`forbidden (403)`	`forbidden`	A solicitação não pode acessar informações de avaliação do usuário. Esse erro pode ocorrer porque a solicitação não está devidamente autorizada a usar o parâmetro `myRating`.
`notFound (404)`	`videoNotFound`	O vídeo que você está tentando recuperar não pode ser encontrado. Verifique o valor do parâmetro `id` da solicitação para garantir que ele está correto.

Confira!

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