Os exemplos a seguir mostram como usar a API YouTube Data (v3) para realizar funções relacionadas a vídeos.
Recuperar os vídeos enviados de um canal
Este exemplo recupera os vídeos enviados para um canal específico. O exemplo tem duas etapas:
-
Etapa 1: recuperar o ID da playlist dos vídeos enviados do canal
Chame o método
channels.list
para recuperar o ID da playlist que contém os vídeos enviados do canal. O valor do parâmetropart
da solicitação precisa incluircontentDetails
como uma das partes do recursochannel
que estão sendo recuperadas. Na resposta da API, a propriedadecontentDetails.relatedPlaylists.uploads
contém o ID da playlist.Há várias maneiras de identificar o canal:
-
Defina o valor do parâmetro
mine
comotrue
para recuperar informações do canal do YouTube do usuário autenticado no momento. Sua solicitação precisa ser autorizada usando o OAuth 2.0.https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.channels.list? part=contentDetails &mine=true
-
Defina o parâmetro
forUsername
como um nome de usuário do YouTube para extrair informações do canal associado a ele. Este exemplo define o valor do parâmetroforUsername
comoGoogle
para recuperar informações do canal oficial do YouTube do Google.https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.channels.list? part=contentDetails &forUsername=Google
-
Defina o parâmetro
id
como o ID do canal do YouTube que identifica exclusivamente o canal para o qual você está recuperando informações. Este exemplo define o parâmetroid
comoUCK8sQmJBp8GCxrOtXWBpyEA
, que também identifica o canal oficial do YouTube do Google.https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.channels.list? part=contentDetails &id=UCK8sQmJBp8GCxrOtXWBpyEA
-
-
Etapa 2: recuperar a lista de vídeos enviados
Chame o método
playlistItems.list
para recuperar a lista de vídeos enviados. Defina o valor do parâmetroplaylistId
como o valor obtido na etapa 1. Neste exemplo, o valor do parâmetro é definido comoUUK8sQmJBp8GCxrOtXWBpyEA
, que é a lista de vídeos enviados para o canal oficial do Google no YouTube.https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.list? part=snippet,contentDetails,status &playlistId=UUK8sQmJBp8GCxrOtXWBpyEA
Recuperar os vídeos mais procurados
Este exemplo mostra como recuperar uma lista dos vídeos mais populares do YouTube, que são selecionados usando um algoritmo que combina muitos indicadores diferentes para determinar a popularidade geral.
Para recuperar a lista de vídeos mais assistidos, chame o método videos.list
e defina o valor do parâmetro chart
como mostPopular
.
O gráfico mostPopular
inclui vídeos de música, filmes e jogos em alta.
Em seguida, é possível definir os seguintes parâmetros:
regionCode
: instrui a API a retornar uma lista de vídeos da região especificada. O valor do parâmetro é um código de país ISO 3166-1 Alfa 2. Use o métodoi18nRegions.list
para recuperar uma lista de códigos de região compatíveis com o YouTube.videoCategoryId
: identifica a categoria de vídeo para a qual os vídeos mais populares devem ser recuperados. Use o métodovideoCategories.list
para recuperar uma lista de IDs de categorias compatíveis com o YouTube.
Por exemplo, a solicitação a seguir recupera os vídeos de esportes mais assistidos na Espanha:
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.videos.list? part=snippet &chart=mostPopular ®ionCode=es &videoCategoryId=17
Enviar um vídeo
Como o APIs Explorer não permite o upload de arquivos, esta descrição não tem um exemplo executável. Os recursos a seguir vão ajudar você a modificar seu aplicativo para que ele possa enviar vídeos usando a API v3:
-
A documentação do método videos.insert da API contém várias amostras de código que explicam como fazer upload de um vídeo usando diferentes linguagens de programação.
-
O guia Uploads retomáveis explica a sequência de solicitações HTTP que um aplicativo usa para fazer upload de vídeos usando um processo de upload retomável. O guia é destinado principalmente a desenvolvedores que não podem usar as bibliotecas de cliente da API do Google, algumas das quais oferecem suporte nativo para uploads retomáveis.
-
O exemplo em JavaScript para fazer upload de um vídeo usa o CORS (compartilhamento de recursos entre origens) para demonstrar como enviar um arquivo de vídeo por uma página da Web. A biblioteca de upload do CORS usada pela API v3 oferece suporte natural ao upload retomável. Além disso, o exemplo demonstra como verificar o status de um vídeo enviado recuperando a parte
processingDetails
do recursovideo
e como lidar com mudanças de status do vídeo enviado.
Verificar o status de um vídeo enviado
Este exemplo mostra como verificar o status de um vídeo enviado. Um vídeo enviado fica imediatamente visível no feed de vídeos enviados do usuário autenticado. No entanto, o vídeo não vai aparecer no YouTube até ser processado.
-
Etapa 1: fazer upload do vídeo
Chame o método
videos.insert
para enviar o vídeo. Se a solicitação for bem-sucedida, a resposta da API vai conter um recursovideo
que identifica o ID exclusivo do vídeo enviado. -
Etapa 2: verificar o status do vídeo
Chame o método
videos.list
para verificar o status do vídeo. Defina o valor do parâmetroid
como o ID do vídeo obtido na etapa 1. Defina o valor do parâmetropart
comoprocessingDetails
.Se a solicitação for processada com êxito, a resposta da API vai conter um recurso
video
. Verifique o valor da propriedadeprocessingDetails.processingStatus
para determinar se o YouTube ainda está processando o vídeo. O valor da propriedade vai mudar para algo diferente deprocessing
, comosucceeded
oufailed
, quando o YouTube terminar de processar o vídeo.O corpo da solicitação é um recurso
video
em que a propriedadeid
especifica o ID do vídeo que você está excluindo. Neste exemplo, o recurso também contém um objetorecordingDetails
.A solicitação abaixo verifica o status de um vídeo. Para concluir a solicitação no APIs Explorer, defina o valor da propriedade
id
.https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.videos.list? part=snippet,processingDetails &id=VIDEO_ID
Observação:seu aplicativo pode consultar a API para verificar periodicamente o status de um vídeo enviado recentemente. Depois que o vídeo é processado, seu aplicativo pode criar um boletim ou realizar outra ação dependendo do status do vídeo.
Atualizar um vídeo
Este exemplo mostra como atualizar um vídeo para adicionar informações sobre o horário e o local em que ele foi gravado. O exemplo tem as seguintes etapas:
-
Etapa 1: recuperar o ID do vídeo
Siga as etapas acima para recuperar os vídeos enviados do canal do usuário autenticado. A lista pode ser usada para mostrar uma lista de vídeos, usando o ID de cada um como chave.
Observação:há várias outras maneiras de conseguir IDs de vídeo, como recuperar resultados da pesquisa ou listar itens em uma playlist. No entanto, como um vídeo só pode ser atualizado pelo proprietário, recuperar uma lista de vídeos de propriedade do usuário que autoriza a solicitação da API é uma provável primeira etapa nesse processo.
-
Etapa 2: atualizar um vídeo
Chame o método
videos.update
para atualizar um vídeo específico. Defina o valor do parâmetropart
comorecordingDetails
. O valor do parâmetro depende dos campos de metadados do vídeo que estão sendo atualizados.O corpo da solicitação é um recurso
video
em que a propriedadeid
especifica o ID do vídeo que você está atualizando. Neste exemplo, o recurso também contém um objetorecordingDetails
.O exemplo de recurso abaixo indica que o vídeo foi gravado em 30 de outubro de 2013, em Boston:
{ "id": "VIDEO_ID", "recordingDetails": { "location": { "latitude": "42.3464", "longitude": "-71.0975" } "recordingDate": "2013-10-30T23:15:00.000Z" } }
Para concluir a solicitação no APIs Explorer, defina o valor da propriedade
id
.https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.videos.update? part=snippet
Enviar uma imagem de miniatura personalizada e definir para um vídeo
Você pode usar o método thumbnails.set
da API v3 para fazer upload de uma imagem de miniatura personalizada e definir para um vídeo. Na sua solicitação, o valor do parâmetro videoId
identifica o vídeo em que a miniatura será usada.
Essa consulta não pode ser testada usando o APIs Explorer porque ele não permite o upload de arquivos de mídia, o que é um requisito para esse método.
Excluir um vídeo
Este exemplo mostra como excluir um vídeo. O exemplo tem as seguintes etapas:
-
Etapa 1: recuperar o ID do vídeo
Siga as etapas acima para recuperar os vídeos enviados do canal do usuário autenticado. A lista pode ser usada para mostrar uma lista de vídeos, usando o ID de cada um como chave.
Observação:há várias outras maneiras de conseguir IDs de vídeo, como recuperar resultados da pesquisa ou listar itens em uma playlist. No entanto, como um vídeo só pode ser excluído pelo proprietário, recuperar uma lista de vídeos pertencentes ao usuário que autoriza a solicitação da API é uma provável primeira etapa nesse processo.
-
Etapa 2: excluir um vídeo
Chame o método
videos.delete
para excluir um vídeo específico. Na solicitação, o parâmetroid
especifica o ID do vídeo que você está excluindo. A solicitação precisa ser autorizada usando o OAuth 2.0. Se você estiver testando essa consulta no APIs Explorer, substitua um ID de vídeo válido pelo valor do parâmetroid
.https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.videos.delete? id=VIDEO_ID
Denunciar um vídeo abusivo
Este exemplo mostra como denunciar um vídeo com conteúdo abusivo. O exemplo tem as seguintes etapas:
-
Etapa 1: recuperar IDs que explicam por que o vídeo está sendo denunciado
Envie uma solicitação autorizada ao método
videoAbuseReportReasons.list
para recuperar uma lista de motivos válidos para sinalizar um vídeo. O exemplo de recursovideoAbuseReportReason
abaixo contém informações para sinalizar um vídeo com spam ou conteúdo enganoso.{ "kind": "youtube#videoAbuseReportReason", "etag": "\"tbWC5XrSXxe1WOAx6MK9z4hHSU8/Or2VqBIilpHU7j__oPzUFCvGVBw\"", "id": "S", "snippet": { "label": "Spam or misleading", "secondaryReasons": [ { "id": "27", "label": "Spam or mass advertising" }, { "id": "28", "label": "Misleading thumbnail" }, { "id": "29", "label": "Malware or phishing" }, { "id": "30", "label": "Pharmaceutical drugs for sale" }, { "id": "31", "label": "Other misleading info" } ] } }
Conforme mostrado no recurso, esse motivo está associado a uma lista de motivos secundários. Ao sinalizar um vídeo por conter spam, você precisa informar o ID do motivo e é altamente recomendável fornecer um motivo secundário também.
-
Etapa 2: denunciar o vídeo por conteúdo abusivo
Envie uma solicitação autorizada ao método
A propriedadevideos.reportAbuse
para denunciar o vídeo. O corpo da solicitação é um objeto JSON que identifica o vídeo sinalizado e o motivo da sinalização. Conforme observado na etapa 1, para alguns tipos de motivos, é possível e altamente recomendável informar um motivo secundário.videoId
do objeto JSON identifica o vídeo que está sendo sinalizado.O exemplo de objeto JSON abaixo sinaliza um vídeo por conter spam ou conteúdo enganoso e, mais especificamente, por usar uma imagem de miniatura enganosa. Conforme mostrado no exemplo de objeto JSON acima, o ID do conteúdo Spam ou enganoso é S. O ID de uma miniatura enganosa é 28.
{ "videoId": "VIDEO_ID", "reasonId": "S", "secondaryReasonId": "28", "comments": "Testing the video flagging feature.", "language": "en" }
A solicitação
videos.reportAbuse
precisa ser autorizada usando o OAuth 2.0. O link abaixo carrega o objeto JSON acima nas APIs Explorer. Para testar a consulta, substitua um ID de vídeo válido pelo valor da propriedadevideoId
. Enviar esta solicitação vai sinalizar o vídeo.https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.videos.reportAbuse