Esta página lista as mudanças na API e as atualizações da documentação para a API YouTube Reporting e a API YouTube Analytics. As duas APIs permitem que os desenvolvedores acessem dados do YouTube Analytics, mas de maneiras diferentes. Inscreva-se neste registro de alterações.
24 de junho de 2025
Conforme anunciado em 26 de março de 2025, a API Bulk Reports será atualizada como parte da nova mudança na contagem de visualizações do Shorts. As seguintes mudanças foram feitas:
- Novas versões de relatório foram criadas para cada relatório que inclui visualizações, que é a maioria deles. A versão de cada relatório afetado foi incrementada em um, como da versão
a2
para aa3
. - Para os Shorts, as visualizações vão contar quantas vezes um vídeo começa ou é repetido. Para vídeos, não há mudanças.
- Os relatórios atualizados vão incluir uma nova coluna,
engaged_views
, que vai refletir a metodologia anterior de contagem de visualizações.
Essas mudanças entram em vigor em 30 de junho de 2025 para a API Bulk Reports. Ajuste o processamento de relatórios de acordo com isso.
As versões anteriores do relatório vão ficar disponíveis até 30 de setembro de 2025. Depois de 30 de setembro de 2025, as versões anteriores serão descontinuadas. Migre para as versões mais recentes.
Por fim, siga as práticas recomendadas ao processar os relatórios para evitar que mudanças futuras nos relatórios interrompam seus pipelines de processamento.
As tabelas a seguir mostram as novas versões de relatório para cada tipo:
Relatórios de dados em massa do YouTube Analytics
Relatórios do canal: Relatórios de vídeo | ||
---|---|---|
Nome do relatório | Versão anterior | Versão mais recente |
Atividade do usuário | channel_basic_a2 | channel_basic_a3 |
Atividade do usuário por província | channel_province_a2 | channel_province_a3 |
Locais de reprodução | channel_playback_location_a2 | channel_playback_location_a3 |
Origens de tráfego | channel_traffic_source_a2 | channel_traffic_source_a3 |
Tipo de dispositivo e sistema operacional | channel_device_os_a2 | channel_device_os_a3 |
Legendas | channel_subtitles_a2 | channel_subtitles_a3 |
Combinado | channel_combined_a2 | channel_combined_a3 |
Relatórios de canal: Relatórios de playlists | ||
---|---|---|
Nome do relatório | Versão anterior | Versão mais recente |
Atividade do usuário | playlist_basic_a1 | playlist_basic_a2 |
Atividade do usuário por província | playlist_province_a1 | playlist_province_a2 |
Locais de reprodução | playlist_playback_location_a1 | playlist_playback_location_a2 |
Origens de tráfego | playlist_traffic_source_a1 | playlist_traffic_source_a2 |
Tipo de dispositivo e sistema operacional | playlist_device_os_a1 | playlist_device_os_a2 |
Combinado | playlist_combined_a1 | playlist_combined_a2 |
Relatórios do proprietário do conteúdo: relatórios de vídeo | ||
---|---|---|
Nome do relatório | Versão anterior | Versão mais recente |
Atividade do usuário | content_owner_basic_a3 | content_owner_basic_a4 |
Atividade do usuário por província | content_owner_province_a2 | content_owner_province_a3 |
Locais de reprodução | content_owner_playback_location_a2 | content_owner_playback_location_a3 |
Origens de tráfego | content_owner_traffic_source_a2 | content_owner_traffic_source_a3 |
Tipo de dispositivo e sistema operacional | content_owner_device_os_a2 | content_owner_device_os_a3 |
Legendas | content_owner_subtitles_a2 | content_owner_subtitles_a3 |
Combinado | content_owner_combined_a2 | content_owner_combined_a3 |
Relatórios do proprietário do conteúdo: Relatórios de playlists | ||
---|---|---|
Nome do relatório | Versão anterior | Versão mais recente |
Atividade do usuário | content_owner_playlist_basic_a1 | content_owner_playlist_basic_a2 |
Atividade do usuário por província | content_owner_playlist_province_a1 | content_owner_playlist_province_a2 |
Locais de reprodução | content_owner_playlist_playback_location_a1 | content_owner_playlist_playback_location_a2 |
Origens de tráfego | content_owner_playlist_traffic_source_a1 | content_owner_playlist_traffic_source_a2 |
Tipo de dispositivo e sistema operacional | content_owner_playlist_device_os_a1 | content_owner_playlist_device_os_a2 |
Combinado | content_owner_playlist_combined_a1 | content_owner_playlist_combined_a2 |
Relatórios do proprietário do conteúdo: Relatórios de recursos | ||
---|---|---|
Nome do relatório | Versão anterior | Versão mais recente |
Atividade do usuário | content_owner_asset_basic_a2 | content_owner_asset_basic_a3 |
Atividade do usuário por província | content_owner_asset_province_a2 | content_owner_asset_province_a3 |
Locais de reprodução do vídeo | content_owner_asset_playback_location_a2 | content_owner_asset_playback_location_a3 |
Origens de tráfego | content_owner_asset_traffic_source_a2 | content_owner_asset_traffic_source_a3 |
Tipo de dispositivo e sistema operacional | content_owner_asset_device_os_a2 | content_owner_asset_device_os_a3 |
Combinado | content_owner_asset_combined_a2 | content_owner_asset_combined_a3 |
Relatórios gerenciados pelo sistema — financeiros (não relacionados à música)
Relatórios do proprietário do conteúdo: Relatórios do Shorts (não musicais) | ||
---|---|---|
Nome do relatório | Versão anterior | Versão mais recente |
Resumo da receita de publicidade global | content_owner_shorts_global_ad_revenue_summary_a1 | content_owner_shorts_global_ad_revenue_summary_a2 |
Resumo diário da receita de publicidade | content_owner_shorts_day_ad_revenue_summary_a1 | content_owner_shorts_day_ad_revenue_summary_a2 |
Resumo da receita de publicidade por país | content_owner_shorts_country_ad_revenue_summary_a1 | content_owner_shorts_country_ad_revenue_summary_a2 |
Resumo da receita de publicidade | content_owner_shorts_ad_revenue_summary_a1 | content_owner_shorts_ad_revenue_summary_a2 |
Relatórios gerenciados pelo sistema — Não financeiros
Relatórios do proprietário do conteúdo: Relatórios de reivindicações | ||
---|---|---|
Nome do relatório | Versão anterior | Versão mais recente |
Reivindicações ativas | content_owner_active_claims_a2 | content_owner_active_claims_a3 |
Relatórios do proprietário do conteúdo: relatórios de metadados de vídeo | ||
---|---|---|
Nome do relatório | Versão anterior | Versão mais recente |
Metadados do vídeo | content_owner_video_metadata_a3 | content_owner_video_metadata_a4 |
Relatórios do proprietário do conteúdo: Relatórios de recursos | ||
---|---|---|
Nome do relatório | Versão anterior | Versão mais recente |
Recursos | content_owner_asset_a2 | content_owner_asset_a3 |
Conflitos de recurso | content_owner_asset_conflict_a2 | content_owner_asset_conflict_a3 |
24 de abril de 2025
Conforme anunciado em 26 de março de 2025, a API Targeted Queries será atualizada como parte da nova mudança na contagem de visualizações do Shorts:
- Para os Shorts, o
views
agora conta quantas vezes um vídeo começa ou é repetido. - Uma nova métrica,
engagedViews
, vai refletir a metodologia anterior de contagem de visualizações.engagedViews
vai estar disponível em todos os relatórios junto comviews
.
Essas mudanças vão entrar em vigor em 30 de abril de 2025 para a API Targeted Queries. Ajuste suas consultas de acordo com isso.
Confira este histórico de revisões para saber quais mudanças serão feitas na API Bulk Reports e quando.
22 de abril de 2025
Conforme anunciado em 7 de abril de 2024, a dimensão isCurated
foi descontinuada para relatórios de canais e playlists de proprietários de conteúdo. A partir de 31 de dezembro de 2024, a dimensão não será mais compatível. Ela foi removida dos relatórios e da documentação.
26 de março de 2025
Esta atualização contém a seguinte mudança relacionada às APIs YouTube Analytics e Reporting:
A partir de 31 de março de 2025, o YouTube vai mudar a forma de contar as visualizações dos Shorts. Antes, para os Shorts, uma visualização era contabilizada depois que o vídeo era exibido por alguns segundos. Agora, as visualizações vão contabilizar quantas vezes o Short começa a ser reproduzido ou reprisado, sem um tempo mínimo de exibição. Saiba mais
As APIs YouTube Analytics (consultas segmentadas) e Reporting (relatórios em massa) serão atualizadas com as seguintes mudanças:
- Para os Shorts,
views
contam quantas vezes um vídeo começa ou é repetido. - Uma nova métrica,
engagedViews
, será disponibilizada e vai refletir a metodologia anterior de contagem de visualizações. - Se você for proprietário de um canal ou tiver autorização para acessar os dados dele, poderá consultar as visualizações atualizadas e as visualizações engajadas.
As consultas segmentadas serão atualizadas até 30 de abril, e os relatórios em massa, até 30 de junho. Até lá, as visualizações serão baseadas na metodologia antiga. As visualizações de Shorts e do canal não correspondem às do Analytics no Studio.
Além disso, a suspensão anunciada anteriormente do relatório "Reivindicações diárias" (versão 1.0) foi adiada.
Consulte este histórico de revisões para saber quando as mudanças são feitas nas APIs.
3 de março de 2025
Esta atualização contém a seguinte mudança relacionada à API YouTube Reporting:
Observação:este é um anúncio de suspensão de uso.
O relatório Reivindicações diárias (versão 1.0) foi descontinuado para parceiros. Ele não será mais compatível a partir de 30 de abril de 2025. A definição desse relatório foi atualizada de acordo. Use o relatório diário de reivindicações mais recente.
15 de novembro de 2024
Observação:a mudança a seguir entra em vigor em 18 de novembro de 2024.
A documentação da API YouTube Analytics (consultas segmentadas) foi atualizada para informar que, nos relatórios de origem de tráfego,o método reports.query
da API agora retorna um erro se o produto de número de vídeos consultados X número de dias no período exceder 50.000. Por exemplo, uma consulta que recupera dados de 500 IDs de vídeo pode solicitar dados de um máximo de 100 dias.
Essa mudança afeta os relatórios de canais e proprietários de conteúdo.
Para reduzir o número de linhas retornadas por uma solicitação, divida a consulta em várias que especifiquem menos vídeos ou definam períodos mais curtos. Como regra geral, os relatórios em massa são recomendados para grandes conjuntos de dados.
6 de maio de 2024
A API YouTube Analytics (consultas segmentadas) oferece suporte a três novos relatórios para canais:
-
O relatório Atividade do usuário por DMA é um relatório geográfico que fornece estatísticas de atividade do usuário por área designada do mercado (DMA). Para esse relatório, defina o valor do parâmetro
filters
comocountry==US
. -
O relatório Espectadores simultâneos mostra o número de espectadores simultâneos em diferentes partes de um único vídeo transmitido ao vivo.
-
O relatório Cancelamentos de membros mostra estatísticas sobre os motivos que levaram os usuários a cancelar as assinaturas do clube do canal.
Esse relatório usa a nova dimensão
membershipsCancellationSurveyReason
, que especifica por que um usuário cancelou uma assinatura de canal. Ela também usa a nova métricamembershipsCancellationSurveyResponses
, que indica quantas assinaturas foram canceladas por esse motivo.
Além disso, o relatório Retenção de público-alvo foi aprimorado para oferecer suporte a três novas métricas:
7 de abril de 2024
A API YouTube Analytics (consultas segmentadas) tem várias atualizações relacionadas aos relatórios de playlists de proprietários de conteúdo. As atualizações são as mesmas dos relatórios de playlists do canal, que foram anunciadas em 19 de janeiro de 2024.
A entrada de histórico de revisões a seguir fornece quase as mesmas informações que a entrada de 19 de janeiro de 2024. No entanto, os relatórios de playlists do proprietário do conteúdo vão oferecer suporte à dimensão isCurated
até 31 de dezembro de 2024, enquanto os relatórios de playlists do canal vão oferecer suporte a ela até 30 de junho de 2024.
-
Observação:este é um anúncio de suspensão de uso.
A dimensão
isCurated
foi descontinuada para relatórios de playlists de proprietários de conteúdo. Ele não terá mais suporte a partir de 31 de dezembro de 2024. A definição dessa dimensão foi atualizada.Para preservar a compatibilidade com versões anteriores ao remover a dimensão
isCurated
, atualize seu código para extrair a métricaplaylistViews
em vez da métricaviews
apenas para relatórios de playlist. Como a métricaviews
ainda é compatível com relatórios de playlists, embora com um significado diferente, a API ainda vai retornar dados se você não atualizar o nome da métrica. É claro que você pode modificar seu aplicativo para recuperar e mostrarviews
eplaylistViews
.Além da dimensão
isCurated
, a seguinte funcionalidade da API não é mais compatível com os novos relatórios:- Os filtros de local, como
continent
esubcontinent
, não são compatíveis com os novos relatórios de playlists do canal. - As métricas
redViews
eestimatedRedMinutesWatched
não são mais compatíveis com os novos relatórios de playlists do canal. Essas métricas não estavam disponíveis no YouTube Studio. Por isso, essa mudança alinha a funcionalidade da API com a funcionalidade disponível no aplicativo Studio. - As dimensões
subscribedStatus
eyoutubeProduct
não são mais aceitas como filtros para relatórios de playlists do canal. Esses filtros não estavam disponíveis no YouTube Studio. Por isso, essa mudança alinha a funcionalidade da API com a funcionalidade disponível no aplicativo Studio.
- Os filtros de local, como
-
A seção Relatórios de playlist da documentação de relatórios do proprietário do conteúdo foi atualizada para explicar melhor os tipos de métricas compatíveis com esses relatórios:
- As métricas agregadas de vídeo
fornecem métricas de atividade do usuário e de impressão agregadas para todos os vídeos nas
playlists do proprietário do conteúdo que também são de propriedade dele. As métricas de vídeo agregadas são compatíveis apenas com solicitações de API que não usam a dimensão
isCurated
. - As métricas na playlist refletem a atividade e o engajamento do usuário no contexto da página da playlist. Essas métricas incluem dados de visualizações de vídeos que não são seus na playlist, mas apenas quando essas visualizações ocorreram no contexto da playlist.
- A seção métricas de playlist compatíveis identifica as métricas agregadas de vídeo e na playlist que são compatíveis com os relatórios de playlist.
- As métricas agregadas de vídeo
fornecem métricas de atividade do usuário e de impressão agregadas para todos os vídeos nas
playlists do proprietário do conteúdo que também são de propriedade dele. As métricas de vídeo agregadas são compatíveis apenas com solicitações de API que não usam a dimensão
-
As seguintes métricas na playlist são compatíveis com relatórios de playlists para proprietários de conteúdo. Essas métricas só são compatíveis se a solicitação da API para recuperar os relatórios não usar a dimensão
isCurated
. Consulte a documentação de métricas para definições de cada métrica: -
O comportamento da métrica
views
agora depende de a solicitação de API que recuperou o relatório de playlist ter usado a dimensãoisCurated
:- Quando uma solicitação inclui a dimensão
isCurated
, a métricaviews
é uma métrica na playlist que indica o número de vezes que os vídeos foram assistidos no contexto das playlists do proprietário do conteúdo. - Quando uma solicitação não inclui a dimensão
isCurated
, a métricaviews
é uma métrica de vídeo agregada que especifica o número total de vezes que os vídeos nas playlists do proprietário do conteúdo foram assistidos, independentemente de essas visualizações terem ocorrido no contexto da playlist. O total agregado inclui apenas visualizações de vídeos de propriedade do proprietário do conteúdo associado ao canal que é dono da playlist.
Nesses relatórios, que não usam a dimensãoisCurated
, a métricaplaylistViews
indica o número de vezes que os vídeos foram assistidos no contexto da playlist. Essa métrica conta as visualizações de todos os vídeos da playlist, não importa de qual canal eles sejam.
- Quando uma solicitação inclui a dimensão
-
Para cada relatório de playlist, a documentação de relatórios do proprietário do conteúdo agora inclui tabelas que mostram as métricas compatíveis com esse relatório, dependendo se a solicitação de API inclui a dimensão
isCurated
. Consulte a seção que define os relatórios de playlists com base em tempo para ver um exemplo.
19 de janeiro de 2024
A API YouTube Analytics (consultas segmentadas) tem várias atualizações relacionadas aos relatórios de playlists do canal. As atualizações incluem uma dimensão descontinuada e várias métricas novas e atualizadas:
-
Observação:este é um anúncio de suspensão de uso.
A dimensão
isCurated
foi descontinuada para relatórios de canais. Ele não vai mais estar disponível a partir de 30 de junho de 2024. A definição dessa dimensão foi atualizada de acordo.Para preservar a compatibilidade com versões anteriores ao remover a dimensão
isCurated
, atualize seu código para extrair a métricaplaylistViews
em vez da métricaviews
apenas para relatórios de playlist. Como a métricaviews
ainda é compatível com relatórios de playlists, embora com um significado diferente, a API ainda vai retornar dados se você não atualizar o nome da métrica. É claro que você pode modificar seu aplicativo para recuperar e mostrarviews
eplaylistViews
.Além da dimensão
isCurated
, a seguinte funcionalidade da API não é mais compatível com os novos relatórios:- Os filtros de local, como
continent
esubcontinent
, não são compatíveis com os novos relatórios de playlists do canal. - As métricas
redViews
eestimatedRedMinutesWatched
não são mais compatíveis com os novos relatórios de playlists do canal. Essas métricas não estavam disponíveis no YouTube Studio. Por isso, essa mudança alinha a funcionalidade da API com a funcionalidade disponível no aplicativo Studio. - As dimensões
subscribedStatus
eyoutubeProduct
não são mais aceitas como filtros para relatórios de playlists do canal. Esses filtros não estavam disponíveis no YouTube Studio. Por isso, essa mudança alinha a funcionalidade da API com a funcionalidade disponível no aplicativo Studio.
- Os filtros de local, como
-
A seção Relatórios de playlists da documentação de relatórios do canal foi atualizada para explicar melhor os tipos de métricas compatíveis com esses relatórios:
- As métricas agregadas de vídeo
fornecem métricas de atividade do usuário e de impressão agregadas para todos os vídeos nas
playlists do canal que também são de propriedade dele. As métricas de vídeo agregadas são compatíveis apenas com solicitações de API que não usam a dimensão
isCurated
. - As métricas na playlist refletem a atividade e o engajamento do usuário no contexto da página da playlist. Essas métricas incluem dados de visualizações de vídeos que não são seus na playlist, mas apenas quando essas visualizações ocorreram no contexto da playlist.
- A seção métricas de playlist compatíveis identifica as métricas agregadas de vídeo e na playlist que são compatíveis com os relatórios de playlist.
- As métricas agregadas de vídeo
fornecem métricas de atividade do usuário e de impressão agregadas para todos os vídeos nas
playlists do canal que também são de propriedade dele. As métricas de vídeo agregadas são compatíveis apenas com solicitações de API que não usam a dimensão
-
As seguintes métricas na playlist são compatíveis com relatórios de playlists para canais: Essas métricas ainda não são compatíveis com os relatórios de proprietários de conteúdo. Essas métricas só são compatíveis se a solicitação de API para recuperar os relatórios não usar a dimensão
isCurated
. Consulte a documentação de métricas para definições de cada métrica: -
O comportamento da métrica
views
agora depende de a solicitação de API que recuperou o relatório de playlist ter usado a dimensãoisCurated
:- Quando uma solicitação inclui a dimensão
isCurated
, a métricaviews
é uma métrica na playlist que indica o número de vezes que os vídeos foram assistidos no contexto das playlists do canal. - Quando uma solicitação não inclui a dimensão
isCurated
, a métricaviews
é uma métrica de vídeo agregada que especifica o número total de vezes que o vídeo nas playlists do canal foi assistido, independente de ter sido no contexto da playlist. O total agregado inclui apenas visualizações de vídeos que são de propriedade do canal que possui a playlist.
Nesses relatórios, que não usam a dimensãoisCurated
, a métricaplaylistViews
indica o número de vezes que os vídeos foram assistidos no contexto da playlist. Essa métrica conta as visualizações de todos os vídeos da playlist, não importa de qual canal eles sejam.
- Quando uma solicitação inclui a dimensão
-
Para cada relatório de playlist, a documentação de relatórios de canal agora inclui tabelas que mostram as métricas compatíveis com esse relatório, dependendo se a solicitação de API inclui a dimensão
isCurated
. Consulte a seção que define os relatórios de playlists com base em tempo para ver um exemplo.
04 de dezembro de 2023
A API YouTube Analytics (consultas segmentadas) foi atualizada para mesclar dois valores de dimensão insightTrafficSourceType
. Antes, a dimensão diferenciava entre vídeos reproduzidos como parte de uma playlist (PLAYLIST
) e visualizações originadas de uma página que lista todos os vídeos em uma playlist (YT_PLAYLIST_PAGE
). Agora, os dois tipos de visualizações serão associados ao valor da dimensão PLAYLIST
.
15 de dezembro de 2022
A API YouTube Analytics (consultas segmentadas) é compatível com duas novas dimensões e um novo relatório:
-
Um novo relatório mostra a atividade do usuário por cidade. Esse relatório está disponível para canais e proprietários de conteúdo. Esse relatório contém a nova dimensão
city
, que identifica a estimativa do YouTube da cidade em que a atividade do usuário ocorreu. -
A nova dimensão
creatorContentType
identifica o tipo de conteúdo do YouTube associado às métricas de atividade do usuário na linha de dados. Os valores aceitos sãoLIVE_STREAM
,SHORTS
,STORY
eVIDEO_ON_DEMAND
.A dimensão
creatorContentType
é compatível como uma opção para todos os relatórios de vídeo de canais e proprietários de conteúdo. -
O guia de exemplos de solicitações da API YouTube Analytics agora inclui exemplos para as duas novas dimensões.
-
As referências às dimensões
7DayTotals
e30DayTotals
foram removidas da documentação. A descontinuação dessas dimensões foi anunciada em outubro de 2019.
26 de agosto de 2022
A API YouTube Analytics (consultas segmentadas) e a API YouTube Reporting (relatórios em massa) são compatíveis com um novo valor de detalhe da origem de tráfego:
- Na API YouTube Analytics (consultas segmentadas), se o valor da dimensão
insightTrafficSourceType
forSUBSCRIBER
, o valorinsightTrafficSourceDetail
poderá ser definido comopodcasts
, o que indica que o tráfego foi encaminhado da página de destino do Podcasts. - Na API YouTube Reporting (relatórios em massa), se o valor da dimensão
traffic_source_type
for3
, o valortraffic_source_detail
poderá ser definido comopodcasts
, o que indica que o tráfego foi encaminhado da página de destino do Podcasts.
11 de fevereiro de 2022
O conjunto de valores válidos para a dimensão gender
vai mudar a partir de 11 de agosto de 2022. Isso pode ser uma mudança incompatível com versões anteriores na implementação da API. De acordo com a seção Mudanças incompatíveis com versões anteriores dos Termos de Serviço das APIs do YouTube, essa mudança está sendo anunciada seis meses antes de entrar em vigor. Atualize sua implementação da API
antes de 11 de agosto de 2022 para garantir uma transição tranquila para o novo conjunto de valores.
As mudanças específicas são:
- Na API YouTube Analytics (consultas segmentadas), a dimensão
gender
atualmente aceita dois valores:female
emale
. Em 11 de agosto de 2022 ou depois dessa data, essa dimensão vai aceitar três valores:female
,male
euser_specified
. - Na API YouTube Reporting (relatórios em massa), a dimensão
gender
atualmente aceita três valores:FEMALE
,MALE
eGENDER_OTHER
. Em 11 de agosto de 2022 ou depois dessa data, o conjunto de valores aceitos vai mudar paraFEMALE
,MALE
eUSER_SPECIFIED
.
9 de fevereiro de 2022
Duas métricas foram atualizadas para excluir o tráfego de clipes em loop a partir de 13 de dezembro de 2021. Essa mudança afeta a API YouTube Analytics (consultas segmentadas) e a API YouTube Reporting (relatórios em massa).
- Na API YouTube Analytics (consultas segmentadas), as métricas
averageViewDuration
eaverageViewPercentage
excluem o tráfego de vídeos em loop desde 13 de dezembro de 2021. - Na API YouTube Reporting (relatórios em massa), as métricas
average_view_duration_seconds
eaverage_view_duration_percentage
excluem o tráfego de vídeos em loop desde 13 de dezembro de 2021.
2 de fevereiro de 2022
A API YouTube Reporting (relatórios em massa) oferece suporte a um novo valor de dimensão de origem de tráfego que indica que as visualizações vieram de Redirecionamentos de lives:
- Na API YouTube Reporting (relatórios em massa), a dimensão
traffic_source_type
aceita o valor28
.
Para esse tipo de origem de tráfego, a dimensão traffic_source_detail
especifica o ID do canal de onde o espectador foi encaminhado.
23 de setembro de 2020
A API YouTube Analytics (consultas segmentadas) e a API YouTube Reporting (relatórios em massa) são compatíveis com um novo valor de dimensão de origem de tráfego que indica que o espectador foi encaminhado ao deslizar verticalmente na experiência de visualização do YouTube Shorts:
- Na API YouTube Analytics (consultas segmentadas), a dimensão
insightTrafficSourceType
aceita o valorSHORTS
. - Na API YouTube Reporting (relatórios em massa), a dimensão
traffic_source_type
aceita o valor24
.
A dimensão de detalhes da origem do tráfego — insightTrafficSourceDetail
na API YouTube Analytics ou traffic_source_detail
na API YouTube Reporting — não é preenchida para esse novo tipo de origem.
20 de julho de 2020
Esta atualização aborda duas mudanças que afetam a API YouTube Analytics (consultas segmentadas):
- O tamanho máximo de um grupo de relatórios do YouTube Analytics aumentou de 200 para 500 entidades.
- O parâmetro
filters
do métodoreports.query
identifica uma lista de filtros que precisam ser aplicados ao recuperar dados do YouTube Analytics. O parâmetro permite especificar vários valores para os filtrosvideo
,playlist
echannel
. Além disso, o número máximo de IDs que podem ser especificados para esses filtros aumentou de 200 para 500.
13 de fevereiro de 2020
Esta atualização contém as seguintes mudanças relacionadas às APIs YouTube Analytics (consultas segmentadas) e YouTube Reporting (relatórios em massa). Saiba mais sobre essas mudanças na Central de Ajuda do YouTube.
Em ambas as APIs, o conjunto de valores possíveis de detalhes da origem de tráfego para notificações está mudando.
Nas consultas segmentadas, as notificações são informadas como insightTrafficSourceType=NOTIFICATION
. Nos relatórios em massa, as notificações são informadas como traffic_source_type=17
.
Os novos valores dividem as notificações relacionadas a vídeos enviados e transmissões ao vivo, antes
informadas como uploaded
, em duas categorias:
uploaded_push
- Visualizações originadas de notificações push enviadas aos inscritos quando um vídeo foi enviadouploaded_other
: visualizações originadas de notificações não push, como e-mail ou notificações da caixa de entrada, enviadas aos inscritos quando um vídeo foi enviado.
Esses valores são retornados para o período que começa em 13 de janeiro de 2020.
Além disso, vale lembrar que esses valores não representam as notificações em si, mas sim as origens de tráfego que geraram determinadas visualizações do YouTube. Por exemplo, se uma linha do relatório indicar views=3
, traffic_source_type=17
(NOTIFICATION
) e traffic_source_detail=uploaded_push
, isso significa que três visualizações resultaram de espectadores que clicaram nas notificações push enviadas quando o vídeo foi enviado.
15 de outubro de 2019
Esta atualização contém as seguintes mudanças relacionadas à API YouTube Analytics (consultas segmentadas):
-
Observação:este é um anúncio de suspensão de uso.
O YouTube vai remover o suporte às dimensões
7DayTotals
e30DayTotals
. Você ainda pode recuperar dados usando essas dimensões até 15 de abril de 2020. A partir dessa data, as tentativas de extrair relatórios usando a dimensão7DayTotals
ou30DayTotals
vão retornar um erro.Os usuários podem reproduzir alguns dos dados dessas dimensões consultando a dimensão
day
e agregando ou derivando dados em períodos de sete ou 30 dias. Exemplo:- Para calcular o número de visualizações em um período de sete dias, agregue o número de visualizações de cada dia desse período.
- Para calcular o viewerPercentage de um período de sete dias, multiplique o número de visualizações que ocorreram em cada dia pelo viewerPercentage desse dia para saber o número de espectadores que estavam conectados ao assistir o vídeo naquele dia. Em seguida, o número de espectadores conectados pode ser adicionado para todo o período e dividido pelo número total de visualizações nesse período para gerar o viewerPercentage para todo o período.
- Não é possível calcular o número de espectadores únicos em um período de sete dias, já que o mesmo espectador pode ser contado como único em dias diferentes. No entanto, talvez seja possível usar a dimensão
month
em vez da30DayTotals
para extrapolar dados sobre o número de espectadores únicos em um período de 30 dias. A dimensãomonth
se refere a meses civis, enquanto a dimensão30DayTotals
calcula períodos de 30 dias com base nas datas de início e término especificadas.
27 de junho de 2019
Esta atualização contém as seguintes mudanças relacionadas à API YouTube Analytics (consultas segmentadas):
-
Como a versão 1 da API foi totalmente descontinuada, a documentação foi atualizada para remover referências a essa versão, incluindo o aviso de descontinuação e o guia de migração explicando como atualizar para a versão 2.
1º de novembro de 2018
Esta atualização contém as seguintes mudanças relacionadas à API YouTube Analytics (consultas segmentadas):
-
A versão 1 da API foi descontinuada. Se você ainda não fez isso, atualize seus clientes de API para usar a versão 2 da API o mais rápido possível e minimizar as interrupções no serviço. Para mais detalhes, consulte o guia de migração.
O cronograma dessa descontinuação foi anunciado originalmente em 26 de abril de 2018.
17 de setembro de 2018
Esta atualização contém as seguintes mudanças relacionadas à API YouTube Analytics (consultas segmentadas):
-
A nova seção anonimização de dados no documento de visão geral do modelo de dados explica que alguns dados do YouTube Analytics são limitados quando as métricas não atingem um determinado limite. Isso pode acontecer em vários casos. Na prática, isso significa que um relatório pode não conter todos (ou nenhum) dos seus dados se:
-
um vídeo ou canal tem tráfego limitado durante um período especificado;
ou
-
você selecionou um filtro ou uma dimensão, como origem do tráfego ou país, para os quais os valores não atingem determinado limite.
A nova seção também inclui uma discussão sobre os tipos de dados que podem ser limitados nos relatórios do YouTube Analytics.
-
-
Os documentos de relatórios do canal e relatórios do proprietário do conteúdo foram atualizados para refletir o fato de que as métricas
redViews
eestimatedRedMinutesWatched
não são mais compatíveis com os relatórios de local de reprodução, origem do tráfego e tipo de dispositivo/sistema operacional.
18 de junho de 2018
Esta atualização contém as seguintes mudanças na API YouTube Analytics (consultas segmentadas):
- Os requisitos de escopo para os seguintes métodos mudaram:
- As solicitações ao método
reports.query
precisam ter acesso ao escopohttps://www.googleapis.com/auth/youtube.readonly
. - As solicitações ao método
groupItems.list
precisam ter acesso a:- o escopo
https://www.googleapis.com/auth/youtube
ou - o escopo
https://www.googleapis.com/auth/youtube.readonly
e
o escopohttps://www.googleapis.com/auth/yt-analytics.readonly
A primeira opção usa um escopo, que é de leitura/gravação, enquanto a segunda usa dois escopos somente leitura.
- o escopo
- As solicitações ao método
23 de maio de 2018
Esta atualização contém as seguintes mudanças na API YouTube Analytics (consultas segmentadas):
- A visão geral da API tem uma nova seção, Métricas agregadas e itens excluídos, que explica como as respostas da API processam dados associados a recursos excluídos, como vídeos, playlists ou canais.
- A seção Práticas recomendadas da Visão geral da API foi atualizada para lembrar que você pode usar a API YouTube Data para recuperar metadados adicionais de recursos identificados nas respostas da API YouTube Analytics. Conforme observado nas Políticas para desenvolvedores de serviços da API YouTube (seções III.E.4.b a III.E.4.d), os clientes da API precisam excluir ou atualizar os metadados de recursos armazenados dessa API após 30 dias.
22 de maio de 2018
Esta atualização contém as seguintes mudanças relacionadas à API YouTube Reporting (relatórios em massa):
- As mudanças a seguir estão programadas para entrar em vigor em julho de 2018, e as novas políticas se aplicam globalmente a todos os relatórios e jobs de relatórios.
-
Após a mudança, a maioria dos relatórios da API, incluindo os de preenchimento, ficará disponível por 60 dias a partir do momento em que forem gerados. No entanto, os relatórios com dados históricos ficam disponíveis por 30 dias a partir do momento em que são gerados.
Antes desse anúncio, todos os relatórios da API ficavam disponíveis por 180 dias a partir do momento em que eram gerados. Quando essa mudança na política entrar em vigor, os relatórios de dados históricos com mais de 30 dias também não poderão mais ser acessados pela API. Todos os outros relatórios com mais de 60 dias também não poderão mais ser acessados. Por isso, a documentação agora afirma que os relatórios criados antes da mudança na política vão ficar disponíveis por até 180 dias.
-
Depois da mudança, quando você programar um job de relatórios, o YouTube vai gerar relatórios a partir desse dia e cobrindo o período de 30 dias antes da programação do job. Antes da mudança, quando você programava um job de geração de relatórios, o YouTube gerava relatórios referentes ao período de 180 dias antes da programação do job.
-
-
A seção de práticas recomendadas foi atualizada para lembrar que você pode usar a API YouTube Data para recuperar metadados adicionais dos recursos identificados nos relatórios. Conforme observado nas Políticas para desenvolvedores de serviços da API YouTube (seções III.E.4.b a III.E.4.d), os clientes da API precisam excluir ou atualizar os metadados de recursos armazenados dessa API após 30 dias.
-
A seção Características do relatório foi atualizada para informar que, embora os dados do relatório não sejam filtrados, os relatórios que contêm dados de um período a partir de 1º de junho de 2018 não terão referências a recursos do YouTube excluídos pelo menos 30 dias antes da data de geração do relatório.
-
A seção Dados históricos da visão geral da API foi atualizada para informar que, ao programar um novo job de relatórios, os relatórios históricos geralmente são postados em alguns dias. Antes, a documentação afirmava que esses relatórios podiam levar até 30 dias para ficar disponíveis.
-
A seção Dados de preenchimento automático da visão geral da API foi atualizada para definir mais claramente dados de preenchimento automático como um conjunto de dados que substitui um conjunto entregue anteriormente.
26 de abril de 2018
A versão 2 da API YouTube Analytics (consultas segmentadas) (v2) já está disponível publicamente. A lista a seguir identifica as mudanças no produto e na documentação relacionadas à nova versão da API:
-
A API v2 é quase idêntica à API v1. No entanto, provavelmente será necessário atualizar seu código para refletir as mudanças listadas abaixo. Todas essas mudanças são explicadas em detalhes no novo guia de migração.
- A versão da API mudou de
v1
parav2
. - O URL base para solicitações de API mudou de
https://www.googleapis.com/youtube/analytics/v1
parahttps://youtubeanalytics.googleapis.com/v2
. - Vários parâmetros do método
reports.query
tiveram os nomes atualizados. Especificamente, os nomes de parâmetros que contêm hífens, comoend-date
na API v1, usam camel case (endDate
) em vez de hífens na API v2. Essa mudança torna os nomes de parâmetros consistentes em toda a API, já que os métodos dela para criar e gerenciar grupos já usavam camel case para nomes de parâmetros. - A API v2 não aceita solicitações em lote enviadas ao endpoint de lote HTTP global do Google (
www.googleapis.com/batch
). Se você estiver enviando solicitações em lote na API v2, use o endpointhttps://youtubeanalytics.googleapis.com/v2
.
Além disso, alguns recursos da v1 não são compatíveis com a API v2:
- O método
reports.query
não é mais compatível com os parâmetros de solicitaçãoalt
,quotaUser
euserIp
. - A API v2 não oferece um endpoint em lote que aceite lotes compostos por solicitações para diferentes APIs. Um lote pode ser composto por solicitações para diferentes métodos da mesma API. Essa descontinuação não é específica da API YouTube Analytics, já que o Google está descontinuando o endpoint de lote global em todas as APIs.
- A API v2 não é compatível com o protocolo JSON-RPC, que era compatível com a API v1. De novo, essa descontinuação não é específica da API YouTube Analytics.
- A versão da API mudou de
-
Observação:este é um anúncio de suspensão de uso.
A versão 1 da API (v1) foi descontinuada e terá suporte até 31 de outubro de 2018. Todas as solicitações para a API v1 vão parar de funcionar após essa data. Portanto, faça upgrade para a API v2 até 31 de outubro de 2018 para evitar interrupções no acesso aos dados do YouTube Analytics pela API.
21 de fevereiro de 2018
Esta atualização contém as seguintes mudanças na API YouTube Analytics (consultas segmentadas):
- Os relatórios demográficos dos espectadores, que agregam estatísticas de visualização com base na faixa etária e no gênero dos espectadores, não são mais compatíveis com a dimensão
youtubeProduct
, que identifica o serviço do YouTube em que a atividade do usuário ocorreu.
18 de janeiro de 2018
Esta atualização contém as seguintes alterações:
-
API YouTube Reporting (relatórios em massa)
- A dimensão
operating_system
, que identifica o sistema de software do dispositivo em que as visualizações ocorreram, agora aceita o seguinte valor:25
: KaiOS
- A dimensão
-
API YouTube Analytics (consultas segmentadas)
- A dimensão
operatingSystem
é compatível com o valorKAIOS
.
- A dimensão
20 de dezembro de 2017
Esta atualização contém duas mudanças relacionadas à API YouTube Reporting:
-
Agora o servidor de API oferece suporte à compactação gzip para solicitações que baixam relatórios. A compactação gzip não é compatível com outros tipos de solicitações de API. Ativar a compactação gzip reduz a largura de banda necessária para cada resposta da API. Embora o aplicativo precise de mais tempo de CPU para descompactar as respostas da API, o benefício de consumir menos recursos de rede geralmente compensa esse custo.
Para receber uma resposta codificada em gzip, defina o cabeçalho de solicitação HTTP
Accept-Encoding
comogzip
, conforme mostrado no exemplo a seguir:Accept-Encoding: gzip
Essa funcionalidade é explicada na visão geral da API e na definição da propriedade
downloadUrl
do recursoreport
. -
A documentação das dimensões
age group
egender
foi corrigida para mostrar os valores reais que a API retorna para essas dimensões. Essa é uma correção na documentação e não reflete uma mudança na funcionalidade ou no comportamento da API. Especificamente, os seguintes valores mudaram:- Os valores da dimensão
age_group
usam letras maiúsculas, contêm sublinhados entre a palavraAGE
e os números na faixa etária e usam sublinhados em vez de hífens. Assim, valores comoage13-17
eage18-24
foram corrigidos paraAGE_13_17
eAGE_18_24
, respectivamente. - Os valores da dimensão
gender
usam letras maiúsculas. Assim, os valoresfemale
,male
egender_other
foram corrigidos paraFEMALE
,MALE
eGENDER_OTHER
.
- Os valores da dimensão
10 de agosto de 2017
Em 10 de agosto de 2016, esta documentação anunciou a descontinuação da métrica earnings
da API YouTube Analytics. Ao mesmo tempo, a API adicionou suporte a uma nova métrica, chamada estimatedRevenue
, que fornece os mesmos dados.
Como a métrica earnings
era uma métrica principal, ela teve suporte por um ano a partir da data do anúncio. Agora que esse período de um ano terminou, a métrica earnings
não está mais disponível. Como resultado, as solicitações de API que especificam a métrica earnings
agora retornam um código de resposta HTTP 400
. Se você ainda não atualizou o app para usar a métrica estimatedRevenue
em vez de earnings
, faça isso o mais rápido possível.
A documentação da API foi atualizada para remover as referências restantes à métrica earnings
.
6 de julho de 2017
Esta atualização contém as seguintes alterações:
-
API YouTube Analytics (consultas segmentadas)
-
A documentação da API foi atualizada para refletir o fato de que as respostas da API contêm dados até o último dia do período solicitado em que todas as métricas consultadas estão disponíveis.
Por exemplo, se uma solicitação especificar uma data de término de 5 de julho de 2017, e os valores de todas as métricas solicitadas estiverem disponíveis apenas até 3 de julho de 2017, essa será a última data em que os dados serão incluídos na resposta. Isso é válido mesmo que os dados de algumas das métricas solicitadas estejam disponíveis para 4 de julho de 2017.
-
Agora, a dimensão
adType
é compatível com o valorreservedBumperInstream
, que se refere a um anúncio em vídeo não pulável de até 6 segundos exibido antes de um vídeo. O formato é idêntico ao anúncioauctionBumperInstream
, mas esse tipo se refere a anúncios vendidos com base em reserva, e não em leilão.
-
-
API YouTube Reporting (relatórios em massa)
-
A dimensão
ad_type
agora é compatível com o valor20
, que se refere a anúncios bumper vendidos com base em reserva. Os anúncios bumper são anúncios em vídeo não puláveis de até seis segundos que são veiculados antes de um vídeo. O valor19
para essa dimensão também se refere a anúncios bumper vendidos em um leilão, e não com base em reserva. -
Os jobs de relatórios para os seguintes relatórios da API YouTube Reporting foram excluídos:
channel_basic_a1
channel_province_a1
channel_playback_location_a1
channel_traffic_source_a1
channel_device_os_a1
channel_subtitles_a1
channel_combined_a1
content_owner_basic_a2
content_owner_province_a1
content_owner_playback_location_a1
content_owner_traffic_source_a1
content_owner_device_os_a1
content_owner_subtitles_a1
content_owner_combined_a1
content_owner_asset_basic_a1
content_owner_asset_province_a1
content_owner_asset_playback_location_a1
content_owner_asset_traffic_source_a1
content_owner_asset_device_os_a1
content_owner_asset_combined_a1
Esses tipos de relatório foram anunciados como descontinuados em 15 de setembro de 2016, e os relatórios não foram mais gerados para esses tipos após 15 de dezembro de 2016. Os relatórios gerados anteriormente ainda estavam disponíveis por 180 dias a partir do momento em que foram gerados. Por isso, alguns relatórios ficaram acessíveis até 15 de junho de 2017. No entanto, como os relatórios não estão mais disponíveis, os jobs associados a eles também não são mais necessários.
-
24 de maio de 2017
Todos os jobs de relatório para os seguintes relatórios da API YouTube Reporting foram excluídos:
content_owner_ad_performance_a1
content_owner_asset_estimated_earnings_a1
content_owner_estimated_earnings_a1
Esses tipos de relatório foram anunciados como descontinuados em 22 de junho de 2016, e os relatórios não foram mais gerados para esses tipos após 22 de setembro de 2016. Os relatórios gerados anteriormente ainda estavam disponíveis por 180 dias a partir do momento em que foram gerados. Por isso, alguns relatórios ficaram acessíveis até 22 de março de 2017. No entanto, como os relatórios não estão mais disponíveis, os jobs associados a eles também não são mais necessários.
22 de maio de 2017
Esta atualização contém as seguintes alterações:
-
API YouTube Reporting (relatórios em massa)
- A dimensão
sharing_service
, que identifica o serviço usado para compartilhar vídeos, agora aceita os seguintes valores:85
: YouTube Music86
: YouTube Gaming87
: YouTube Kids88
: YouTube TV
Além disso, o nome usado para identificar o valor
52
foi atualizado na documentação para Kakao (Kakao Talk), diferenciando-o mais claramente do valor73
(Kakao Story). Essa mudança não reflete nenhuma alteração no comportamento da API ou na classificação dos vídeos compartilhados com esses serviços.
- A dimensão
-
API YouTube Analytics (consultas segmentadas)
- A dimensão
sharingService
agora aceita os seguintes valores:YOUTUBE_GAMING
YOUTUBE_KIDS
YOUTUBE_MUSIC
YOUTUBE_TV
- A dimensão
28 de março de 2017
Os proprietários de canais que podem acessar dados de receita pelo YouTube Analytics no Estúdio de Criação agora também podem fazer isso pela API YouTube Analytics:
-
A API é compatível com as seguintes métricas relacionadas à receita:
adImpressions
cpm
estimatedAdRevenue
estimatedRedPartnerRevenue
estimatedRevenue
grossRevenue
monetizedPlaybacks
playbackBasedCpm
Essas métricas são compatíveis com os seguintes relatórios:
-
Os proprietários de canais também podem extrair um relatório de performance de anúncios, que oferece suporte à dimensão
adType
e à dimensão opcionalday
. -
O guia de exemplos de solicitações da API YouTube Analytics agora inclui uma seção para relatórios de receita do canal.
17 de março de 2017
Esta atualização contém as seguintes alterações:
-
A API YouTube Analytics oferece suporte às métricas
redViews
eestimatedRedMinutesWatched
, que estão relacionadas às visualizações do YouTube Red. Na verdade, a API já é compatível com essas métricas há algum tempo, e a API YouTube Reporting já oferece suporte a ambas, conforme anunciado em 15 de setembro de 2016.- A métrica
redViews
identifica o número de vezes que um vídeo foi assistido por membros do YouTube Red. - A métrica
estimatedRedMinutesWatched
identifica o número de minutos que os membros do YouTube Red assistiram um vídeo.
A documentação de relatórios do canal e relatórios do proprietário do conteúdo foi atualizada para mostrar quais relatórios são compatíveis com as duas novas métricas. Elas são compatíveis com todos os relatórios que já aceitavam as métricas
views
eestimatedMinutesWatched
. - A métrica
3 de março de 2017
Esta atualização contém as seguintes alterações:
-
API YouTube Reporting (relatórios em massa)
-
A definição da dimensão
date
foi corrigida para informar que o valor da dimensão se refere ao período que começa às 0h (horário do Pacífico) e termina às 23h59 (horário do Pacífico) do dia, mês e ano especificados. Dependendo da época do ano, o horário do Pacífico é UTC-7 ou UTC-8.Embora as datas normalmente representem um período de 24 horas, as datas em que os relógios são adiantados representam um período de 23 horas, e as datas em que os relógios são atrasados representam um período de 25 horas. Antes, a documentação afirmava que cada data representava um período único de 24 horas e que o horário do Pacífico era sempre UTC-8.
Essa correção não representa uma mudança no comportamento real da API.
- A dimensão
operating_system
, que identifica o sistema de software do dispositivo em que as visualizações ocorreram, agora aceita os seguintes valores:22
: Tizen23
: Firefox24
: RealMedia
-
Todos os jobs de relatório do tipo
content_owner_basic_a1
foram excluídos. Esse tipo de relatório foi totalmente descontinuado em 19 de agosto de 2016, mas os relatórioscontent_owner_basic_a1
gerados anteriormente ainda estavam disponíveis por 180 dias a partir do momento em que foram gerados. Por isso, alguns relatórios ficaram acessíveis até 19 de fevereiro de 2017. No entanto, como os relatórios não estão mais disponíveis, os jobs associados a eles também não são mais necessários.
-
-
API YouTube Analytics (consultas segmentadas)
-
A descrição das dimensões relacionadas a
time periods
foi corrigida para informar que o valor da dimensão se refere ao período que começa às 0h (horário do Pacífico) e termina às 23h59 (horário do Pacífico) do dia, mês e ano especificados. Dependendo da época do ano, o horário do Pacífico é UTC-7 ou UTC-8.Embora as datas normalmente representem um período de 24 horas, as datas em que os relógios são adiantados representam um período de 23 horas, e as datas em que os relógios são atrasados representam um período de 25 horas. Antes, a documentação afirmava que o horário do Pacífico era UTC-8 e não mencionava a possibilidade de um dia não representar um período de 24 horas.
Essa correção não representa uma mudança no comportamento real da API.
-
A documentação de relatórios de canais foi atualizada para informar que, no momento, eles não contêm métricas de receita ou performance de anúncios. Por isso, o escopo
https://www.googleapis.com/auth/yt-analytics-monetary.readonly
não concede acesso a dados monetários nos relatórios do canal. - A dimensão
operatingSystem
é compatível com três novos valores de dimensão:FIREFOX
REALMEDIA
TIZEN
-
8 de fevereiro de 2017
A API YouTube Analytics agora é compatível com o parâmetro opcional include-historical-channel-data
. Esse parâmetro só é relevante ao recuperar relatórios de proprietário do conteúdo.
O parâmetro permite que um proprietário de conteúdo indique que uma resposta da API deve incluir o tempo de exibição e os dados de visualização dos canais do período anterior à vinculação deles ao proprietário. O valor padrão do parâmetro é false
. Isso significa que, por padrão, a resposta da API inclui apenas dados de tempo de exibição e visualização do período em que os canais foram vinculados ao proprietário do conteúdo.
Essas regras também se aplicam se a solicitação de API recuperar dados de vários canais:
- Se o valor do parâmetro for
false
, os dados de tempo de exibição e visualizações retornados para um determinado canal serão baseados na data em que ele foi vinculado ao proprietário do conteúdo.
É importante lembrar que diferentes canais podem ter sido vinculados a um proprietário de conteúdo em datas diferentes. Se a solicitação de API estiver recuperando dados de vários canais e o valor do parâmetro forfalse
, a resposta da API vai conter dados de tempo de exibição e visualização com base na data de vinculação de cada canal. - Se o valor do parâmetro for
true
, a resposta vai retornar dados de tempo de exibição e visualização de todos os canais com base nas datas de início e término especificadas na solicitação da API.
15 de dezembro de 2016
Os seguintes relatórios da API YouTube Reporting não têm mais suporte e foram removidos da documentação. Uma versão mais recente de cada relatório está disponível. O comunicado sobre a descontinuação desses relatórios foi feito em 15 de setembro de 2016.
-
Denúncias de canais
channel_basic_a1
: substituído pelo relatóriochannel_basic_a2
.channel_province_a1
: substituído pelo relatóriochannel_province_a2
.channel_playback_location_a1
: substituído pelo relatóriochannel_playback_location_a2
.channel_traffic_source_a1
: substituído pelo relatóriochannel_traffic_source_a2
.channel_device_os_a1
: substituído pelo relatóriochannel_device_os_a2
.channel_subtitles_a1
: substituído pelo relatóriochannel_subtitles_a2
.channel_combined_a1
: substituído pelo relatóriochannel_combined_a2
.
-
Relatórios de proprietários do conteúdo
content_owner_basic_a2
: substituído pelo relatóriocontent_owner_basic_a3
.content_owner_province_a1
: substituído pelo relatóriocontent_owner_province_a2
.content_owner_playback_location_a1
: substituído pelo relatóriocontent_owner_playback_location_a2
.content_owner_traffic_source_a1
: substituído pelo relatóriocontent_owner_traffic_source_a2
.content_owner_device_os_a1
: substituído pelo relatóriocontent_owner_device_os_a2
.content_owner_subtitles_a1
: substituído pelo relatóriocontent_owner_subtitles_a2
.content_owner_combined_a1
: substituído pelo relatóriocontent_owner_combined_a2
.content_owner_asset_basic_a1
: substituído pelo relatóriocontent_owner_asset_basic_a2
.content_owner_asset_province_a1
: substituído pelo relatóriocontent_owner_asset_province_a2
.content_owner_asset_playback_location_a1
: substituído pelo relatóriocontent_owner_asset_playback_location_a2
.content_owner_asset_traffic_source_a1
: substituído pelo relatóriocontent_owner_asset_traffic_source_a2
.content_owner_asset_device_os_a1
: substituído pelo relatóriocontent_owner_asset_device_os_a2
.content_owner_asset_combined_a1
: substituído pelo relatóriocontent_owner_asset_combined_a2
.
A lista de tipos de relatórios atuais na documentação de referência da API também foi atualizada.
11 de novembro de 2016
Esta atualização contém as seguintes alterações:
A API YouTube Reporting oferece suporte a três novos relatórios de tela final, além de novas dimensões e métricas para esses relatórios. Os relatórios fornecem estatísticas de impressão e taxa de cliques para as telas finais que aparecem depois que um vídeo para de ser reproduzido.
-
Relatórios de telas finais
- O relatório de tela final para vídeos do canal contém estatísticas de todos os vídeos de um canal.
- O relatório de tela final para vídeos de proprietários de conteúdo contém estatísticas de vídeos em qualquer um dos canais de um proprietário de conteúdo.
- O relatório de tela final para recursos do proprietário do conteúdo contém estatísticas dos recursos associados aos vídeos após os quais as telas finais são exibidas.
-
Dimensões da tela final
end_screen_element_type
: o tipo de elemento da tela final associado às estatísticas.end_screen_element_id
: o ID que o YouTube usa para identificar exclusivamente o elemento da tela final.
Métricas da tela final
Observação:os dados das métricas de tela final estão disponíveis desde 1º de maio de 2016.
end_screen_element_impressions
: o número total de impressões de elementos da tela final. Uma impressão é registrada para cada elemento da tela final que aparece.end_screen_element_clicks
: o número de vezes que os elementos da tela final foram clicados.end_screen_element_click_rate
: a taxa de cliques dos elementos da tela final.
-
Os seguintes relatórios não são mais compatíveis e foram removidos da documentação. Uma versão mais recente de cada relatório está disponível. O comunicado de descontinuação desses relatórios foi feito em 22 de junho de 2016.
content_owner_ad_performance_a1
: substituído pelo relatóriocontent_owner_ad_rates_a1
.content_owner_estimated_earnings_a1
: substituído pelo relatóriocontent_owner_estimated_revenue_a1
.content_owner_asset_estimated_earnings_a1
: substituído pelo relatóriocontent_owner_asset_estimated_revenue_a1
.
A Central de Ajuda do YouTube contém informações mais detalhadas sobre como adicionar telas finais aos seus vídeos.
8 de novembro de 2016
Esta atualização contém as seguintes mudanças na API YouTube Analytics:
-
As métricas na lista a seguir foram totalmente descontinuadas e não são mais compatíveis. Conforme anunciado em 10 de agosto de 2016, já há suporte para novas métricas referentes aos mesmos dados. A tabela abaixo mostra o nome da métrica descontinuada e o novo nome:
Métrica descontinuada Nova métrica adEarnings
estimatedAdRevenue
impressionBasedCpm
cpm
impressions
adImpressions
redPartnerRevenue
estimatedRedPartnerRevenue
27 de outubro de 2016
Agora o YouTube gera automaticamente um conjunto de relatórios de receita de publicidade gerenciados pelo sistema para proprietários de conteúdo que têm acesso aos relatórios correspondentes na seção Relatórios do YouTube Studio. Os novos relatórios de API gerenciados pelo sistema foram criados para oferecer acesso programático a dados que também estão disponíveis nos relatórios do YouTube Studio para download manual.
A visão geral dos relatórios gerenciados pelo sistema oferece uma breve visão geral dos novos relatórios e explica o processo para recuperá-los pela API. Esse processo é um pouco diferente da recuperação de relatórios em massa do YouTube Analytics, já que os parceiros não precisam programar jobs para gerar os relatórios.
A propriedade id
do recurso reportType
foi atualizada para incluir uma lista dos relatórios gerenciados pelo sistema que podem ser acessados pela API:
- Receita mensal de publicidade por vídeo no mundo todo
- Receita de publicidade diária por vídeo e país
- Receita mensal de publicidade por recurso no mundo todo
- Receita diária de anúncios por recurso e país
- Reivindicações (este relatório não contém dados de receita)
27 de setembro de 2016
Observação:este é um anúncio de suspensão de uso.
A métrica uniques
da API YouTube Analytics foi descontinuada. Essa não é uma métrica principal e será aceita até 31 de outubro de 2016.
15 de setembro de 2016
Esta atualização contém as seguintes mudanças na API YouTube Reporting:
-
A API oferece suporte a duas novas métricas relacionadas à visualização do YouTube Red:
red_views
: o número de vezes que um vídeo foi assistido por assinantes do YouTube Red.red_watch_time_minutes
: o número de minutos que os assinantes do YouTube Red assistiram um vídeo.
-
A API oferece suporte a novas versões de 20 relatórios. Todas as novas versões são compatíveis com as novas métricas
red_views
ered_watch_time_minutes
.Para cada relatório, o número no novo ID de tipo de relatório é um número maior do que no ID de tipo de relatório antigo. As versões antigas desses relatórios foram descontinuadas, conforme descrito mais adiante neste histórico de revisões. Por exemplo, o relatório
channel_basic_a1
foi descontinuado e substituído pelo relatóriochannel_basic_a2
.As listas a seguir identificam os novos IDs de tipo de relatório:
Relatórios de vídeos do canal
Relatórios de vídeo do proprietário do conteúdo
Relatórios de recursos do proprietário do conteúdo
-
Observação:este é um anúncio de suspensão de uso.
Se você já tiver jobs para criar qualquer uma das versões mais antigas dos relatórios listados acima, crie novos jobs para os relatórios renomeados. Juntamente com o lançamento das novas versões de relatórios, as seguintes versões foram descontinuadas:
channel_basic_a1
channel_province_a1
channel_playback_location_a1
channel_traffic_source_a1
channel_device_os_a1
channel_subtitles_a1
channel_combined_a1
content_owner_basic_a2
content_owner_province_a1
content_owner_playback_location_a1
content_owner_traffic_source_a1
content_owner_device_os_a1
content_owner_subtitles_a1
content_owner_combined_a1
content_owner_asset_basic_a1
content_owner_asset_province_a1
content_owner_asset_playback_location_a1
content_owner_asset_traffic_source_a1
content_owner_asset_device_os_a1
content_owner_asset_combined_a1
Se você tiver jobs para algum desses relatórios, não espere que o YouTube gere novos relatórios para esses jobs após 15 de dezembro de 2016. Os relatórios gerados ainda vão ficar disponíveis por 180 dias a partir do momento em que foram gerados.
19 de agosto de 2016
Esta atualização contém a seguinte mudança na API YouTube Reporting:
-
O relatório
content_owner_basic_a1
foi totalmente descontinuado e removido da documentação. O YouTube não vai mais gerar novos relatórios desse tipo, mas os que já foram gerados vão ficar disponíveis por 180 dias a partir da data de criação.O relatório
content_owner_basic_a1
foi substituído pelo relatóriocontent_owner_basic_a2
, conforme explicado na entrada do histórico de revisões de 19 de maio de 2016.
11 de agosto de 2016
Esta atualização contém as seguintes alterações:
-
Os Termos de Serviço dos serviços de API do YouTube recém-publicados ("os Termos atualizados"), discutidos em detalhes no Blog de engenharia e desenvolvedores do YouTube, oferecem um conjunto abrangente de atualizações aos Termos de Serviço atuais. Além dos Termos atualizados, que vão entrar em vigor em 10 de fevereiro de 2017, esta atualização inclui vários documentos de apoio para ajudar a explicar as políticas que os desenvolvedores precisam seguir.
O conjunto completo de novos documentos está descrito no histórico de revisões dos Termos atualizados. Além disso, as mudanças futuras nos Termos atualizados ou nos documentos de suporte também serão explicadas nesse histórico de revisões. Você pode se inscrever em um feed RSS que lista as mudanças no histórico de revisões usando um link no documento.
10 de agosto de 2016
Essa atualização inclui as seguintes alterações:
-
API YouTube Analytics (consultas segmentadas)
-
Observação:este é um anúncio de suspensão de uso.
As métricas na tabela a seguir estão sendo descontinuadas. Ao mesmo tempo, novas métricas referentes aos mesmos dados estão sendo introduzidas. Isso significa que as métricas antigas estão sendo renomeadas, mas a API YouTube Analytics vai aceitar os dois nomes até as datas de descontinuação listadas na tabela.
Nome antigo da métrica Nome da nova métrica Data de suporte earnings
estimatedRevenue
10 de agosto de 2017 adEarnings
estimatedAdRevenue
4 de novembro de 2016 redPartnerRevenue
estimatedRedPartnerRevenue
4 de novembro de 2016 impressionBasedCpm
cpm
4 de novembro de 2016 impressions
adImpressions
4 de novembro de 2016 A métrica
earnings
era principal e, por isso, vai ter suporte por um ano a partir da data deste anúncio. As outras métricas, que não eram principais, serão compatíveis por três meses, até 4 de novembro de 2016.Por exemplo, até 4 de novembro de 2016, uma solicitação de API podia especificar a métrica
impressionBasedCpm
, a métricacpm
ou ambas. No entanto, depois dessa data, apenas a métricacpm
será aceita. - A dimensão
insightTrafficSourceType
aceita dois novos valores:CAMPAIGN_CARD
: essa origem de tráfego só é compatível com relatórios de proprietários de conteúdo. Isso indica que as visualizações vieram de vídeos reivindicados e enviados por usuários que o proprietário do conteúdo usou para promover o conteúdo assistido.END_SCREEN
: os dados se referem a visualizações originadas da tela final de outro vídeo.
Para as duas novas origens de tráfego, também é possível extrair um relatório
traffic source detail
. Em ambos os casos, a dimensãoinsightTrafficSourceDetail
identifica o vídeo de onde o espectador foi encaminhado. -
Agora, a dimensão
adType
é compatível com o valorauctionBumperInstream
, que se refere a um anúncio em vídeo não pulável de até 6 segundos exibido antes de um vídeo.
-
-
API YouTube Reporting (relatórios em massa)
- A dimensão
traffic_source_type
agora aceita os seguintes valores:19
: essa origem de tráfego só é compatível com relatórios de proprietários de conteúdo. Isso indica que as visualizações vieram de vídeos reivindicados e enviados por usuários que o proprietário do conteúdo usou para promover o conteúdo assistido.20
: os dados se referem a visualizações originadas da tela final de outro vídeo.
Para as duas novas origens de tráfego, a dimensão
traffic_source_detail
identifica o vídeo de onde o espectador foi encaminhado. -
A lista de métricas principais da API foi corrigida para incluir
estimated_partner_revenue
como uma métrica principal e removerearnings
dessa lista. A métricaearnings
nunca foi compatível com a API YouTube Reporting. -
A dimensão
ad_type
agora é compatível com o valor19
, que se refere aos anúncios bumper, que são anúncios em vídeo não puláveis de até 6 segundos exibidos antes de um vídeo.
- A dimensão
18 de julho de 2016
Essa atualização inclui as seguintes alterações:
-
API YouTube Analytics (consultas segmentadas)
- As listas de métricas compatíveis para os seguintes relatórios de canais foram atualizadas para incluir métricas de card. O suporte para métricas de card nesses relatórios foi adicionado em 28 de junho de 2016, e a entrada do histórico de revisões dessa data explica a mudança em mais detalhes. Os relatórios são:
- Atividade básica do usuário nos estados dos EUA
- Atividade do usuário em estados nos EUA em períodos específicos
- Atividade do usuário por província
- Atividade do usuário por status de inscrição
- Atividade do usuário por status de inscrição para províncias
- Vídeos mais acessados por estado
- Principais vídeos para espectadores inscritos ou não inscritos
-
As listas de filtros foram corrigidas nos relatórios de retenção de público-alvo do canal e nos relatórios de retenção de público-alvo do proprietário do conteúdo para refletir que o filtro
video
é obrigatório e o filtrogroup
não é compatível.Antes, a documentação dos dois relatórios afirmava incorretamente que o relatório podia ser recuperado usando um desses dois filtros ou nenhum deles.
- As listas de métricas compatíveis para os seguintes relatórios de canais foram atualizadas para incluir métricas de card. O suporte para métricas de card nesses relatórios foi adicionado em 28 de junho de 2016, e a entrada do histórico de revisões dessa data explica a mudança em mais detalhes. Os relatórios são:
-
API YouTube Reporting (relatórios em massa)
- Na visão geral da API, a seção que explica como recuperar o URL de download de um relatório foi corrigida para informar que o YouTube gera relatórios para download mesmo nos dias em que não há dados disponíveis. Esses relatórios têm uma linha de cabeçalho, mas não contêm outros dados. Essas informações já tinham sido atualizadas na seção Características do relatório do mesmo documento em 12 de abril de 2016.
- A lista de dimensões no relatório
content_owner_asset_cards_a1
foi corrigida para refletir que o relatório usa a dimensãocard_id
. Antes, a documentação listava incorretamente o nome da dimensão comocard_title
.
28 de junho de 2016
A documentação da API YouTube Analytics foi atualizada para refletir o suporte às métricas de cards em vários relatórios de canal e proprietário do conteúdo. As novas métricas compatíveis são:
As métricas são compatíveis com os seguintes tipos de relatórios:
- Estatísticas básicas(canais, proprietários de conteúdo)
- Com base no tempo(canais, proprietários de conteúdo)
- Localização do usuário (canais, proprietários de conteúdo)
- Atividade do usuário por status de inscrição (canais, proprietários de conteúdo)
- Vídeos em alta (canais, proprietários de conteúdo)
22 de junho de 2016
Esta atualização contém as seguintes mudanças na API YouTube Reporting. A primeira mudança se refere à API em geral, e as demais afetam apenas os relatórios de proprietários de conteúdo:
-
A seção Características do relatório da visão geral da API foi atualizada para esclarecer que os relatórios ficam disponíveis pela API por 180 dias a partir do momento em que são gerados.
Antes, a documentação afirmava que os relatórios ficavam disponíveis por um período de até 180 dias antes da data de envio da solicitação da API. Embora também seja tecnicamente verdadeiro, o texto original era, no mínimo, bastante confuso.
-
A API oferece suporte a novas versões de três relatórios. Dois desses relatórios também contêm métricas novas e renomeadas:
-
O relatório
content_owner_ad_rates_a1
é a nova versão do relatóriocontent_owner_ad_performance_a1
. O relatório renomeado é idêntico à versão anterior. -
Dois relatórios que têm novas versões foram renomeados:
- A nova versão do relatório
content_owner_estimated_earnings_a1
se chamacontent_owner_estimated_revenue_a1
. - A nova versão do relatório
content_owner_asset_estimated_earnings_a1
se chamacontent_owner_asset_estimated_revenue_a1
.
Os dois relatórios renomeados recentemente diferem dos anteriores das seguintes maneiras:
- Eles adicionam a nova métrica
estimated_partner_red_revenue
, que estima os ganhos totais das assinaturas do YouTube Premium. - Ela adiciona a nova métrica
estimated_partner_transaction_revenue
, que estima a receita de transações, como conteúdo pago e apoio dos fãs, menos os reembolsos cobrados de parceiros. - Eles renomeiam a métrica
estimated_partner_ad_sense_revenue
comoestimated_partner_ad_auction_revenue
. - Eles renomeiam a métrica
estimated_partner_double_click_revenue
comoestimated_partner_ad_reserved_revenue
.
- A nova versão do relatório
Se você já tiver jobs para criar qualquer uma das versões mais antigas desses relatórios, crie novos jobs para os relatórios renomeados. Junto com o lançamento das novas versões de relatórios, os relatórios
content_owner_ad_performance_a1
,content_owner_estimated_earnings_a1
econtent_owner_asset_estimated_earnings_a1
foram descontinuados.Se você tiver jobs para algum desses relatórios, não espere que o YouTube gere novos relatórios para esses jobs após 22 de setembro de 2016. Os relatórios gerados ainda vão ficar disponíveis por 180 dias a partir do momento em que foram gerados.
-
-
A definição da propriedade
id
do recursoreportType
foi atualizada para refletir o conjunto atual de relatórios disponíveis. -
Os nomes de duas métricas foram corrigidos na documentação para corresponder aos nomes que aparecem nos relatórios. Esta é apenas uma correção na documentação e não reflete uma mudança no conteúdo real do relatório:
- O nome da métrica
estimated_partner_adsense_revenue
foi atualizado paraestimated_partner_ad_sense_revenue
. No entanto, essa métrica só aparece em dois relatórios que estão sendo descontinuados com essa atualização. Conforme descrito acima, essa métrica foi renomeada comoestimated_partner_ad_auction_revenue
em versões mais recentes desses relatórios. - O nome da métrica
estimated_partner_doubleclick_revenue
foi atualizado paraestimated_partner_double_click_revenue
. Vale lembrar que essa métrica só aparece em dois relatórios que serão descontinuados com essa atualização. Conforme descrito acima, essa métrica foi renomeada comoestimated_partner_ad_reserved_revenue
em versões mais recentes desses relatórios.
- O nome da métrica
-
A documentação de dimensões da API Reporting foi atualizada para não listar mais as propriedades
elapsed_video_time_percentage
eaudience_retention_type
. No momento, essas dimensões não são compatíveis com nenhum relatório disponível na API.
19 de maio de 2016
Esta atualização contém as seguintes mudanças na API YouTube Reporting:
-
A API oferece suporte a uma nova versão do Relatório de atividade do usuário para proprietários de conteúdo. O ID do tipo de relatório é
content_owner_basic_a2
. Ao contrário da versão anterior do relatório,content_owner_basic_a1
, a nova versão é compatível com as métricaslikes
edislikes
.Se você já tiver um job para criar o relatório
content_owner_basic_a1
, ainda será necessário criar um novo para o relatóriocontent_owner_basic_a2
. O YouTube não está migrando automaticamente os proprietários de conteúdo para a nova versão do relatório nem criando um job para gerar essa versão. Em algumas implementações, a aparência de um job novo e inesperado pode ser uma mudança incompatível.Junto com o lançamento do novo relatório, o relatório
content_owner_basic_a1
foi descontinuado. Se você tiver um job para esse relatório, não espere que o YouTube gere novos relatórios para esse job após 19 de agosto de 2016. Os relatórios gerados ainda vão ficar disponíveis por 180 dias a partir do momento em que foram gerados. -
Os recursos
reportType
,job
ereport
agora têm uma nova propriedade que identifica se o recurso associado representa um tipo de relatório descontinuado:-
A propriedade
deprecateTime
do recursoreportType
especifica a data e a hora em que o tipo de relatório será descontinuado. Essa propriedade só tem um valor para relatórios que foram anunciados como descontinuados, e o valor representa a data em que o YouTube vai parar de gerar relatórios desse tipo.Depois que um tipo de relatório é anunciado como descontinuado, o YouTube gera relatórios desse tipo por mais três meses. Por exemplo, esta atualização de 19 de maio de 2016 anuncia a descontinuação do relatório
content_owner_basic_a1
. Assim, odeprecateTime
para esse tipo de relatório especifica um horário em 19 de agosto de 2016, após o qual o YouTube vai parar de gerar relatórios desse tipo. -
A propriedade
expireTime
do recursojob
especifica a data e a hora em que o job expirou ou vai expirar. Essa propriedade tem um valor se o tipo de relatório associado ao trabalho foi descontinuado ou se os relatórios gerados para o trabalho não foram baixados por um período prolongado. A data marca o momento em que o YouTube não gera mais relatórios para o job. -
A propriedade
jobExpireTime
do recursoreport
especifica a data e a hora em que o job associado ao relatório expirou ou vai expirar. Essa propriedade contém o mesmo valor da propriedadeexpireTime
no recursojob
, conforme descrito no item anterior desta lista.
-
-
O método
jobs.create
agora retorna um código de resposta HTTP400
(Bad Request
) se você tentar criar um job para um relatório descontinuado. Além disso, a documentação do método agora lista vários outros motivos que causam a falha de uma solicitação de API.
12 de abril de 2016
Esta atualização contém as seguintes mudanças, que afetam apenas a API YouTube Reporting:
-
Agora, o YouTube gera dados que abrangem o período de 180 dias antes da primeira programação de um job de geração de relatórios. Antes, a API Reporting não fornecia dados históricos. Essa mudança afeta todos os jobs, incluindo aqueles criados antes deste anúncio.
Os relatórios históricos são postados assim que ficam disponíveis, mas leva aproximadamente um mês para que todos os dados históricos de um job sejam postados. Assim, um mês depois de programar um trabalho de geração de relatórios, você terá acesso a cerca de sete meses de dados. Todos os dados históricos de jobs criados antes desse anúncio precisam ser postados em até um mês após a publicação.
Os dados históricos só estão disponíveis a partir de 1º de julho de 2015. Como resultado, os jobs criados antes de 28 de dezembro de 2015 terão menos de 180 dias de dados históricos.
Todas essas mudanças são explicadas na nova seção Dados históricos da visão geral da API Reporting.
-
A seção Características do relatório da visão geral da API YouTube Reporting foi atualizada com as seguintes mudanças:
-
Agora, a documentação afirma que os relatórios ficam disponíveis por um período de 180 dias após a geração e, portanto, podem ser baixados pelos clientes da API. Antes, a documentação afirmava que os relatórios estavam disponíveis por um período de até seis meses antes da data em que a solicitação da API era enviada.
-
A documentação foi atualizada para refletir o fato de que a API agora gera relatórios para download dos dias em que não havia dados disponíveis. Esses relatórios vão conter linhas de cabeçalho, mas não terão outros dados.
-
-
Em breve, a API YouTube Reporting vai oferecer suporte a um conjunto de relatórios gerenciados pelo sistema e gerados automaticamente que contêm dados de receita de publicidade ou de receita de assinaturas do YouTube Red. Os relatórios vão estar disponíveis para os proprietários de conteúdo que já podem acessar os relatórios de receita para download manual no YouTube Studio. Assim, a nova funcionalidade da API vai oferecer acesso programático a esses dados.
As seguintes mudanças na API estão sendo anunciadas agora em preparação para o lançamento dos relatórios gerenciados pelo sistema:
-
A nova propriedade
systemManaged
do recursojob
indica se o recurso descreve um job que gera relatórios gerenciados pelo sistema. O YouTube gera automaticamente relatórios gerenciados pelo sistema para proprietários de conteúdo, e eles não podem modificar nem excluir jobs que criam esses relatórios. -
O novo parâmetro
includeSystemManaged
do métodojobs.list
indica se a resposta da API deve incluir jobs para relatórios gerenciados pelo sistema. O valor padrão do parâmetro éfalse
. -
O novo parâmetro
startTimeAtOrAfter
do métodojobs.reports.list
indica que a resposta da API só deve conter relatórios se os dados mais antigos estiverem na data especificada ou depois dela. Da mesma forma, o parâmetrostartTimeBefore
indica que a resposta da API só deve conter relatórios se os dados mais antigos estiverem antes da data especificada.Ao contrário do parâmetro
createdAfter
do método, que se refere ao momento em que o relatório foi criado, os novos parâmetros se referem aos dados no relatório. -
A nova propriedade
systemManaged
do recursoreportType
indica se o recurso descreve um relatório gerenciado pelo sistema. -
O novo parâmetro
includeSystemManaged
do métodoreportTypes.list
indica se a resposta da API deve incluir relatórios gerenciados pelo sistema. O valor padrão do parâmetro éfalse
.
-
28 de março de 2016
As APIs YouTube Reporting e YouTube Analytics agora retornam estatísticas de visualização para vários serviços de compartilhamento adicionais.
- Na API YouTube Reporting, a dimensão
sharing_service
aceita estes novos valores:82
: caixa de diálogo de atividade do sistema iOS83
: Google Inbox84
: Android Messenger
- Na API YouTube Analytics, a dimensão
sharingService
é compatível com estes novos valores:ANDROID_MESSENGER
: Android MessengerINBOX
: Google InboxIOS_SYSTEM_ACTIVITY_DIALOG
: caixa de diálogo de atividade do sistema iOS
16 de março de 2016
Esta atualização contém as seguintes mudanças, que afetam a API YouTube Reporting e a API YouTube Analytics:
API YouTube Reporting
- A dimensão
playback_location_type
aceita dois novos valores:7
: os dados se referem a visualizações que ocorreram na página inicial do YouTube ou na tela inicial, no feed de inscrições do usuário ou em outro recurso de navegação do YouTube.8
: os dados se referem a visualizações que ocorreram diretamente na página de resultados da pesquisa do YouTube.
- Agora, a dimensão
traffic_source_type
aceita18
como um valor de dimensão. Esse valor indica que as visualizações de vídeo vieram de uma página que lista todos os vídeos em uma playlist. Essa origem é diferente do tipo14
, que indica que as visualizações ocorreram enquanto o vídeo era reproduzido como parte de uma playlist.
API YouTube Analytics
- A dimensão
insightPlaybackLocationType
aceita dois novos valores:BROWSE
: os dados se referem a visualizações que ocorreram na página inicial do YouTube ou na tela inicial, no feed de inscrições do usuário ou em outro recurso de navegação do YouTube.SEARCH
: os dados se referem a visualizações que ocorreram diretamente na página de resultados da pesquisa do YouTube.
- Agora, a dimensão
insightTrafficSourceType
aceitaYT_PLAYLIST_PAGE
como um valor de dimensão. Esse valor indica que as visualizações de vídeo vieram de uma página que lista todos os vídeos em uma playlist. Essa origem é diferente do tipoPLAYLIST
, que indica que as visualizações ocorreram enquanto o vídeo era reproduzido como parte de uma playlist.
8 de fevereiro de 2016
A lista de métricas compatíveis com a API YouTube Analytics foi atualizada para que as métricas de card não sejam mais listadas como métricas compatíveis com essa API. Nenhum dos relatórios dessa API foi documentado como compatível com alguma das métricas do card.
Você ainda pode recuperar métricas de cards usando a API YouTube Reporting, que oferece suporte a essas métricas para vários relatórios de canal e proprietário do conteúdo.
6 de janeiro de 2016
Agora, a API YouTube Reporting e a API YouTube Analytics identificam especificamente as visualizações que ocorrem em um dispositivo Chromecast.
- Na API YouTube Reporting, a dimensão
operating_system
usa o valor21
para identificar visualizações feitas pelo Chromecast. - Na API YouTube Analytics, a dimensão
operatingSystem
usa o valorCHROMECAST
para identificar visualizações que ocorrem pelo Chromecast.
21 de dezembro de 2015
Na documentação, os nomes das métricas annotation_clickable_impressions
e annotation_closable_impressions
foram atualizados para corresponder aos nomes retornados nos relatórios. Antes, os nomes eram documentados como clickable_annotation_impressions
e closable_annotation_impressions
.
18 de dezembro de 2015
As leis da União Europeia (UE) exigem que determinadas declarações sejam fornecidas e consentimentos sejam obtidos dos usuários finais na UE. Portanto, para usuários finais na União Europeia, você precisa obedecer à Política de consentimento de usuários da União Europeia. Adicionamos um aviso sobre esse requisito nos Termos de Serviço da API do YouTube.
15 de dezembro de 2015
Esta atualização contém as seguintes mudanças, que afetam a API YouTube Analytics:
-
A API YouTube Analytics agora oferece suporte a três novas dimensões de detalhes da reprodução, que podem ser usadas em vários relatórios de canais e proprietários de conteúdo:
liveOrOnDemand
: indica se os dados no relatório descrevem a atividade do usuário que ocorreu durante uma transmissão ao vivo.subscribedStatus
: indica se as métricas de atividade do usuário nos dados estão associadas a espectadores inscritos no canal do vídeo ou da playlist.youtubeProduct
: identifica a propriedade do YouTube em que a atividade do usuário ocorreu. Os valores possíveis incluem o site principal do YouTube (ou app YouTube), o YouTube Gaming e o YouTube Kids.
A documentação foi atualizada para identificar novos relatórios detalhados de reprodução disponíveis para canais e proprietários de conteúdo. Além disso, muitos outros relatórios foram atualizados para informar que uma ou mais dessas dimensões podem ser usadas como dimensões e/ou filtros nesses relatórios.
-
O formato das tabelas que explicam os relatórios mudou para facilitar a identificação de combinações válidas de dimensões, métricas e filtros que podem ser usados para recuperar cada relatório. A tabela abaixo, que explica o relatório "Tipo de dispositivo" para canais, mostra o novo formato:
Índice Dimensões: Obrigatório deviceType Use 0 ou mais day, liveOrOnDemand, subscribedStatus, youtubeProduct Métricas: Use 1 ou mais views, estimatedMinutesWatched Filtros: Use 0 ou 1 country, province, continent, subContinent Use 0 ou 1 vídeo, grupo Use 0 ou mais operatingSystem, liveOrOnDemand, subscribedStatus, youtubeProduct A terminologia que descreve os campos obrigatórios e opcionais é explicada na documentação dos relatórios de canal e proprietário do conteúdo.
-
Agora, a API YouTube Analytics remove automaticamente das entidades os filtros que não podem ser usados para recuperar dados do usuário da API e que aceitam vários valores (
video
,playlist
echannel
). Antes, o servidor da API retornava um erro se o usuário não conseguisse acessar os dados de pelo menos um dos itens especificados.Por exemplo, suponha que um usuário envie uma solicitação de API em que o filtro
video
liste 20 IDs de vídeo. O usuário é proprietário de 18 vídeos. No entanto, um ID identifica um vídeo de outro canal, e outro ID identifica um vídeo que foi excluído e, portanto, não existe mais. Nesse caso, em vez de retornar um erro, o servidor da API descarta os dois vídeos a que o usuário não tem acesso, e a resposta da API contém dados dos 18 vídeos que o usuário da API possui. -
Se você solicitar dados de um
group
vazio do YouTube Analytics, a API vai retornar um conjunto de dados vazio em vez de um erro. -
O método
groupItems.insert
da API YouTube Analytics agora retorna um erro não autorizado (código de resposta HTTP403
) se você tentar adicionar uma entidade a um grupo sem ter acesso a ela. Antes, a API permitia adicionar a entidade ao grupo, mas depois retornava um erro de não autorização quando você tentava recuperar os dados de relatório desse grupo. -
O método
groups.list
da API YouTube Analytics agora é compatível com paginação. Se a resposta da API não contiver todos os grupos disponíveis, o parâmetronextPageToken
da resposta vai especificar um token que pode ser usado para recuperar a próxima página de resultados. Defina o parâmetropageToken
do método com esse valor para recuperar mais resultados.
10 de novembro de 2015
Esta atualização contém as seguintes alterações:
-
A API YouTube Analytics agora é compatível com a métrica
redPartnerRevenue
, que informa a receita total estimada gerada com as assinaturas do YouTube Red para as dimensões de relatório selecionadas. O valor da métrica reflete os ganhos com conteúdo musical e não musical e está sujeito a ajustes no fim do mês.A lista de relatórios de proprietário do conteúdo da API YouTube Analytics foi atualizada para identificar os relatórios de vídeo que oferecem suporte à métrica
redPartnerRevenue
:- Estatísticas básicas
- Com base no tempo
- Localização do usuário
- Principais vídeos: para esse relatório,
redPartnerRevenue
também é compatível como uma métrica de classificação. Isso significa que você pode recuperar uma lista de vídeos classificados pelos ganhos do YouTube Red.
-
A definição do relatório de vídeos mais assistidos da API YouTube Analytics agora reflete que ele também é compatível com as seguintes métricas de ganhos:
earnings
,adEarnings
,grossRevenue
,monetizedPlaybacks
,playbackBasedCpm
,impressions
eimpressionBasedCpm
.
29 de outubro de 2015
Esta atualização contém as seguintes alterações:
-
A documentação da dimensão
date
da API YouTube Reporting foi corrigida para refletir que as datas se referem ao período de 24 horas que começa às 0h no horário do Pacífico (UTC-8). Antes, a documentação afirmava que a data começava às 12h (GMT).Além disso, a documentação da API YouTube Analytics foi atualizada para informar que todas as dimensões relacionadas a datas (
day
,7DayTotals
,30DayTotals
emonth
) se referem a datas que começam às 0h (horário do Pacífico, UTC-8). -
O método
jobs.reports.list()
da API YouTube Reporting agora é compatível com o parâmetro de consultacreatedAfter
. Se especificado, esse parâmetro indica que a resposta da API só deve listar relatórios criados após a data e hora especificadas, incluindo novos relatórios com dados preenchidos. O valor do parâmetro se refere ao momento em que o relatório é criado, não às datas associadas aos dados retornados.O valor do parâmetro é um carimbo de data/hora no formato UTC "Zulu" RFC3339, medido com precisão de microssegundos. Exemplo:
"2015-10-02T15:01:23.045678Z"
.As práticas recomendadas da API YouTube Reporting também foram atualizadas para explicar como usar o parâmetro
createdAfter
e evitar o processamento repetido do mesmo relatório. -
As definições da propriedade
createTime
do recursojob
e das propriedadesstartTime
,endTime
ecreateTime
do recursoreport
foram corrigidas para informar que os valores de propriedade são precisos em microssegundos, não em nanossegundos. Além disso, todas as definições agora refletem com precisão que o valor da propriedade é um carimbo de data/hora.
8 de outubro de 2015
Esta atualização contém as seguintes alterações:
-
A documentação da dimensão
sharingService
da API YouTube Analytics foi atualizada para incluir uma lista de valores possíveis. A lista inclui vários serviços com suporte recente.A definição da dimensão
sharing_service
da API YouTube Reporting também foi atualizada para listar os valores recém-compatíveis. Os valores de enumeração maiores que59
são os novos na lista.
24 de setembro de 2015
Esta atualização contém as seguintes alterações:
-
A nova API YouTube Reporting recupera relatórios de dados em massa que contêm dados do YouTube Analytics para um canal ou proprietário de conteúdo. Ela foi projetada para aplicativos que podem importar grandes conjuntos de dados e que oferecem ferramentas para filtrar, classificar e extrair esses dados.
Cada relatório da API YouTube Reporting contém um conjunto predefinido de dimensões e métricas. Os relatórios da API YouTube Analytics também usam métricas e dimensões. Em um relatório, cada linha de dados tem uma combinação única de valores de dimensão. É possível agregar dados em várias linhas com base nos valores de dimensão para calcular métricas de vídeos individuais, países, vídeos ao vivo, usuários inscritos e assim por diante.
É possível usar a API para programar jobs de relatórios, cada um deles identificando um relatório que o YouTube precisa gerar. Depois de configurar um job, o YouTube gera um relatório diário que pode ser baixado de forma assíncrona. Cada relatório contém dados de um período exclusivo de 24 horas.
-
Embora sejam APIs diferentes, a API YouTube Analytics e a API YouTube Reporting permitem que os desenvolvedores recuperem dados do YouTube Analytics. Como as APIs oferecem acesso a conjuntos de dados semelhantes, a documentação das duas APIs está sendo publicada como um único conjunto.
- A guia Guias no conjunto de documentação contém informações comuns às duas APIs, incluindo instruções para autorizar solicitações de API.
- A guia Relatórios em massa contém documentação de referência e outros conteúdos específicos da API YouTube Reporting.
- A guia Consultas segmentadas contém documentação de referência e outros conteúdos específicos da API YouTube Analytics.
- A guia Exemplos lista exemplos de código disponíveis para qualquer uma das duas APIs.
- A guia Ferramentas lista outros recursos disponíveis para ajudar os desenvolvedores a implementar qualquer uma das duas APIs.
20 de agosto de 2015
Esta atualização contém as seguintes alterações:
-
A documentação da API foi reestruturada para facilitar a compreensão. Por isso, essas mudanças não descrevem novos recursos:
-
Agora, a documentação tem uma página que lista todos os relatórios do canal disponíveis e outra que lista todos os relatórios do proprietário do conteúdo disponíveis. Antes, a documentação tinha páginas separadas para relatórios de vídeos e playlists do canal, entre outros.
-
A nova visão geral do modelo de dados busca oferecer uma introdução mais clara de como a API funciona. Especificamente, este documento tenta explicar melhor como o YouTube usa métricas, dimensões e filtros para calcular os valores dos relatórios.
-
O método
reports.query
da API, usado para recuperar relatórios, agora está documentado separadamente. As informações dessa página estavam em outras páginas. A nova página foi criada para ajudar você a identificar com mais facilidade as informações necessárias para recuperar um relatório.
-
22 de julho de 2015
Esta atualização contém várias mudanças, todas aplicáveis apenas aos proprietários de conteúdo:
-
A nova métrica
adEarnings
inclui o total de ganhos estimados (receita líquida) de todas as fontes de publicidade vendidas pelo Google. Ela não é uma métrica principal. A API oferece suporte à métricaadEarnings
para qualquer relatório que já seja compatível com a métricaearnings
.Além disso, a definição da métrica
earnings
foi corrigida para refletir o fato de que o valor dela inclui o total de ganhos estimados de todas as fontes de publicidade vendidas pelo Google e de fontes que não são de publicidade. Antes, a definição indicava incorretamente que a métrica incluía apenas ganhos de fontes de publicidade. -
A métrica
primaryAdGrossRevenue
foi descontinuada. Em vez disso, use a métricagrossRevenue
para recuperar dados de receita. -
Além da métrica
primaryAdGrossRevenue
descontinuada, os relatórios de performance de anúncios não são mais compatíveis com as métricasmonetizedPlaybacks
eplaybackBasedCpm
. No entanto, vários relatórios de vídeo ainda são compatíveis com essas métricas.
1º de junho de 2015
Esta atualização contém as seguintes alterações:
-
Agora a API oferece suporte a duas novas métricas para relatórios de vídeo,
videosAddedToPlaylists
evideosRemovedFromPlaylists
. As listas de relatórios de vídeo para canais e proprietários de conteúdo foram atualizadas para identificar os relatórios que oferecem suporte às novas métricas.videosAddedToPlaylists
: o número de vezes que os vídeos no escopo da consulta foram adicionados a qualquer playlist do YouTube. Os vídeos podem ter sido adicionados à playlist do proprietário ou de outros canais.videosRemovedFromPlaylists
: o número de vezes que os vídeos no escopo da consulta foram removidos de qualquer playlist do YouTube. Os vídeos podem ter sido removidos da playlist do proprietário ou de playlists de outros canais.
As duas métricas incluem playlists padrão, como a "Assistir mais tarde". No entanto, elas não contam playlists em que um vídeo é adicionado automaticamente, como a playlist de envios de um canal ou o histórico de exibição de um usuário. Essas métricas refletem o número absoluto de adições e exclusões. Então, se um usuário adicionar um vídeo a uma playlist, remover e adicionar de novo, as métricas vão indicar que o vídeo foi adicionado a duas playlists e removido de uma.
Os dados dessas métricas estão disponíveis desde 1º de outubro de 2014.
31 de março de 2015
Esta atualização contém as seguintes alterações:
-
As métricas
favoritesAdded
efavoritesRemoved
foram descontinuadas a partir deste anúncio. Ambas são métricas principais e estão sujeitas à política de descontinuação estabelecida nos Termos de Serviço.
16 de março de 2015
Esta atualização contém as seguintes alterações:
-
O novo parâmetro
currency
permite recuperar métricas de ganhos em uma moeda diferente do dólar dos Estados Unidos (USD
). Se o parâmetro estiver definido, a API vai converter os valores das métricasearnings
,grossRevenue
,playbackBasedCpm
eimpressionBasedCpm
para a moeda especificada. Os valores retornados são estimativas calculadas usando taxas de câmbio que mudam diariamente.O valor do parâmetro é um código de moeda ISO 4217 de três letras. O valor padrão é
USD
. A definição de parâmetro contém uma lista de códigos de moeda aceitos.
25 de fevereiro de 2015
Esta atualização contém as seguintes alterações:
-
Agora a API permite criar e gerenciar grupos do YouTube Analytics, além de recuperar dados de relatórios desses grupos.
-
Como criar e gerenciar grupos
Esta atualização apresenta os recursos
group
egroupItem
para criar e gerenciar grupos.- O recurso
group
representa um grupo do Analytics, uma coleção personalizada de até 200 canais, vídeos, playlists ou recursos. A API oferece suporte aos métodoslist
,insert
,update
edelete
para esse recurso. - O recurso
groupItem
representa um item em um grupo do Google Analytics. A API é compatível com os métodoslist
,insert
edelete
para esse recurso.
Por exemplo, é possível criar um grupo usando o método
groups.insert
e adicionar itens a ele usando o métodogroupItems.insert
. - O recurso
-
Recuperar dados de relatórios para um grupo
A documentação de dimensões foi atualizada para incluir a dimensão
group
, que pode ser usada como filtro em muitos relatórios de canais e relatórios de proprietários do conteúdo. Quando você usa o filtrogroup
, a API retorna dados de todos os itens desse grupo. No momento, a API não permite criar relatórios para grupos de recursos.
Acesse a Central de Ajuda do YouTube para mais informações sobre os grupos do YouTube Analytics.
-
13 de fevereiro de 2015
Esta atualização contém as seguintes alterações:
-
A API não é mais compatível com a dimensão
show
.
28 de agosto de 2014
Esta atualização contém as seguintes alterações:
-
Agora, a API permite especificar vários valores para as dimensões
video
,playlist
,channel
eshow
quando elas são usadas como filtros. Para especificar vários valores, defina o valor do parâmetrofilters
como uma lista separada por vírgulas dos IDs de vídeo, playlist, canal ou programa para os quais a resposta da API deve ser filtrada. O valor do parâmetro pode especificar até 200 IDs.Se você especificar vários valores para o mesmo filtro, também poderá adicioná-lo à lista de dimensões especificadas para a solicitação. Isso é válido mesmo que o filtro não esteja listado como uma dimensão compatível para um determinado relatório. Se você adicionar o filtro à lista de dimensões, a API também usará os valores de filtro para agrupar os resultados.
Consulte a definição do parâmetro
filters
para mais detalhes sobre essa funcionalidade.
16 de julho de 2014
Esta atualização contém as seguintes alterações:
-
Ao extrair um relatório de canal, agora é possível recuperar dados do canal do usuário autenticado definindo o valor do parâmetro
ids
comochannel==MINE
. Também é possível definir o parâmetroids
comochannel==CHANNEL_ID
para recuperar dados do canal especificado. -
Agora a API é compatível com relatórios de playlists, que contêm estatísticas relacionadas às visualizações de vídeos que ocorrem no contexto de uma playlist. Os relatórios de playlists estão disponíveis para canais e proprietários de conteúdo.
Todos os relatórios de playlist são compatíveis com as métricas
views
eestimatedMinutesWatched
, e alguns também são compatíveis com a métricaaverageViewDuration
.Além disso, todos os relatórios de playlist são compatíveis com as seguintes métricas novas. Cada uma dessas métricas reflete apenas as visualizações de playlists que ocorreram na Web.
playlistStarts
: o número de vezes que os espectadores iniciaram a reprodução de uma playlist.viewsPerPlaylistStart
: o número médio de visualizações de vídeo que ocorreram a cada vez que uma playlist foi iniciada.averageTimeInPlaylist
: o tempo médio estimado, em minutos, que um espectador assistiu aos vídeos de uma playlist depois que ela foi iniciada.
Qualquer solicitação para recuperar um relatório de playlist precisa usar o filtro
isCurated
, que deve ser definido como1
(isCurated==1
). -
A API agora oferece suporte a um relatório de retenção de público-alvo. Esse relatório mede a capacidade de um vídeo de reter o público. A nova dimensão
elapsedVideoTimeRatio
do relatório mede a quantidade de vídeo que passou para os valores de métrica correspondentes:-
A métrica
audienceWatchRatio
identifica a proporção absoluta de espectadores assistindo o vídeo em um determinado momento. A proporção é calculada comparando o número de vezes que uma parte de um vídeo foi assistida com o número total de visualizações dele.Uma parte de um vídeo pode ser assistida mais de uma vez (ou nenhuma vez) em uma visualização. Por exemplo, se os usuários voltarem e assistirem várias vezes à mesma parte de um vídeo, a proporção absoluta dessa parte poderá ser maior que
1
. -
A métrica
relativeRetentionPerformance
mostra a eficiência de um vídeo em reter espectadores durante as reproduções em comparação com todos os vídeos do YouTube de duração semelhante. Um valor de 0 indica que o vídeo retém espectadores pior do que qualquer outro vídeo de duração semelhante, enquanto um valor de 1 indica que o vídeo retém espectadores melhor do que qualquer outro vídeo de duração semelhante. Um valor mediano de 0,5 indica que metade dos vídeos de duração semelhante retém melhor os espectadores, enquanto a outra metade retém pior.
Você também pode usar o filtro
audienceType
para que o relatório retorne apenas dados associados a visualizações orgânicas, visualizações de anúncios TrueView in-stream ou visualizações de anúncios TrueView in-display. As visualizações orgânicas são o resultado direto da ação do usuário, como a pesquisa de um vídeo ou o clique em um vídeo sugerido. -
-
A API é compatível com várias métricas novas relacionadas a anotações. As métricas listadas abaixo podem ser recuperadas com qualquer relatório que antes oferecia suporte às métricas
annotationClickThroughRate
eannotationCloseRate
.annotationImpressions
: o número total de impressões de anotação.annotationClickableImpressions
: o número de anotações que apareceram e puderam ser clicadas.annotationClosableImpressions
: o número de anotações que apareceram e puderam ser fechadas.annotationClicks
: o número total de anotações clicadas.annotationCloses
: o número total de anotações fechadas.
Todas as novas métricas são principais e estão sujeitas à política de descontinuação. No entanto, os dados das novas métricas estão disponíveis desde 16 de julho de 2013. Os dados das métricas
annotationClickThroughRate
eannotationCloseRate
estão disponíveis desde 10 de junho de 2012. -
GOOGLE_SEARCH
não é mais informado como um valor separado para a dimensãoinsightTrafficSourceType
. Em vez disso, as referências dos resultados da pesquisa do Google agora são atribuídas ao tipo de origem de tráfegoEXT_URL
. Como resultado, também não é mais possível recuperar um relatórioinsightTrafficSourceDetail
que define o filtroinsightTrafficSourceType
comoGOOGLE_SEARCH
.
31 de janeiro de 2014
Esta atualização contém as seguintes alterações:
-
O documento Relatórios de proprietário do conteúdo foi atualizado para refletir que as métricas
subscribersGained
esubscribersLost
agora podem ser recuperadas para conteúdo reivindicado ou enviado por um proprietário.A mudança é visível no primeiro relatório de estatísticas básicas para proprietários de conteúdo, que agora é compatível com os filtros
claimedStatus
euploaderType
.
16 de janeiro de 2014
Esta atualização contém as seguintes alterações:
-
O documento de solicitações de amostra foi reformulado para agrupar exemplos em categorias, usando um formato de guia semelhante ao lançado recentemente para relatórios de canais e proprietários de conteúdo. Com o novo design, os exemplos são agrupados nas seguintes categorias:
- Estatísticas básicas
- Por períodos
- Geográfico
- Local da visualização
- Origem do tráfego
- Dispositivo/SO
- Informações demográficas
- Social
- Ganhos/anúncios (somente para relatórios de proprietários de conteúdo)
-
O documento solicitações de amostra agora inclui novos exemplos para recuperar dados específicos de províncias em relatórios de canais ou de proprietários de conteúdo.
-
Métricas específicas de províncias para estados dos EUA e Washington D.C.: Esse relatório recupera um detalhamento por província das contagens de visualizações e outras estatísticas dos vídeos de um canal. Os dados abrangem os estados dos EUA e Washington D.C. O exemplo usa a dimensão
province
e o parâmetrofilters
para restringir a resposta e incluir apenas resultados dos Estados Unidos. -
Informações demográficas dos espectadores na Califórnia (faixa etária e gênero): esse relatório recupera estatísticas sobre a faixa etária e o gênero dos espectadores na Califórnia que assistiram os vídeos de um canal ou, para relatórios de proprietários de conteúdo, o conteúdo reivindicado de um proprietário. Este exemplo usa o parâmetro
filters
para garantir que a resposta inclua apenas dados de uma determinada província.
-
-
A definição da dimensão
province
foi atualizada para informar que, quandoprovince
é incluído no valor do parâmetrodimensions
, a solicitação também precisa restringir os dados aos Estados Unidos incluindocountry==US
no valor do parâmetrofilters
.
6 de janeiro de 2014
Esta atualização contém as seguintes alterações:
-
Os documentos que listam os relatórios de canal e proprietário do conteúdo aceitos foram reformulados. Em vez de fornecer uma tabela que lista todos os relatórios possíveis, cada documento agrupa os relatórios em categorias:
- Estatísticas básicas
- Por períodos
- Geográfico
- Local da visualização
- Origem do tráfego
- Dispositivo/SO
- Informações demográficas
- Social
- Vídeos mais acessados
Cada documento mostra essas categorias como uma lista de guias. Clique em qualquer guia para ver os relatórios compatíveis nessa categoria.
-
Agora a API é compatível com três novas dimensões geográficas:
province
,continent
esubContinent
.-
Com a dimensão
province
, você pode recuperar estatísticas dos estados dos EUA e do Distrito de Columbia. A API aceita dois usos para essa dimensão:-
A API oferece suporte a dois relatórios que detalham as estatísticas por estado. Os dois relatórios estão disponíveis para canais e proprietários de conteúdo.
- O relatório de estatísticas principais oferece várias estatísticas, incluindo contagens de visualizações e minutos assistidos estimados.
- O relatório com base em período fornece as mesmas estatísticas, mas agrega dados diariamente, a cada 7 ou 30 dias ou mensalmente.
-
Use o parâmetro de consulta
filters
para restringir um relatório a estatísticas de um estado específico. Vários relatórios oferecem suporte a esse tipo de filtragem, incluindo relatórios geográficos, de local de reprodução, de origem de tráfego, de dispositivo, de sistema operacional, demográficos e de principais vídeos.
-
-
A dimensão
continent
especifica um código de região estatística das Nações Unidas (ONU) que identifica um continente. Essa dimensão só pode ser usada como um filtro. -
A dimensão
subContinent
especifica um código de região estatística das Nações Unidas (ONU) que identifica uma sub-região de um continente. Essa dimensão também só pode ser usada como um filtro.Como cada sub-região está associada a um continente, não é necessário usar o filtro
continent
ao usar o filtrosubContinent
. Na verdade, a API vai retornar um erro se uma solicitação usar as duas dimensões.
-
-
A documentação foi corrigida para que a dimensão
insightTrafficSourceDetail
não inclua o valorinsightTrafficSourceType
PROMOTED
como um valor de filtro válido.
30 de setembro de 2013
Esta atualização contém as seguintes alterações:
-
A API YouTube Analytics agora está sujeita à política de descontinuação descrita nos Termos de Serviço. No entanto, as dimensões e métricas não principais da API não estão sujeitas à política de suspensão de uso. As páginas dimensões e métricas foram atualizadas para listar as dimensões e métricas principais. Além disso, as definições nessas páginas foram atualizadas para identificar explicitamente as principais dimensões e métricas.
-
Agora, a API aceita
EXTERNAL_APP
como um valor para a dimensãoinsightPlaybackLocationType
. Junto com essa atualização, a partir de 10 de setembro de 2013, as reproduções não são mais categorizadas comoMOBILE
, mas as reproduções em dispositivos móveis que ocorreram antes dessa data ainda serão categorizadas com esse valor.Com essa atualização, as reproduções em dispositivos móveis agora são classificadas como
WATCH
,EMBEDDED
ouEXTERNAL_APP
, dependendo do tipo de aplicativo em que elas ocorrem. -
Agora, a API aceita
PLAYLIST
como um valor para a dimensãoinsightTrafficSourceType
. O valor indica que as visualizações de vídeo foram encaminhadas de uma playlist. Antes, essas visualizações eram classificadas usando a categoriaYT_OTHER_PAGE
da dimensão.
16 de julho de 2013
Esta atualização contém as seguintes alterações:
-
Agora, a API suporta a capacidade de classificar os relatórios por vári dimensões e métricas. O exemplo de documento de solicitações contém um novo exemplo, Como classificar solicitações por várias dimensões/métricas, que demonstra essa funcionalidade. A solicitação recupera dados de origem de tráfego e tem um valor de parâmetro
sort
deday,-views
. Os resultados são classificados cronologicamente, mas dentro do conjunto de resultados de cada dia, a primeira linha contém dados para a origem de tráfego que gerou o maior número de visualizações, a segunda linha contém dados para a origem que gerou o segundo maior número de visualizações e assim por diante. -
Agora a API é compatível com duas novas dimensões,
deviceType
eoperatingSystem
, que podem ser usadas para recuperar dados sobre os dispositivos em que os espectadores estão assistindo seus vídeos. A API suporta relatórios que usam uma ou as duas dimensões.-
O relatório
deviceType
permite recuperar contagens de visualizações e tempo de exibição estimado para diferentes tipos de dispositivos, incluindo computadores, smartphones e tablets. Você também pode usar o filtrooperatingSystem
para restringir o relatório de tipo de dispositivo a estatísticas de dispositivos que executam um sistema operacional específico, como Android ou iOS. -
Com o relatório
operatingSystem
, é possível recuperar contagens de visualizações e tempo de exibição estimado para diferentes sistemas operacionais, como Android, iOS, Linux e outros. Você também pode usar o filtrodeviceType
para restringir o relatório de sistema operacional a estatísticas de um tipo específico de dispositivo, como dispositivos móveis ou tablets.
Os novos relatórios de tipo de dispositivo e de sistema operacional estão disponíveis para canais e proprietários do conteúdo.
-
-
O documento exemplo de solicitações foi atualizado para incluir três relatórios de dispositivo para canais e três para proprietários do conteúdo.
-
A dimensão
insightPlaybackLocationType
pode retornar o valorYT_OTHER
, que identifica visualizações não classificadas usando um dos outros valores da dimensão.
23 de maio de 2013
Esta atualização contém as seguintes alterações:
-
O documento relatórios do proprietário do conteúdo foi atualizado para refletir que você pode classificar o relatório dos principais vídeos em ordem decrescente de ganhos para identificar os vídeos com os maiores ganhos. Esse é o primeiro relatório listado na segunda tabela da seção Relatórios de atividade e ganhos dos usuários.
10 de maio de 2013
Esta atualização contém as seguintes alterações:
-
O YouTube não identifica mais os recursos e serviços experimentais da API. Em vez disso, agora, fornecemos uma lista de APIs do YouTube que estão sujeitas à política de suspensão de uso.
06 de maio de 2013
Esta atualização contém as seguintes alterações:
-
Agora, a API permite recuperar métricas de tempo de exibição (
estimatedMinutesWatched
,averageViewDuration
eaverageViewPercentage
) com outras métricas, incluindo métricas de visualização, engajamento, ganhos e desempenho de anúncios.As listas de relatórios de canal e relatórios do proprietário do conteúdo disponíveis foram atualizadas para refletir essa mudança. Agora, as listas são, na verdade, menores, pois as métricas de tempo de exibição podem ser recuperadas como parte de outros relatórios relacionados.
O documento Exemplo de solicitações de API também foi atualizado.
-
Os relatórios que usam as dimensões
insightPlaybackLocationDetail
einsightTrafficSourceDetail
foram aprimorados das seguintes maneiras:-
Agora, eles aceitam um filtro
country
opcional. -
Agora, os proprietários de conteúdo podem recuperar esses relatórios usando qualquer uma das seguintes combinações novas de
filter
. Todas essas combinações também são compatíveis com o filtro opcionalcountry
.-
Detalhes do local de reprodução
channel,insightPlaybackLocationType==EMBEDDED
show,insightPlaybackLocationType==EMBEDDED
claimedStatus,insightPlaybackLocationType==EMBEDDED
uploaderType,insightPlaybackLocationType==EMBEDDED
uploaderType,claimedStatus,insightPlaybackLocationType==EMBEDDED
-
Detalhes da origem do tráfego
channel,insightTrafficSourceType
show,insightTrafficSourceType
claimedStatus,insightTrafficSourceType
uploaderType,insightTrafficSourceType
uploaderType,claimedStatus,insightTrafficSourceType
-
-
03 de maio de 2013
Esta atualização contém as seguintes alterações:
-
O novo documento Exemplos de solicitações da API mostra como recuperar vários tipos de relatórios usando a YouTube Analytics API. Cada exemplo inclui uma breve descrição do relatório que a solicitação recupera e mostra as dimensões, métricas, filtros e parâmetros de classificação da solicitação.
-
A dimensão
insightTrafficSourceType
agora aceitaSUBSCRIBER
como um valor válido. Este valor identifica as exibições de vídeo que foram direcionadas de feeds da página inicial do YouTube ou de recursos de inscrição do YouTube. Se você filtrar com base nessa origem de tráfego, o campoinsightTrafficSourceDetail
vai especificar o feed da página inicial ou outra página de onde as visualizações foram encaminhadas.
28 de março de 2013
Esta atualização contém as seguintes alterações:
-
Agora, a API oferece suporte a duas novas métricas,
annotationClickThroughRate
eannotationCloseRate
, relacionadas às interações dos espectadores com as anotações que aparecem durante os vídeos. As listas de relatórios do canal e relatórios do proprietário do conteúdo foram atualizadas para identificar os relatórios que oferecem suporte às novas métricas.annotationClickThroughRate
: a proporção de anotações clicadas pelos espectadores em relação ao número total de impressões de anotações clicáveis.annotationCloseRate
: a proporção de anotações fechadas pelos espectadores em relação ao número total de impressões de anotações.
21 de março de 2013
Esta atualização contém as seguintes alterações:
-
Agora, a API suporta as métricas de ganhos e de desempenho de anúncios, além dos novos relatórios de desempenho de anúncios. As métricas e os relatórios são acessíveis apenas para parceiros de conteúdo do YouTube que participam do Programa de parceria do YouTube.
-
Os relatórios recém-suportados oferecem suporte a métricas de desempenho de anúncios baseados em reprodução e a métricas de desempenho de anúncios baseados em impressão. Consulte a documentação relatórios do proprietário do conteúdo para mais informações sobre os relatórios de desempenho de anúncios.
-
As métricas recém-suportadas estão listadas abaixo. A lista de relatórios do proprietário do conteúdo foi atualizada para identificar os relatórios, incluindo os dois novos, que suportam essas métricas.
earnings
– Total de ganhos estimados de todas as fontes de publicidade vendidas pelo Google.grossRevenue
: receita bruta estimada de parceiros do Google ou da DoubleClick.primaryAdGrossRevenue
: receita bruta estimada, somada e classificada no tipo de anúncio principal das reproduções de vídeo cobertas pelo relatório, de parceiros do Google ou da DoubleClick.monetizedPlaybacks
: o número de exibições que mostraram pelo menos uma impressão de anúncio.playbackBasedCpm
: receita bruta estimada por mil reproduções.impressions
: o número de impressões de anúncios veiculadas e verificadas.impressionBasedCpm
: receita bruta estimada por mil impressões de anúncios.
Observação: consulte as definições de métricas para detalhes completos.
-
Qualquer solicitação que recupere métricas de ganhos ou de performance de anúncios precisa enviar um token de autorização que conceda acesso usando o novo escopo
https://www.googleapis.com/auth/yt-analytics-monetary.readonly
.
-
-
A documentação da API foi reorganizada para que diferentes tipos de relatórios sejam explicados em páginas separadas. Como tal, agora, há páginas separadas que explicam os diferentes tipos de relatórios de canal e relatórios do proprietário do conteúdo.
04 de fevereiro de 2013
Esta atualização contém as seguintes alterações:
-
Agora, o guia de referência da API tem uma seção exemplos que inclui exemplos de código que demonstram como chamar a API usando as bibliotecas cliente Java, JavaScript, Python e Ruby. O exemplo de código JavaScript é o mesmo discutido em detalhes na documentação do aplicativo de exemplo.
14 de novembro de 2012
Esta atualização contém as seguintes alterações:
-
O guia de referência da API agora apresenta o APIs Explorer, que permite chamar a API, ver a solicitação dela e recuperar dados reais na resposta.
-
A API suporta uma série de novos relatórios para os canais e proprietários do conteúdo, descritos abaixo. Todos os relatórios estão disponíveis como um relatório de canal ou um relatório do proprietário do conteúdo. As páginas dimensões e métricas também foram atualizadas.
-
O relatório de local de reprodução especifica o número de visualizações de vídeos que ocorreram em diferentes tipos de páginas ou aplicativos.
-
O relatório detalhado de local de reprodução identifica os players integrados que geraram o maior número de visualizações de um vídeo especificado. Ele fornece uma visualização mais refinada do que o relatório de local de reprodução identificando os URLs associados aos principais players integrados.
-
O relatório de origem de tráfego identifica o número de visualizações de vídeos provenientes de diferentes tipos de referenciadores.
-
O relatório detalhado de origem de tráfego identifica os referenciadores que geraram o maior número de visualizações para um vídeo especificado e um tipo de origem de tráfego especificado. Por exemplo, esse relatório pode mostrar os vídeos relacionados que enviaram mais tráfego para um vídeo específico. Esse relatório é suportado por várias origens de tráfego.
-
Os relatórios de tempo de exibição fornecem o tempo gasto por espectadores assistindo a seu conteúdo. Os relatórios podem agregar dados de um período (dia, sete dias anteriores, 30 dias anteriores etc) ou país específico. Se um relatório agrega dados por dia ou país, ele também pode especificar a duração média de cada exibição de vídeo, além da porcentagem média de cada vídeo que os usuários assistiram.
-
02 de outubro de 2012
Esta atualização contém as seguintes alterações:
-
O YouTube Analytics API agora está disponível para todos os desenvolvedores. Você pode ativar a API para seu projeto, sem precisar solicitar acesso primeiro, no painel Serviços em APIs console.
-
A nova seção Introdução descreve os pré-requisitos e as etapas básicas para criar um aplicativo que usa o YouTube Analytics API.
12 de setembro de 2012
Esta atualização contém as seguintes alterações:
-
A nova seção entender o uso da cota fornece diretrizes para a otimização de seu uso da cota de API. O servidor de API calcula um custo de consulta para cada solicitação, e esse custo é deduzido de sua cota de uso da API. Como diferentes tipos de relatórios podem ter vários custos de consulta, planeje o uso de sua cota de maneira eficiente, e seu aplicativo deve solicitar somente as métricas e os dados de que realmente precisa.
-
A seção dimensões temporais foi atualizada para explicar que essas dimensões indicam que um relatório do Analytics deve agregar dados com base em um período. Agora, a API suporta as seguintes dimensões temporais adicionais:
7DayTotals
: os dados no relatório serão agregados para que cada linha contenha dados de um período de sete dias.30DayTotals
: os dados no relatório serão agregados para que cada linha contenha dados de um período de 30 dias.month
: os dados no relatório serão agregados por mês civil.
Da mesma forma, a seção relatórios disponíveis foi atualizada para refletir o apoio da API para os relatórios que usam essas dimensões.
-
A seção Dimensões da entidade de relatórios foi atualizada para informar que as solicitações de API para recuperar relatórios do proprietário do conteúdo precisam filtrar os dados usando uma destas dimensões (
video
,channel
oushow
) ou uma combinação compatível das dimensõesclaimedStatus
euploaderType
. -
Agora, a API suporta duas novas opções de classificação para os relatórios dos principais vídeos. Esses relatórios, que estão disponíveis como relatórios de canal ou relatórios do proprietário do conteúdo, contêm métricas (visualizações, comentários, gostei etc) por país e decompõem essas métricas por vídeo. Você pode classificar os relatórios com base no número de usuários que se inscreveram ou cancelaram a inscrição de um canal da página de exibição do vídeo.
-
As definições das métricas
subscribersGained
esubscribersLost
foram atualizadas para explicar que um canal pode ganhar ou perder inscritos em vários lugares, incluindo a página de exibição do vídeo, a página do canal e o guia que aparece na página inicial do YouTube. Quando aparecem em um relatório específico do vídeo, essas métricas incluem apenas as estatísticas da página de exibição do vídeo especificado.