Um recurso de video
representa um vídeo do YouTube.
Métodos
A API suporta os seguintes métodos para recursos videos
:
- getRating
- Recupera as classificações que o usuário autorizado deu a uma lista de vídeos especificados. Faça um teste agora.
- list
- Retorna uma lista de vídeos que correspondem aos parâmetros de solicitação da API. Faça um teste agora.
- insert
- Envia um vídeo para o YouTube e, opcionalmente, define os metadados do vídeo.
- update
- Atualiza os metadados de um vídeocanal. Faça um teste agora.
- delete
- Exclui um vídeo do YouTube. Faça um teste agora.
- rate
- Adiciona uma classificação gostei ou não gostei a um vídeo ou remove uma classificação de um vídeo. Faça um teste agora.
Representação de recurso
A estrutura JSON abaixo mostra o formato de um recurso videos
:
{ "kind": "youtube#video", "etag": etag, "id": string, "snippet": { "publishedAt": datetime, "channelId": string, "title": string, "description": string, "thumbnails": { (key): { "url": string, "width": unsigned integer, "height": unsigned integer } }, "channelTitle": string, "tags": [ string ], "categoryId": string }, "contentDetails": { "duration": string, "dimension": string, "definition": string, "caption": string, "licensedContent": boolean, "regionRestriction": { "allowed": [ string ], "blocked": [ string ] }, "contentRating": { "mpaaRating": string, "tvpgRating": string, "bbfcRating": string, "chvrsRating": string, "eirinRating": string, "cbfcRating": string, "fmocRating": string, "icaaRating": string, "acbRating": string, "oflcRating": string, "fskRating": string, "kmrbRating": string, "djctqRating": string, "russiaRating": string, "rtcRating": string, "ytRating": string } }, "status": { "uploadStatus": string, "failureReason": string, "rejectionReason": string, "privacyStatus": string, "license": string, "embeddable": boolean, "publicStatsViewable": boolean }, "statistics": { "viewCount": unsigned long, "likeCount": unsigned long, "dislikeCount": unsigned long, "favoriteCount": unsigned long, "commentCount": unsigned long }, "player": { "embedHtml": string }, "topicDetails": { "topicIds": [ string ], "relevantTopicIds": [ string ] }, "recordingDetails": { "locationDescription": string, "location": { "latitude": double, "longitude": double, "altitude": double }, "recordingDate": datetime }, "fileDetails": { "fileName": string, "fileSize": unsigned long, "fileType": string, "container": string, "videoStreams": [ { "widthPixels": unsigned integer, "heightPixels": unsigned integer, "frameRateFps": double, "aspectRatio": double, "codec": string, "bitrateBps": unsigned long, "rotation": string, "vendor": string } ], "audioStreams": [ { "channelCount": unsigned integer, "codec": string, "bitrateBps": unsigned long, "vendor": string } ], "durationMs": unsigned long, "bitrateBps": unsigned long, "recordingLocation": { "latitude": double, "longitude": double, "altitude": double }, "creationTime": string }, "processingDetails": { "processingStatus": string, "processingProgress": { "partsTotal": unsigned long, "partsProcessed": unsigned long, "timeLeftMs": unsigned long }, "processingFailureReason": string, "fileDetailsAvailability": string, "processingIssuesAvailability": string, "tagSuggestionsAvailability": string, "editorSuggestionsAvailability": string, "thumbnailsAvailability": string }, "suggestions": { "processingErrors": [ string ], "processingWarnings": [ string ], "processingHints": [ string ], "tagSuggestions": [ { "tag": string, "categoryRestricts": [ string ] } ], "editorSuggestions": [ string ] } }
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#video . |
etag |
etag A Etag deste recurso. |
id |
string O ID que o YouTube usa para identificar o vídeo. |
snippet |
object O objeto snippet contém detalhes básicos sobre o vídeo, como seu título, sua descrição e sua categoria. |
snippet.publishedAt |
datetime A data e a hora em que o vídeo foi enviado. O valor é especificado no formato ISO 8601 ( YYYY-MM-DDThh:mm:ss.sZ ). |
snippet.channelId |
string O ID que o YouTube usa para identificar de forma exclusiva o canal ao qual o vídeo foi enviado. |
snippet.title |
string O título do vídeo. |
snippet.description |
string A descrição do vídeo. |
snippet.thumbnails |
object Um mapa de imagens em miniatura associadas ao vídeo. Para cada objeto no mapa, a chave é o nome da imagem em miniatura, e o valor é um objeto que contém outras informações sobre a miniatura. |
snippet.thumbnails.(key) |
object Os valores de chave válidos são:
|
snippet.thumbnails.(key).url |
string O URL da imagem. |
snippet.thumbnails.(key).width |
unsigned integer A largura da imagem. |
snippet.thumbnails.(key).height |
unsigned integer A altura da imagem. |
snippet.channelTitle |
string O título do canal ao qual o vídeo pertence. |
snippet.tags[] |
list Uma lista de tags de palavras-chave associadas ao vídeo. As tags podem conter espaços. Este campo só é visível para o usuário que faz upload do vídeo. |
snippet.categoryId |
string A categoria de vídeo do YouTube associada ao vídeo. |
contentDetails |
object O objeto contentDetails contém informações sobre o conteúdo do vídeo, incluindo sua duração e proporção. |
contentDetails.duration |
string A duração do vídeo. O valor da tag é uma duração I S O 8601 no formato PT#M#S , onde as letras PT indicam que o valor especifica um período e M e S se referem à duração em minutos em segundos, respectivamente. Os caracteres # que precedem as letras M e S são inteiros que especificam o número de minutos (ou segundos) do vídeo. Por exemplo, um valor PT15M51S indica que o vídeo tem 15 minutos e 51 segundos de duração. |
contentDetails.dimension |
string Indica se o vídeo está disponível em 3D ou 2D. |
contentDetails.definition |
string Indica se o vídeo está disponível em alta definição ( HD ) ou apenas em definição padrão.Os valores válidos para esta propriedade são:
|
contentDetails.caption |
string Indica se as legendas estão disponíveis para o vídeo. Os valores válidos para esta propriedade são:
|
contentDetails.licensedContent |
boolean Indica se o vídeo representa um conteúdo licenciado, o que significa que o conteúdo foi reivindicado por um parceiro de conteúdo do YouTube. |
contentDetails.regionRestriction |
object O objeto regionRestriction contém informações sobre os países onde um vídeo é (ou não é) visível. O objeto conterá a propriedade contentDetails.regionRestriction.allowed ou contentDetails.regionRestriction.blocked . |
contentDetails.regionRestriction.allowed[] |
list A lista de códigos de região que identificam os países onde o vídeo é visível. Se esta propriedade estiver presente e um país não estiver listado em seu valor, o vídeo será bloqueado para ser exibido nesse país. Se esta propriedade estiver presente e contiver uma lista vazia, o vídeo será bloqueado em todos os países. |
contentDetails.regionRestriction.blocked[] |
list A lista de códigos de região que identificam os países onde o vídeo é bloqueado. Se esta propriedade estiver presente e um país não estiver listado em seu valor, o vídeo será visível nesse país. Se esta propriedade estiver presente e contiver uma lista vazia, o vídeo será visível em todos os países. |
contentDetails.contentRating |
object Especifica as classificações que o vídeo recebeu em vários esquemas de classificação. |
contentDetails.contentRating.mpaaRating |
string A classificação da Motion Picture Association of America (MPAA) de vídeos. Os valores válidos para esta propriedade são:
|
contentDetails.contentRating.tvpgRating |
string A classificação de Orientação dos pais para a televisão (TVPG, na sigla em inglês) de vídeos. Os valores válidos para esta propriedade são:
|
contentDetails.contentRating.bbfcRating |
string A classificação do British Board of Film Classification (BBFC) de vídeos. Os valores válidos para esta propriedade são:
|
contentDetails.contentRating.chvrsRating |
string A classificação do Sistema Canadense de Classificação de Vídeos Caseiros (CHVRS, na sigla em inglês) de vídeos. Os valores válidos para esta propriedade são:
|
contentDetails.contentRating.eirinRating |
string A classificação do Eirin (映倫) de vídeos. O Eirin é o sistema de classificação japonês. Os valores válidos para esta propriedade são:
|
contentDetails.contentRating.cbfcRating |
string A classificação da Junta Central de Certificação de Filmes (CBFC, na sigla em inglês - Índia) de vídeos. Os valores válidos para esta propriedade são:
|
contentDetails.contentRating.fmocRating |
string A classificação do Centre national du cinéma et de l'image animé (Ministério da Cultura da França) de vídeos. Os valores válidos para esta propriedade são:
|
contentDetails.contentRating.icaaRating |
string A classificação do Instituto de la Cinematografía y de las Artes Audiovisuales (ICAA - Espanha) de vídeos. Os valores válidos para esta propriedade são:
|
contentDetails.contentRating.acbRating |
string A classificação do Conselho de Classificação da Austrália (ACB, na sigla em inglês) de vídeos. Os valores válidos para esta propriedade são:
|
contentDetails.contentRating.oflcRating |
string A classificação do Office of Film and Literature Classification (OFLC - Nova Zelândia) de vídeos. Os valores válidos para esta propriedade são:
|
contentDetails.contentRating.fskRating |
string A classificação do Freiwillige Selbstkontrolle der Filmwirtschaft (FSK - Alemanha) de vídeos. Os valores válidos para esta propriedade são:
|
contentDetails.contentRating.kmrbRating |
string A classificação da Avaliação de Plataforma de Média da Coreia (영상물등급위원회) de vídeos. A KMRB (na sigla em inglês) classifica vídeos na Coréia do Sul. Os valores válidos para esta propriedade são:
|
contentDetails.contentRating.djctqRating |
string A classificação do Departamento de Justiça, Classificação, Qualificação e Títulos (DJCQT - Brasil) de vídeos. Os valores válidos para esta propriedade são:
|
contentDetails.contentRating.russiaRating |
string A classificação Registro Nacional de Filmes da Federação Russa (MKRF, na sigla em russo - Rússia) de vídeos. Os valores válidos para esta propriedade são:
|
contentDetails.contentRating.rtcRating |
string A classificação da Direção Geral de Rádio, Televisão e Cinematografia (México) de vídeos. Os valores válidos para esta propriedade são:
|
contentDetails.contentRating.ytRating |
string Uma classificação que o YouTube usa para identificar conteúdo com restrição de idade. Os valores válidos para esta propriedade são:
|
status |
object O objeto status contém informações sobre o envio, processamento e status de privacidade do vídeo. |
status.uploadStatus |
string O status do vídeo enviado. Os valores válidos para esta propriedade são:
|
status.failureReason |
string Este valor explica por que um vídeo não conseguiu ser enviado. Esta propriedade só estará presente se a propriedade uploadStatus indicar que o envio falhou.Os valores válidos para esta propriedade são:
|
status.rejectionReason |
string Este valor explica por que o YouTube rejeitou um vídeo enviado. Esta propriedade só estará presente se a propriedade uploadStatus indicar que o envio foi rejeitado.Os valores válidos para esta propriedade são:
|
status.privacyStatus |
string Status de privacidade do vídeo. Os valores válidos para esta propriedade são:
|
status.license |
string A licença do vídeo. Os valores válidos para esta propriedade são:
|
status.embeddable |
boolean Este valor indica se o vídeo pode ser incorporado em outro website. |
status.publicStatsViewable |
boolean Este valor indica se as estatísticas estendidas do vídeo da página de exibição do vídeo são visíveis publicamente. Por padrão, essas estatísticas são visíveis, e estatísticas como a contagem de visualizações e as classificações de um vídeo continuarão visíveis publicamente, mesmo que o valor dessa propriedade seja definido como false . |
statistics |
object O objeto statistics contém estatísticas sobre o vídeo. |
statistics.viewCount |
unsigned long A quantidade de visualizações do vídeo. |
statistics.likeCount |
unsigned long A quantidade de usuários que indicaram ter gostado do vídeo concedendo uma avaliação positiva. |
statistics.dislikeCount |
unsigned long A quantidade de usuários que indicou não ter gostado do vídeo concedendo uma classificação negativa. |
statistics.favoriteCount |
unsigned long A quantidade de usuários que marcou o vídeo como favorito no momento. |
statistics.commentCount |
unsigned long A quantidade de comentários do vídeo. |
player |
object O objeto player contém informações que você deve usar para reproduzir o vídeo em um player integrado. |
player.embedHtml |
string Uma tag <iframe> que incorpora um player que reproduzirá o vídeo. |
topicDetails |
object O objeto topicDetails encapsula informações sobre tópicos Freebase associados ao vídeo. |
topicDetails.topicIds[] |
list A lista de IDs de tópicos Freebase que estão centralmente associados ao vídeo. Esses são tópicos em destaque central no vídeo. Pode-se dizer que o vídeo se trata principalmente sobre cada uma deles. Você pode recuperar informações sobre cada tópico usando a API de tópicos Freebase. |
topicDetails.relevantTopicIds[] |
list Semelhante a topic_id, exceto pelo fato de que esses tópicos são meramente relevantes para o vídeo. Esses são tópicos que podem ser mencionados ou aparecer no vídeo. Você pode recuperar informações sobre cada tópico usando a API de tópicos Freebase. |
recordingDetails |
object O objeto recordingDetails encapsula informações sobre o local, a data e o endereço onde o vídeo foi gravado. |
recordingDetails.locationDescription |
string O texto de descrição do local onde o vídeo foi gravado. |
recordingDetails.location |
object As informações de localização geográfica associadas ao vídeo. |
recordingDetails.location.latitude |
double Latitude em graus. |
recordingDetails.location.longitude |
double Longitude em graus. |
recordingDetails.location.altitude |
double Altitude acima do elipsoide de referência, em metros. |
recordingDetails.recordingDate |
datetime A data e a hora em que o vídeo foi gravado. O valor é especificado no formato ISO 8601 ( YYYY-MM-DDThh:mm:ss.sZ ). |
fileDetails |
object O objeto fileDetails encapsula informações sobre o arquivo de vídeo que foi enviado para o YouTube, incluindo a resolução, a duração, o áudio e os codecs de vídeo do arquivo, as taxas de bits do fluxo, entre outros. Esses dados só podem ser recuperados pelo proprietário do vídeo. |
fileDetails.fileName |
string O nome do arquivo enviado. Este campo estará presente se um arquivo de vídeo ou outro tipo de arquivo tiver sido enviado. |
fileDetails.fileSize |
unsigned long O tamanho do arquivo enviado em bytes. Este campo estará presente se um arquivo de vídeo ou outro tipo de arquivo tiver sido enviado. |
fileDetails.fileType |
string O tipo do arquivo enviado, conforme detectado pelo mecanismo de processamento de vídeos do YouTube. Atualmente, o YouTube só processa arquivos de vídeo, mas esse campo estará presente se um arquivo de vídeo ou outro tipo de arquivo tiver sido enviado. Os valores válidos para esta propriedade são:
|
fileDetails.container |
string O formato do contêiner do arquivo de vídeo enviado. |
fileDetails.videoStreams[] |
list A lista de streams de vídeo contidos no arquivo de vídeo enviado. Cada item da lista contém metadados detalhadas sobre um stream de vídeo. |
fileDetails.videoStreams[].widthPixels |
unsigned integer A largura do conteúdo do vídeo codificada em pixels. Você pode calcular a proporção de codificação do vídeo como width_pixels /height_pixels . |
fileDetails.videoStreams[].heightPixels |
unsigned integer A altura do conteúdo do vídeo codificada em pixels. |
fileDetails.videoStreams[].frameRateFps |
double O frame rate do stream de vídeo, em quadros por segundo. |
fileDetails.videoStreams[].aspectRatio |
double A proporção de exibição do conteúdo do vídeo, que especifica a proporção em que o vídeo deve ser exibido. |
fileDetails.videoStreams[].codec |
string O codec de vídeo que o stream usa. |
fileDetails.videoStreams[].bitrateBps |
unsigned long A taxa de bits do stream de vídeo, em bits por segundo. |
fileDetails.videoStreams[].rotation |
string O valor que o YouTube precisa para rodar o conteúdo original da origem para exibir corretamente o vídeo. Os valores válidos para esta propriedade são:
|
fileDetails.videoStreams[].vendor |
string Um valor que identifica de forma exclusiva um fornecedor de vídeo. Normalmente, o valor é um código de fornecedor de quatro letras. |
fileDetails.audioStreams[] |
list A lista de streams de áudio contidos no arquivo de vídeo enviado. Cada item da lista contém metadados detalhados sobre um stream de áudio. |
fileDetails.audioStreams[].channelCount |
unsigned integer A quantidade de canais de áudio que o stream contém. |
fileDetails.audioStreams[].codec |
string O codec de áudio que o stream utiliza. |
fileDetails.audioStreams[].bitrateBps |
unsigned long A taxa de bits do stream de áudio, em bits por segundo. |
fileDetails.audioStreams[].vendor |
string Um valor que identifica de forma exclusiva um fornecedor de vídeo. Normalmente, o valor é um código de fornecedor de quatro letras. |
fileDetails.durationMs |
unsigned long A duração do vídeo enviado em milissegundos. |
fileDetails.bitrateBps |
unsigned long A taxa de bits combinada (vídeo e áudio) do arquivo de vídeo enviado em bits por segundo. |
fileDetails.recordingLocation |
object Coordenadas geográficas que identificam o local onde o vídeo enviado foi gravado. As coordenadas são definidas usando WGS 84. |
fileDetails.recordingLocation.latitude |
double Latitude em graus. |
fileDetails.recordingLocation.longitude |
double Longitude em graus. |
fileDetails.recordingLocation.altitude |
double Altitude acima do elipsoide de referência, em metros. |
fileDetails.creationTime |
string A data e a hora em que o arquivo de vídeo enviado foi criado. O valor é especificado no formato ISO 8601. Atualmente, os seguintes formatos ISO 8601 são suportados:
|
processingDetails |
object O objeto processingProgress encapsula informações sobre o progresso do YouTube no processamento do arquivo de vídeo enviado. As propriedades do objeto identificam o status de processamento atual e uma estimativa do tempo restante até que o YouTube termine o processamento do vídeo. Esta parte também indica se os diferentes tipos de dados ou de conteúdo, como detalhes do arquivo ou imagens em miniatura, estão disponíveis para o vídeo.O objeto processingProgress foi desenvolvido para ser pesquisado para que o vídeo enviado possa acompanhar o progresso que o YouTube teve no processamento do arquivo de vídeo enviado. Esses dados só podem ser recuperados pelo proprietário do vídeo. |
processingDetails.processingStatus |
string O status de processamento do vídeo. Este valor indica se o YouTube conseguiu processar o vídeo ou se o vídeo ainda está sendo processado. Os valores válidos para esta propriedade são:
|
processingDetails.processingProgress |
object O objeto processingProgress contém informações sobre o andamento que o YouTube teve no processamento do vídeo. Os valores são realmente relevantes apenas se o status de processamento do vídeo for processing . |
processingDetails.processingProgress.partsTotal |
unsigned long Uma estimativa da quantidade total de partes que precisam ser processadas para o vídeo. O número pode ser atualizado com estimativas mais precisas enquanto o YouTube processa o vídeo. |
processingDetails.processingProgress.partsProcessed |
unsigned long A quantidade de partes do vídeo que o YouTube já processou. Você pode estimar a porcentagem do vídeo que o YouTube já processou calculando: 100 * parts_processed / parts_total Como a estimativa da quantidade de partes pode aumentar sem um aumento correspondente de sua quantidade já processada, é possível que o andamento calculado possa diminuir periodicamente enquanto o YouTube processa um vídeo. |
processingDetails.processingProgress.timeLeftMs |
unsigned long Uma estimativa da quantidade de tempo, em milissegundos, que o YouTube precisa para terminar o processamento do vídeo. |
processingDetails.processingFailureReason |
string O motivo pelo qual o YouTube falhou ao processar o vídeo. Esta propriedade só terá um valor se o valor da propriedade processingStatus for failed .Os valores válidos para esta propriedade são:
|
processingDetails.fileDetailsAvailability |
string Este valor indica se os detalhes do arquivo estão disponíveis para o vídeo enviado. Você pode recuperar os detalhes de um arquivo de vídeo solicitando a parte fileDetails em sua solicitação videos.list() . |
processingDetails.processingIssuesAvailability |
string Este valor indica se o mecanismo de processamento de vídeos gerou sugestões que possam melhorar a capacidade do YouTube de processar o vídeo, avisos que explicam os problemas de processamento do vídeo ou erros que causam problemas de processamento do vídeo. Você pode recuperar essas sugestões, solicitando a parte suggestions em sua solicitação videos.list() . |
processingDetails.tagSuggestionsAvailability |
string Este valor indica se as sugestões de palavra-chave (tag) estão disponíveis para o vídeo. As tags podem ser adicionadas aos metadados de um vídeo para facilitar que outros usuários encontrem-no. Você pode recuperar essas sugestões, solicitando a parte suggestions em sua solicitação videos.list() . |
processingDetails.editorSuggestionsAvailability |
string Este valor indica se as sugestões de edição de vídeo, que podem melhorar a qualidade do vídeo ou a experiência de reprodução, estão disponíveis para o vídeo. Você pode recuperar essas sugestões, solicitando a parte suggestions em sua solicitação videos.list() . |
processingDetails.thumbnailsAvailability |
string Este valor indica se as imagens em miniatura foram geradas para o vídeo. |
suggestions |
object O objeto suggestions encapsula sugestões que identificam oportunidades para melhorar a qualidade do vídeo ou os metadados para o vídeo enviado. Esses dados só podem ser recuperados pelo proprietário do vídeo. |
suggestions.processingErrors[] |
list A lista de erros que impedirão que o YouTube processe o vídeo enviado. Esses erros indicam que, no final, independentemente do status de processamento atual do vídeo, o status será certamente failed .Os valores válidos para esta propriedade são:
|
suggestions.processingWarnings[] |
list Uma lista de motivos pelos quais o YouTube pode ter dificuldade em transcodificar o vídeo enviado ou que possa resultar em uma transcodificação errônea. Esses avisos são gerados antes de o YouTube realmente processar o arquivo de vídeo enviado. Além disso, eles identificam problemas que não necessariamente indicam que o processamento do vídeo falhará, mas que ele pode causar problemas, como de sincronização, artefatos de vídeo ou uma faixa de áudio em falta. Os valores válidos para esta propriedade são:
|
suggestions.processingHints[] |
list A lista de sugestões que podem melhorar a capacidade do YouTube de processar o vídeo. Os valores válidos para esta propriedade são:
|
suggestions.tagSuggestions[] |
list A lista de tags de palavras-chave que podem ser adicionadas aos metadados do vídeo para aumentar a probabilidade de os usuários localizarem seu vídeo ao pesquisar ou navegar no YouTube. |
suggestions.tagSuggestions[].tag |
string A tag de palavra-chave sugerida para o vídeo. |
suggestions.tagSuggestions[].categoryRestricts[] |
list Um conjunto de categorias de vídeo para as quais a tag é relevante. Você pode usar essas informações para exibir sugestões de tags apropriadas com base na categoria de vídeo que o usuário que faz upload associa ao vídeo. Por padrão, sugestões de tags são relevantes para todas as categorias se não houver restrições definidas para a palavra-chave. |
suggestions.editorSuggestions[] |
list A lista de operações de edição de vídeo que podem melhorar a qualidade do vídeo ou a experiência de reprodução do vídeo enviado. Os valores válidos para esta propriedade são:
|