Esta página lista as mudanças na API e as atualizações da documentação da API YouTube Reporting e da API YouTube Analytics. Ambas as APIs permitem que os desenvolvedores acessem os dados do YouTube Analytics, ainda que de maneiras diferentes. Inscreva-se neste registro de alterações.
15 de dezembro de 2022
A API YouTube Analytics (Queryed Targets) é compatível com duas novas dimensões e com um novo relatório:
-
Um novo relatório mostra a atividade dos usuários por cidade. Esse relatório está disponível para canais e proprietários do 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 dimensão opcional para todos os relatórios de vídeo do proprietário do canal e do conteúdo. -
O guia de solicitações de amostra 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 (Targeted Query) e a API Reporting (massa) do YouTube são compatíveis com um novo valor de detalhes da origem do 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 Reporting do YouTube (relatórios em massa), se o valor da dimensão
traffic_source_type
for3
, o valor detraffic_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. Essa 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 dos serviços da API do YouTube, essa mudança será
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 perfeita para o novo conjunto de valores.
Estas são as mudanças específicas:
- Na API YouTube Analytics (Segmentado Consultas), a dimensão
gender
atualmente aceita dois valores:female
emale
. A partir de 11 de agosto de 2022, essa dimensão será compatível com três valores:female
,male
euser_specified
. - Na API Reporting do YouTube (relatórios em massa), a dimensão
gender
atualmente aceita três valores:FEMALE
,MALE
eGENDER_OTHER
. A partir de 11 de agosto de 2022, o conjunto de valores compatíveis 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 tanto a API YouTube Analytics (Consultas segmentadas) quanto a API Relatórios do YouTube (relatórios em massa).
- Na API YouTube Analytics (Consultas segmentadas), as métricas
averageViewDuration
eaverageViewPercentage
excluem o tráfego de clipes em loop de 13 de dezembro de 2021. - Na API Reporting do YouTube (relatórios em massa), as métricas
average_view_duration_seconds
eaverage_view_duration_percentage
excluem o tráfego de clipes em loop de 13 de dezembro de 2021.
2 de fevereiro de 2022
Essa API Reporting do YouTube (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 em tempo real:
- Na API Reporting do YouTube (relatórios em massa), a dimensão
traffic_source_type
é compatível com 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 indicado.
23 de setembro de 2020
Tanto a API YouTube Analytics (TargetedConsultas) e a API Reporting (relatórios em massa) são compatíveis com um novo valor de dimensão da origem de tráfego que indica que o espectador foi referido ao deslizar verticalmente na experiência de visualização do YouTube Shorts:
- Na API (Consultas segmentadas) da API YouTube Analytics, a dimensão
insightTrafficSourceType
é compatível com o valorSHORTS
. - Na API Reporting do YouTube (relatórios em massa), a dimensão
traffic_source_type
é compatível com o valor24
.
A dimensão de detalhes da origem do tráfego (insightTrafficSourceDetail
na API YouTube Analytics ou traffic_source_detail
na API Reporting do YouTube) não é preenchida para esse novo tipo de origem.
20 de julho de 2020
Esta atualização abrange duas mudanças que afetam a API YouTube Analytics (Queryed Targets):
- 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 à recuperação de dados do YouTube Analytics. O parâmetro aceita a capacidade de especificar vários valores para os filtrosvideo
,playlist
echannel
, e o número máximo de IDs que podem ser especificados para esses filtros aumentou de 200 para 500 IDs.
13 de fevereiro de 2020
Esta atualização contém as seguintes mudanças relacionadas à API YouTube Analytics (TargetedConsultas) e à API Reporting (relatórios em massa) do YouTube. Saiba mais sobre essas mudanças na Central de Ajuda do YouTube.
Nas duas APIs, o conjunto de possíveis valores de detalhes da origem do tráfego para notificações está mudando.
Em consultas segmentadas, as notificações são relatadas como insightTrafficSourceType=NOTIFICATION
. Em
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 e transmissões ao vivo enviadas anteriormente como uploaded
em duas categorias:
uploaded_push
: visualizações originadas de notificações push enviadas aos assinantes quando um vídeo foi enviadouploaded_other
: visualizações originadas de notificações não push, como notificações por e-mail ou da caixa de entrada, enviadas para os assinantes quando um vídeo foi enviado.
Esses valores são retornados para o período a partir de 13 de janeiro de 2020.
Além disso, lembre-se de que esses valores não representam as notificações em si, mas sim as origens
de tráfego que impulsionaram determinadas visualizações no YouTube. Por exemplo, se uma linha de relatório indica views=3
,
traffic_source_type=17
(NOTIFICATION
) e
traffic_source_detail=uploaded_push
, a linha indica que três visualizações
resultaram de espectadores que clicaram em 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 (Queryed Targets):
-
Observação:este é um anúncio de descontinuação.
O YouTube está removendo o suporte para as dimensões
7DayTotals
e30DayTotals
. Você ainda poderá recuperar dados usando essas dimensões até 15 de abril de 2020. A partir dessa data, as tentativas de recuperar relatórios usando a dimensão7DayTotals
ou30DayTotals
retornarão um erro.Os usuários podem reproduzir alguns dos dados para essas dimensões consultando com a dimensão
day
e agregando ou derivando dados de períodos de 7 ou 30 dias. Exemplo:- O número de visualizações de um período de sete dias pode ser calculado agregando o número de visualizações de cada dia desse período.
- A porcentagem do visualizador para um período de sete dias pode ser calculada multiplicando o número de visualizações que ocorreram em cada dia vezes a porcentagem do espectador para esse dia para ter o número de espectadores que fizeram login ao assistir ao vídeo naquele dia. Em seguida, o número de espectadores conectados pode ser adicionado durante todo o período e dividido pelo número total de visualizações desse período para ter a porcentagem do leitor para o período.
- O número de espectadores únicos em um período de sete dias não pode ser calculado, já que uma mesma pessoa pode ser calculada como um espectador único em dias diferentes. No entanto, talvez você possa usar a dimensão
month
em vez da dimensão30DayTotals
para extrapolar os dados sobre o número de espectadores únicos em um período de 30 dias. A dimensãomonth
refere-se a meses do calendário, 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 (Queryed Targets):
-
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 (Queryed Targets):
-
A versão 1 da API foi descontinuada. Atualize seus clientes de API para usar a versão 2 da API assim que possível para minimizar as interrupções do serviço se você ainda não tiver feito isso. Consulte o guia de migração para mais detalhes.
A programação para essa suspensão de uso foi anunciada em 26 de abril de 2018.
17 de setembro de 2018
Esta atualização contém as seguintes mudanças relacionadas à API YouTube Analytics (Queryed Targets):
-
A nova seção Anonimização de dados no documento de visão geral 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 específico;
ou
-
você tiver selecionado um filtro ou dimensão, como origem de tráfego ou país, para os quais os valores não atinjam um determinado limite.
A nova seção também inclui uma discussão dos tipos de dados que podem ser limitados nos relatórios do YouTube Analytics.
-
-
Os documentos relatórios de 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 alterações à API YouTube Analytics (Consultas segmentadas):
- Os requisitos de escopo dos seguintes métodos mudaram:
- As solicitações para o método
reports.query
precisam ter acesso ao escopohttps://www.googleapis.com/auth/youtube.readonly
. - As solicitações para o 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 por sua vez é um escopo de leitura/gravação, e a segunda usa dois escopos somente leitura.
- o escopo
- As solicitações para o método
23 de maio de 2018
Esta atualização contém as seguintes alterações à API YouTube Analytics (Consultas segmentadas):
- A visão geral da API contém uma nova seção, métricas agregadas e itens excluídos, que explica como as respostas da API lidam com os dados associados aos recursos excluídos, como vídeos, playlists ou canais.
- A seção de 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 dos recursos identificados em respostas da API YouTube Analytics. Conforme indicado nas Políticas para desenvolvedores dos serviços da API do YouTube (seções III.E.4.b a III.E.4.d), os clientes de 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 alterações relacionadas à API Reporting (relatórios em massa) do YouTube:
- 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 de API, inclusive relatórios de preenchimento, vai ficar disponível por 60 dias a partir do momento em que forem gerados. No entanto, os relatórios com dados históricos ficarão disponíveis por 30 dias a partir do momento em que forem gerados.
Antes deste comunicado, todos os relatórios de API estavam disponíveis há 180 dias a partir do momento em que foram gerados. Para esclarecer, quando a mudança na política entrar em vigor, também não será mais possível acessar os relatórios de dados históricos com mais de 30 dias pela API. Todos os outros relatórios com mais de 60 dias também não poderão mais ser acessados. Dessa forma, a documentação agora declara que os relatórios criados antes da alteração na política estarão disponíveis por até 180 dias.
-
Após a mudança, quando você agendar um trabalho de relatório, o YouTube vai gerar relatórios a partir desse dia e cobrir o período de 30 dias antes do horário em que o trabalho foi programado. Antes da mudança, quando você agendar um trabalho de relatório, o YouTube gerará relatórios abrangendo o período de 180 dias anterior à hora em que o trabalho foi programado.
-
-
A seção práticas recomendadas foi atualizada para lembrar que você pode usar a API YouTube Data para recuperar metadados adicionais dos recursos identificados em relatórios. Conforme indicado nas Políticas para desenvolvedores dos serviços da API do YouTube (seções III.E.4.b a III.E.4.d), os clientes de 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 mostrar que, embora os dados do relatório não sejam filtrados, os relatórios com dados de um período anterior ou posterior a 1o de junho de 2018 não terão referências aos recursos do YouTube que foram excluídos pelo menos 30 dias antes da geração do relatório.
-
A seção dados históricos da visão geral da API foi atualizada para informar que, quando você programa um novo job de relatório, os relatórios históricos costumam ser publicados em alguns dias. Antes, a documentação dizia que poderia levar até 30 dias para que esses relatórios estivessem disponíveis.
-
A seção dados de preenchimento da visão geral da API foi atualizada para definir mais claramente os dados de preenchimento como um conjunto de dados que substitui um conjunto enviado anteriormente.
26 de abril de 2018
A versão 2 da API do YouTube Analytics (consultas segmentadas) (v2) já está disponível para o público. A lista a seguir identifica as alterações na documentação e no produto relacionadas à nova versão da API:
-
A API v2 é quase idêntica à API v1. No entanto, você provavelmente precisará atualizar seu código para refletir as alterações listadas abaixo. 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
têm nomes atualizados. Especificamente, os nomes de parâmetros que contêm hifens, comoend-date
na API v1, usam letras concatenadas (endDate
) em vez de hifens na API v2. Essa mudança torna os nomes dos parâmetros consistentes em toda a API, já que os métodos da API para criar e gerenciar grupos já usavam letras maiúsculas em nomes de parâmetros. - A API v2 não é compatível com solicitações em lote enviadas para o endpoint de lote HTTP global do Google (
www.googleapis.com/batch
). Se você está enviando solicitações em lote na API v2, é necessário usar 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 oferece mais suporte aos parâmetros de solicitaçãoalt
,quotaUser
euserIp
. - A API v2 não oferece um endpoint de lote com suporte a lotes compostos de solicitações para diferentes APIs. (No entanto, um lote pode ser composto de solicitações para métodos diferentes da mesma API). Essa descontinuação não é específica da API YouTube Analytics, porque o Google está descontinuando o endpoint global em lote em todas as APIs dela.
- A API v2 não é compatível com o protocolo JSON-RPC, que era compatível com a API v1. Novamente, a suspensão de uso não é específica da API YouTube Analytics.
- A versão da API mudou de
-
Observação: este é um anúncio de descontinuação.
A versão 1 da API (v1) foi descontinuada e vai ter suporte até 31 de outubro de 2018. Todas as solicitações para a API v1 deixarão de funcionar após essa data. Por isso, faça upgrade para a API v2 até 31 de outubro de 2018 e evite interrupções na sua capacidade de acessar os dados do YouTube Analytics usando essa API.
21 de fevereiro de 2018
Esta atualização contém as seguintes alterações à API YouTube Analytics (Consultas segmentadas):
- Os Relatórios demográficos de visualização, que agregam estatísticas de visualização com base na idade 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 é compatível com o seguinte valor:25
: KaiOS
- A dimensão
-
API YouTube Analytics (consultas segmentadas)
- A dimensão
operatingSystem
aceita o valorKAIOS
.
- A dimensão
20 de dezembro de 2017
Esta atualização contém duas mudanças relacionadas à API YouTube Reporting:
-
O servidor de API agora oferece suporte à compactação gzip para solicitações que fazem o download de 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 seu aplicativo precise de mais tempo de CPU para descompactar as respostas da API, o benefício de consumir menos recursos de rede geralmente supera esse custo.
Para receber uma resposta codificada em gzip, defina o cabeçalho da 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 de documentação e não reflete uma mudança na funcionalidade ou no comportamento da API. Especificamente, os seguintes valores mudaram:- Os valores para a 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 hifens. Dessa forma, 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 para a 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 compatibilidade com uma nova métrica, chamada estimatedRevenue
, que fornece os mesmos dados.
Como a métrica earnings
era a principal, ela foi aceita por um ano a partir da data do anúncio. Agora que esse período de fim de ano terminou, a métrica earnings
não é mais compatí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 da earnings
, faça isso o quanto antes.
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, para o qual todas as métricas que estão sendo consultadas estão disponíveis.
Por exemplo, se uma solicitação especificar uma data de término em 5 de julho de 2017 e os valores de todas as métricas solicitadas estiverem disponíveis somente até 3 de julho de 2017, essa será a última data em que os dados serão incluídos na resposta. Isso acontecerá mesmo se os dados para algumas das métricas solicitadas estiverem disponíveis a partir de 4 de julho de 2017.
-
A dimensão
adType
agora é compatível com o valorreservedBumperInstream
, que se refere a um anúncio em vídeo não pulável de até seis segundos que é reproduzido antes de um vídeo ser visualizado. O formato do anúncio é idêntico ao doauctionBumperInstream
, mas esse tipo se refere a anúncios vendidos de forma reservada, e não a um leilão.
-
-
API YouTube Reporting (relatórios em massa)
-
Agora, a dimensão
ad_type
é compatível com o valor20
, que se refere a anúncios bumper vendidos de forma reservada. Os anúncios bumper são anúncios em vídeo não puláveis de até seis segundos que são reproduzidos antes da visualização do vídeo. O valor19
para essa dimensão também se refere a anúncios bumper que são vendidos em um leilão em vez de reservados. -
Os jobs de geração de relatórios dos 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 obsoletos em 15 de setembro de 2016 e não foram mais gerados para eles 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 estavam disponíveis desde 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 necessários.
-
24 de maio de 2017
Todos os jobs de geração de relatórios dos 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 obsoletos em 22 de junho de 2016 e não foram mais gerados para eles 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 estavam disponíveis desde 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 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) para diferenciá-lo mais claramente do valor73
(Kakao Story). Essa mudança não reflete nenhuma mudança no comportamento da API nem na classificação dos vídeos compartilhados com esses serviços.
- A dimensão
-
API YouTube Analytics (consultas segmentadas)
- A dimensão
sharingService
agora é compatível com os seguintes valores:YOUTUBE_GAMING
YOUTUBE_KIDS
YOUTUBE_MUSIC
YOUTUBE_TV
- A dimensão
28 de março de 2017
Proprietários de canais que podem acessar os dados de receita pelo YouTube Analytics no Estúdio de Criação agora também podem acessar esses dados usando a API YouTube Analytics:
-
A API oferece suporte às 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 recuperar um Relatório de desempenho de anúncios, que suporta as dimensões
adType
eday
, respectivamente. -
O guia de exemplos de solicitações da API YouTube Analytics agora inclui uma seção para relatórios de receita de canal.
17 de março de 2017
Esta atualização contém as seguintes alterações:
-
A API YouTube Analytics é compatível com as métricas
redViews
eestimatedRedMinutesWatched
, ambas relacionadas às visualizações do YouTube Red. Na verdade, a API já ofereceu suporte a essas métricas por algum tempo. Já a API YouTube Reporting já é compatível com as duas métricas anunciadas em 15 de setembro de 2016.- A métrica
redViews
identifica o número de vezes que um vídeo foi visto pelos assinantes do YouTube Red. - A métrica
estimatedRedMinutesWatched
identifica o número de minutos que os assinantes do YouTube Premium assistiram a um vídeo.
A documentação de relatórios de 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. Eles são compatíveis com todos os relatórios que já tinham suporte às 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 00h00 horário do Pacífico e termina às 23h59 do horário do Pacífico no dia, mês e ano especificados. Dependendo da época do ano, o horário do Pacífico é UTC-7 ou UTC-8.Normalmente, as datas representam um período de 24 horas, as datas em que os relógios são ajustados para a frente representam um período de 23 horas e as datas em que os relógios são ajustados para trás representam um período de 25 horas. Anteriormente, a documentação dizia que cada data representava um período exclusivo 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.
- Agora, a dimensão
operating_system
, que identifica o sistema de software do dispositivo em que as visualizações ocorreram, é compatível com os seguintes valores:22
: Tizen23
: Firefox24
: RealMedia
-
Todos os jobs de relatórios do tipo
content_owner_basic_a1
foram excluídos. Esse tipo de relatório foi totalmente suspenso 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 da geração. Por isso, alguns relatórios estavam disponíveis desde 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 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 00h00 horário do Pacífico e termina às 23h59 do horário do Pacífico no dia, mês e ano especificados. Dependendo da época do ano, o horário do Pacífico é UTC-7 ou UTC-8.Normalmente, as datas representam um período de 24 horas, as datas em que os relógios são ajustados para a frente representam um período de 23 horas e as datas em que os relógios são ajustados para trás representam um período de 25 horas. Anteriormente, a documentação dizia 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 canal foi atualizada para informar que os relatórios de canal não contêm métricas de ganhos ou de desempenho de anúncios no momento. Como resultado, o escopo
https://www.googleapis.com/auth/yt-analytics-monetary.readonly
não concede acesso a dados monetários em relatórios de canais no momento. - A dimensão
operatingSystem
é compatível com três novos valores: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 do proprietário do conteúdo.
O parâmetro permite que um proprietário do conteúdo indique que uma resposta da API deve incluir o tempo de exibição dos canais e os dados de visualização do período anterior ao momento em que os canais foram vinculados ao proprietário do conteúdo. O valor padrão do parâmetro é false
, o que significa que, por padrão, a resposta da API inclui apenas o tempo de exibição e os dados de visualização a partir do momento em que os canais foram vinculados ao proprietário do conteúdo.
Essas regras também se aplicam caso a solicitação de API recupere dados de vários canais:
- Se o valor do parâmetro for
false
, o tempo de exibição e os dados de visualizações retornados para qualquer canal têm como base a data em que o canal foi vinculado ao proprietário do conteúdo.
É importante lembrar que diferentes canais podem ter sido vinculados ao proprietário do conteúdo em datas diferentes. Se a solicitação de API estiver recuperando dados para vários canais e o valor do parâmetro forfalse
, a resposta da API conterá o tempo de exibição e os dados de visualização com base na data de vinculação de cada canal. - Se o valor do parâmetro for
true
, a resposta retornará o tempo de exibição e os dados de visualização para todos os canais com base nas datas de início e término especificadas na solicitação de API.
15 de dezembro de 2016
Os seguintes relatórios da API YouTube Reporting 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 anúncio de descontinuação desses relatórios foi feito em 15 de setembro de 2016.
-
Relatórios do canal
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 do proprietário 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ório 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:
-
Relatórios da tela final
- O relatório da tela final para vídeos do canal contém estatísticas de todos os vídeos.
- O relatório da tela final de vídeos do proprietário do conteúdo contém estatísticas sobre os vídeos de qualquer canal do proprietário.
- O relatório da tela final para recursos do proprietário do conteúdo contém estatísticas dos recursos associados aos vídeos. Depois disso, as telas finais serão exibidas.
-
Dimensões da tela final
end_screen_element_type
: o tipo de elemento de tela final associado às estatísticas.end_screen_element_id
: o ID que o YouTube usa para identificar de forma exclusiva 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 1o de maio de 2016.
end_screen_element_impressions
: o número total de impressões do elemento da tela final. Uma impressão é registrada para cada elemento da tela final exibido.end_screen_element_clicks
: o número de cliques em elementos da tela final.end_screen_element_click_rate
: a taxa de cliques dos elementos da tela final.
-
Os relatórios a seguir não são mais suportados e foram removidos da documentação. Uma versão mais recente de cada relatório está disponível. O anúncio 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
.
-
As métricas na lista a seguir foram totalmente suspensas e não são mais compatíveis. Conforme anunciado em 10 de agosto de 2016, já são compatíveis novas métricas referentes aos mesmos dados. A tabela abaixo mostra o nome da métrica obsoleta e o novo nome da métrica:
Métrica descontinuada Nova métrica adEarnings
estimatedAdRevenue
impressionBasedCpm
cpm
impressions
adImpressions
redPartnerRevenue
estimatedRedPartnerRevenue
- Receita mensal de anúncios em todo o mundo por vídeo
- Receita de publicidade diária por país, por vídeo
- Receita mensal de publicidade por recurso em todo o mundo
- Receita de publicidade diária por país, por recurso
- Reivindicações (este relatório não contém dados de receita)
-
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 visualizado por assinantes do YouTube Red.red_watch_time_minutes
: o número de minutos que um membro do YouTube Red assistiu um vídeo.
-
A API é compatível com 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 é um número maior do que o antigo. As versões antigas desses relatórios foram descontinuadas, conforme descrito posteriormente no 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 de 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 descontinuação.
Se você já tiver jobs para criar qualquer uma das versões mais antigas dos relatórios listados acima, precisará criar novos jobs para os relatórios renomeados. Em conjunto com o lançamento das novas versões de relatório, as seguintes versões de relatório 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 vagas em algum desses relatórios, o YouTube não deverá gerar novos relatórios após 15 de dezembro de 2016. Os relatórios gerados continuarão disponíveis por 180 dias a partir do momento em que foram gerados.
-
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, embora os relatórios que já foram gerados ainda estarão disponíveis por 180 dias a partir do momento em que foram gerados.A substituição do relatório
content_owner_basic_a1
é o relatóriocontent_owner_basic_a2
, conforme explicado na entrada do histórico de revisões de 19 de maio de 2016. -
Os Termos de Serviço dos serviços da API do YouTube recém-publicados ("Termos atualizados"), discutidos em detalhes no Blog de desenvolvedores e engenharia do YouTube, fornecem um amplo conjunto de atualizações aos Termos de Serviço atuais. Além dos Termos atualizados, em vigor a partir de 10 de fevereiro de 2017, essa atualização inclui vários documentos complementares para ajudar a explicar as políticas que os desenvolvedores precisam seguir.
O conjunto completo de novos documentos é descrito no histórico de revisões dos Termos atualizados. Além disso, alterações futuras nos Termos atualizados ou nos documentos de suporte também serão explicadas nesse histórico de revisões. Você pode se inscrever para receber atualizações de um feed RSS no histórico de revisões usando um link disponível no documento.
-
API YouTube Analytics (consultas segmentadas)
-
Observação: este é um anúncio de descontinuação.
As métricas na tabela a seguir estão sendo descontinuadas. Ao mesmo tempo, são introduzidas novas métricas referentes aos mesmos dados. Isso significa que as métricas antigas serão renomeadas, mas a API YouTube Analytics será compatível com os dois nomes de métrica até as datas de descontinuação listadas na tabela.
Nome da métrica antiga Novo nome da 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 Observe que a métrica
earnings
era uma métrica principal. Portanto, ela será compatível por um ano a partir da data deste aviso. 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 pode especificar a métrica
impressionBasedCpm
, acpm
ou ambas. No entanto, somente após essa data, a métricacpm
será aceita. - A dimensão
insightTrafficSourceType
aceita dois novos valores de dimensão:CAMPAIGN_CARD
: essa origem do tráfego só é compatível com relatórios de proprietário do conteúdo. 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 exibido.END_SCREEN
: os dados se referem às visualizações originadas da tela final de outro vídeo.
Para as duas novas origens de tráfego, também é possível recuperar um relatório
traffic source detail
. Em ambos os casos, a dimensãoinsightTrafficSourceDetail
identifica o vídeo a partir do qual o espectador foi indicado. -
A dimensão
adType
agora é compatível com o valorauctionBumperInstream
, que se refere a um anúncio em vídeo não pulável de até seis segundos que é reproduzido antes de um vídeo ser visualizado.
-
-
API YouTube Reporting (relatórios em massa)
- Agora, a dimensão
traffic_source_type
é compatível com os seguintes valores:19
: essa origem do tráfego só é compatível com relatórios de proprietário do conteúdo. 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 exibido.20
: os dados se referem às 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 que foi usado como referência para o espectador. -
A lista de métricas principais da API foi corrigida para listar
estimated_partner_revenue
como uma métrica principal e para 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é seis segundos. Eles são reproduzidos antes da visualização do vídeo.
- Agora, a dimensão
-
API YouTube Analytics (consultas segmentadas)
- As listas de métricas compatíveis com os seguintes relatórios de canal foram atualizadas para incluir métricas de cartão. Na verdade, o suporte para as métricas do cartão nesses relatórios foi adicionado em 28 de junho de 2016, e a entrada do histórico de revisões dessa data explica a alteração em mais detalhes. Os relatórios são:
- Atividade básica do usuário em 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 assinante
- 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 para relatórios de retenção de público do canal e do proprietário do conteúdo para refletir que o filtro
video
é obrigatório e não é compatível comgroup
.Anteriormente, a documentação de ambos os relatórios declarava incorretamente que era possível recuperar o relatório usando um desses dois filtros ou nenhum dos filtros.
- As listas de métricas compatíveis com os seguintes relatórios de canal foram atualizadas para incluir métricas de cartão. Na verdade, o suporte para as métricas do cartão nesses relatórios foi adicionado em 28 de junho de 2016, e a entrada do histórico de revisões dessa data explica a alteração 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 declarar que o YouTube gera relatórios disponíveis para download nos dias que não tinham dados disponíveis. Esses relatórios contêm uma linha de cabeçalho, mas não dados adicionais. Essas informações já foram 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
. Anteriormente, a documentação listava incorretamente o nome da dimensão comocard_title
.
- Estatísticas básicas (canais, proprietários do conteúdo)
- Com base no tempo (canais, proprietários do conteúdo)
- Região do usuário (canais, proprietários do conteúdo)
- Atividade do usuário por status de inscrição (canais, proprietários do conteúdo)
- Vídeos mais acessados (canais, proprietários do 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 por essa API por 180 dias a partir do momento em que são gerados.
Anteriormente, a documentação afirmou que os relatórios estavam disponíveis por um período de até 180 dias antes da data de envio da solicitação de API. Embora também tecnicamente verdadeiro, o texto original era, na melhor das hipóteses, um pouco confuso.
-
A API é compatível com novas versões de três relatórios. Dois 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 recém-renomeado é idêntico à versão anterior. -
Dois relatórios com novas versões foram renomeados:
- A nova versão do relatório
content_owner_estimated_earnings_a1
é chamada decontent_owner_estimated_revenue_a1
. - A nova versão do relatório
content_owner_asset_estimated_earnings_a1
é chamada decontent_owner_asset_estimated_revenue_a1
.
Os dois relatórios recém-renomeados diferem dos antecessores das seguintes maneiras:
- Ele adiciona a nova métrica
estimated_partner_red_revenue
, que estima o total de ganhos com as assinaturas do YouTube Red. - Ele adiciona a nova métrica
estimated_partner_transaction_revenue
, que estima a receita de transações, como conteúdo pago e financiamento por fãs, excluindo reembolsos cobrados por parceiros. - A métrica
estimated_partner_ad_sense_revenue
foi renomeada comoestimated_partner_ad_auction_revenue
. - A métrica
estimated_partner_double_click_revenue
foi renomeada comoestimated_partner_ad_reserved_revenue
.
- A nova versão do relatório
Se você já tiver jobs para criar as versões mais antigas desses relatórios, precisará criar 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 vagas em algum desses relatórios, o YouTube não deverá gerar novos relatórios após 22 de setembro de 2016. Os relatórios gerados continuarão 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. Isso é apenas uma correção de 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 serão descontinuados com essa atualização. Conforme descrito acima, essa métrica foi renomeada comoestimated_partner_ad_auction_revenue
nas versões mais recentes desses relatórios. - O nome da métrica
estimated_partner_doubleclick_revenue
foi atualizado paraestimated_partner_double_click_revenue
. Mais uma vez, essa métrica só aparece em dois relatórios que terão o uso suspenso com essa atualização. Conforme descrito acima, essa métrica foi renomeada comoestimated_partner_ad_reserved_revenue
nas versões mais recentes desses relatórios.
- O nome da métrica
-
A documentação de dimensões para a 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 os relatórios disponíveis pela API. -
A API é compatível com uma nova versão do relatório de atividade do usuário para proprietários de conteúdo. O ID do novo relatório é
content_owner_basic_a2
. Diferentemente 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 precisará criar um novo job para ocontent_owner_basic_a2
. O YouTube não está migrando automaticamente os proprietários do conteúdo para a nova versão do relatório nem criando automaticamente um job para gerar a nova versão do relatório. Em algumas implementações, a aparência de um job novo e inesperado pode ser uma alteração interruptiva.Além do lançamento do novo relatório, o uso do relatório
content_owner_basic_a1
foi suspenso. Se você tiver um job para esse relatório, o YouTube não deverá gerar novos relatórios após 19 de agosto de 2016. Os relatórios gerados continuarão disponíveis por 180 dias a partir do momento em que foram gerados. -
Os recursos
reportType
,job
ereport
são compatíveis com 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. Esta propriedade só tem um valor para relatórios que foram anunciados como descontinuados, e o valor representa a data em que o YouTube deixará 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 em 19 de maio de 2016 anuncia a descontinuação do relatório
content_owner_basic_a1
. Portanto, odeprecateTime
para esse tipo de relatório especifica um horário em 19 de agosto de 2016. Depois disso, o YouTube deixará 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. Esta propriedade tem um valor se o tipo de relatório associado ao job tiver sido descontinuado ou se os relatórios gerados para o job não forem salvos por um período prolongado. A data marca o tempo após o qual o YouTube não vai mais gerar novos relatórios para a vaga. -
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 fazem com que uma solicitação de API falhe. -
O YouTube agora gera dados referentes ao período de 180 dias anterior ao horário em que um job de geração de relatórios foi programado pela primeira vez. Antes, a API Reporting não informava dados históricos. Essa mudança afeta todos os jobs, incluindo os criados antes deste aviso.
Os relatórios históricos são publicados assim que ficam disponíveis, mas leva cerca de um mês para que todos os dados históricos sejam postados para uma vaga. Assim, um mês após programar um trabalho de relatório, você terá acesso a cerca de sete meses de dados. Todos os dados históricos das vagas criadas antes deste aviso vão ser postados até um mês após o comunicado.
Os dados históricos estão disponíveis desde 1o 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 alterações:
-
Agora a documentação afirma que os relatórios estarão disponíveis por um período de 180 dias depois de serem gerados e, portanto, estarão disponíveis para download pelos clientes de API. Anteriormente, a documentação dizia que os relatórios estavam disponíveis por um período de até seis meses antes da data de envio da solicitação de API.
-
A documentação foi atualizada para refletir o fato de que a API agora gera relatórios para download nos dias em que não havia dados disponíveis. Esses relatórios conterão linhas de cabeçalho, mas não dados adicionais.
-
-
Em breve, a API YouTube Reporting será compatível com um conjunto de relatórios gerenciados automaticamente pelo sistema e que contêm dados de receita de publicidade ou de assinaturas do YouTube Premium. Os relatórios estarão disponíveis para os proprietários de conteúdo que já podem acessar os relatórios de receita disponíveis para download manualmente no Estúdio de Criação do YouTube. Assim, a nova funcionalidade da API fornecerá acesso programático a esses dados.
As seguintes mudanças de API estão sendo anunciadas agora para preparar o lançamento de 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 do conteúdo do YouTube, e os proprietários do conteúdo não podem modificar ou excluir as tarefas que criam esses relatórios. -
O novo parâmetro
includeSystemManaged
do métodojobs.list
indica se a resposta da API precisa 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ó poderá conter relatórios se os dados mais antigos do relatório forem anteriores ou na data especificada. Da mesma forma, o parâmetrostartTimeBefore
indica que a resposta da API só poderá conter relatórios se os dados mais recentes estiverem antes da data especificada.Diferentemente do parâmetro
createdAfter
do método, que pertence ao momento em que o relatório foi criado, os novos parâmetros pertencem 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 precisa incluir relatórios gerenciados pelo sistema. O valor padrão do parâmetro éfalse
.
-
- Na API YouTube Reporting, a dimensão
sharing_service
é compatível com os novos valores:82
: caixa de diálogo da atividade do sistema iOS83
: caixa de entrada do Google84
: Android Messenger
- Na API YouTube Analytics, a dimensão
sharingService
é compatível com os novos valores:ANDROID_MESSENGER
: Android MessengerINBOX
: caixa de entrada do GoogleIOS_SYSTEM_ACTIVITY_DIALOG
: caixa de diálogo da atividade do sistema iOS
- A dimensão
playback_location_type
aceita dois novos valores de dimensão:7
: os dados se referem às visualizações que ocorreram na página inicial ou à tela inicial do YouTube, no feed de inscrições do usuário ou em outro recurso de navegação do YouTube.8
: os dados se referem às visualizações que ocorreram diretamente na página de resultados da pesquisa do YouTube.
- A dimensão
traffic_source_type
agora é compatível com18
como um valor de dimensão. Esse valor indica que as exibições de vídeo se originaram de uma página que lista todos os vídeos em uma playlist. Esta origem é diferente do tipo de origem14
, que indica que as visualizações ocorreram enquanto o vídeo estava sendo reproduzido em uma playlist. - A dimensão
insightPlaybackLocationType
aceita dois novos valores de dimensão:BROWSE
: os dados se referem às visualizações que ocorreram na página inicial ou à tela inicial do YouTube, no feed de inscrições do usuário ou em outro recurso de navegação do YouTube.SEARCH
: os dados se referem às visualizações que ocorreram diretamente na página de resultados da pesquisa do YouTube.
- A dimensão
insightTrafficSourceType
agora é compatível comYT_PLAYLIST_PAGE
como um valor de dimensão. Esse valor indica que as exibições de vídeo se originaram de uma página que lista todos os vídeos em uma playlist. Ela é diferente do tipo de origemPLAYLIST
, que indica que as visualizações ocorreram enquanto o vídeo estava sendo reproduzido como parte de uma playlist. - Na API YouTube Reporting, a dimensão
operating_system
usa o valor21
para identificar as visualizações que ocorrem pelo Chromecast. - Na API YouTube Analytics, a dimensão
operatingSystem
usa o valorCHROMECAST
para identificar as visualizações que ocorrem por meio do Chromecast. -
Agora, a API YouTube Analytics é compatível com três novas dimensões detalhadas de reprodução, que podem ser usadas em diversos relatórios de proprietários de canais e conteúdos:
liveOrOnDemand
: esta dimensão indica se os dados do relatório descrevem a atividade do usuário que ocorreu durante uma transmissão ao vivo.subscribedStatus
: esta dimensão indica se as métricas de atividade do usuário nos dados estão associadas a espectadores que se inscreveram no canal do vídeo ou da playlist.youtubeProduct
: essa dimensão identifica a propriedade do YouTube em que a atividade do usuário ocorreu. Os valores possíveis incluem o site ou app principal do YouTube, o YouTube Gaming e o YouTube Kids.
A documentação foi atualizada para identificar novos relatórios de detalhes de reprodução disponíveis para canais e proprietários do conteúdo. Além disso, muitos outros relatórios foram atualizados para mostrar 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 usadas 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 e youtubeProduct Métricas: Use um ou mais visualizações, estimatedMinutesWatched Filtros: Use 0 ou 1 país, província, continente, subcontinente Use 0 ou 1 vídeo, grupo Use 0 ou mais OperandSystem, liveOrOnDemand, subscribedStatus e 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.
-
A API YouTube Analytics agora descarta automaticamente as entidades em que o usuário da API não consegue recuperar dados de filtros compatíveis com vários valores (
video
,playlist
echannel
). Anteriormente, o servidor da API não retornava mais um erro se o usuário da API 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
lista 20 IDs de vídeo. O usuário é proprietário de 18 vídeos. No entanto, um ID de vídeo identifica um vídeo de outro canal e o outro identifica um vídeo que foi excluído e, portanto, não existe mais. Nesse caso, em vez de retornar um erro, o servidor de API agora descarta os dois vídeos que o usuário não pode acessar, e a resposta da API contém dados dos 18 vídeos de propriedade do usuário da API. -
Se você solicitar dados para um
group
do YouTube Analytics vazio, a API 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
) quando você tenta adicionar uma entidade a um grupo, mas não tem acesso a ela. Antes, a API permitia que você adicionasse a entidade ao grupo, mas posteriormente retornava um erro não autorizado quando você tentava recuperar os dados do 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 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. -
A API YouTube Analytics agora é compatível com a métrica
redPartnerRevenue
, que informa a receita total estimada gerada com as assinaturas do YouTube Premium para as dimensões de relatório selecionadas. O valor da métrica reflete os ganhos de conteúdo musical e não musical e está sujeito a ajustes no final do mês.A lista de relatórios do proprietário do conteúdo da API YouTube Analytics foi atualizada para identificar os relatórios de vídeo que aceitam a métrica
redPartnerRevenue
:- Estatísticas básicas
- Baseado no período do dia
- Região geográfica do usuário
- Principais vídeos: para este relatório,
redPartnerRevenue
também é aceito como uma métrica de classificação, o que significa que você pode recuperar uma lista de vídeos classificados pelos ganhos do YouTube Red.
-
A definição de relatório de principais vídeos para a API YouTube Analytics agora reflete que este relatório também suporta as seguintes métricas de ganhos:
earnings
,adEarnings
,grossRevenue
,monetizedPlaybacks
,playbackBasedCpm
,impressions
eimpressionBasedCpm
. -
A documentação da dimensão
date
da API YouTube Reporting foi corrigida para refletir que as datas fazem referência ao período de 24 horas que começa às 00h do horário do Pacífico (UTC-8). Anteriormente, a documentação dizia que a data começava à 0h (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 às datas que começam às 00h (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 somente deve listar relatórios criados após a data e a hora especificadas, incluindo novos relatórios com dados preenchidos. O valor do parâmetro pertence à hora em que o relatório é criado, e não às datas associadas aos dados retornados.O valor do parâmetro é um carimbo de data/hora no formato UTC "Zulu" RFC3339, 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 você pode usar o parâmetro
createdAfter
para 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 mostrar que os valores da propriedade são precisos em microssegundos, e 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. -
A documentação da dimensão
sharingService
da API YouTube Analytics foi atualizada para incluir uma lista de possíveis valores de dimensão. A lista inclui vários serviços recém-suportados.A definição da dimensão
sharing_service
da API YouTube Reporting também foi atualizada para listar os valores recém-aceitos. Os valores de enumeração maiores que59
são os novos da lista. -
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 é 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. Você pode agregar dados em linhas com base em valores de dimensão para calcular métricas para vídeos individuais, países, vídeos ao vivo, usuários inscritos etc.
Você pode usar a API para programar a geração de relatórios de jobs. Cada um deles identifica um relatório que o YouTube deve gerar. Depois que você configura uma vaga, 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 Reporting do YouTube permitem que os desenvolvedores recuperem dados do YouTube Analytics. Como as APIs fornecem acesso a conjuntos de dados semelhantes, a documentação das duas APIs está sendo publicada como um único conjunto de documentos.
- A guia Guias no conjunto de documentação contém informações comuns a ambas as APIs, incluindo instruções para autorização de 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 a documentação de referência e outros conteúdos específicos da API YouTube Analytics.
- A guia Exemplos lista os exemplos de código disponíveis para uma das duas APIs.
- A guia Ferramentas lista outros recursos disponíveis para ajudar os desenvolvedores a implementar uma das duas APIs.
-
A documentação da API foi reestruturada para facilitar o entendimento dela. Por isso, essas mudanças não descrevem novos recursos:
-
A documentação agora contém uma página que lista todos os relatórios de 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ídeo do canal, relatórios da playlist do canal e assim por diante.
-
A nova visão geral do modelo de dados busca fornecer uma introdução mais clara sobre como a API funciona. Especificamente, este documento tenta explicar melhor como o YouTube usa métricas, dimensões e filtros para calcular valores de relatório.
-
O método
reports.query
da API, que você usa para recuperar relatórios, agora está documentado separadamente. As informações dessa página já estavam em outras páginas. A nova página foi criada para ajudar você a identificar com mais facilidade as informações que precisa enviar para recuperar um relatório.
-
-
A nova métrica de
adEarnings
inclui o total de ganhos estimados (receita líquida) de todas as fontes de publicidade vendidas pelo Google. Não é uma métrica principal. A API é compatível com a métricaadEarnings
para todos os relatórios que já são compatíveis 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, bem como de fontes não publicitárias. Antes, a definição indicou 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 os dados de receita. -
Além da métrica
primaryAdGrossRevenue
descontinuada, os relatórios de desempenho do anúncio 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. -
Agora, a API é compatível com duas novas métricas para relatórios de vídeo:
videosAddedToPlaylists
evideosRemovedFromPlaylists
. As listas de relatórios de vídeos para canais e proprietários do conteúdo foram atualizadas para identificar os relatórios que suportam as novas métricas.videosAddedToPlaylists
– 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 do vídeo ou a playlists 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 do vídeo ou de outros canais.
As duas métricas incluem playlists padrão, como "Assistir mais tarde". No entanto, não contam as playlists às quais 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 também o número absoluto de adições e exclusões. Portanto, se um usuário adicionar um vídeo a uma playlist, removê-lo e adicioná-lo novamente, as métricas indicarão que o vídeo foi adicionado a duas playlists e removido de uma.
Os dados dessas métricas estão disponíveis desde 1o de outubro de 2014.
-
O uso das métricas
favoritesAdded
efavoritesRemoved
foi descontinuado a partir deste comunicado. Essas são as principais métricas e estão sujeitas à política de suspensão de uso estabelecida nos Termos de Serviço. -
O novo parâmetro
currency
permite recuperar métricas de ganhos em uma moeda diferente do dólar americano (USD
). Se o parâmetro for definido, a API converterá os valores das métricasearnings
,grossRevenue
,playbackBasedCpm
eimpressionBasedCpm
para a moeda especificada. Os valores retornados são estimativas calculadas com base nas taxas de câmbio que são alteradas diariamente.O valor do parâmetro é um código de moeda ISO 4217 com três letras. O valor padrão é
USD
. A definição do parâmetro contém uma lista de códigos de moeda suportados. -
Agora é possível criar e gerenciar grupos do YouTube Analytics com a API e recuperar dados de relatórios deles.
-
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 Google Analytics, uma coleção personalizada de até 200 canais, vídeos, playlists ou recursos. A API é compatível com os métodoslist
,insert
,update
edelete
. - O recurso
groupItem
representa um item em um grupo do Analytics. A API é compatível com os métodoslist
,insert
edelete
para esse recurso.
Por exemplo, você pode 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 de um grupo
A documentação de dimensões foi atualizada para incluir a dimensão
group
, que pode ser usada como um filtro para muitos relatórios de canais e relatórios do proprietário 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.
Consulte a Central de Ajuda do YouTube para mais informações sobre os grupos do YouTube Analytics.
-
-
A API não oferece mais suporte à dimensão
show
. -
A API agora oferece suporte à capacidade de 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 em que 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 será possível adicionar esse filtro à lista de dimensões especificada para a solicitação. Isso acontecerá mesmo que o filtro não esteja listado como uma dimensão compatível com um relatório específico. Se você adicionar o filtro à lista de dimensões, a API também usará os valores dele para agrupar os resultados.
Consulte a definição do parâmetro
filters
para ver todos os detalhes sobre essa funcionalidade. -
Ao recuperar um relatório de canal, agora você pode recuperar os dados do canal do usuário autenticado definindo o valor do parâmetro
ids
comochannel==MINE
. Você também pode definir o parâmetroids
comochannel==CHANNEL_ID
para recuperar dados do canal especificado. -
Agora, a API suporta relatórios de listas de reprodução, que contêm estatísticas relacionadas às exibições de vídeos que ocorrem no contexto de uma lista de reprodução. Os relatórios de playlists estão disponíveis para canais e proprietários do conteúdo.
Todos os relatórios de playlist são compatíveis com as métricas
views
eestimatedMinutesWatched
, e alguns também aceitam a métricaaverageViewDuration
.Além disso, todos os relatórios de playlist são compatíveis com as novas métricas a seguir. Cada uma dessas métricas reflete somente as visualizações de playlist 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 exibições de vídeo cada vez que uma playlist foi iniciada.averageTimeInPlaylist
: o tempo médio estimado, em minutos, que um espectador passou assistindo vídeos após o início da playlist.
Qualquer solicitação para recuperar um relatório de playlist precisa usar o filtro
isCurated
, que precisa ser definido como1
(isCurated==1
). -
Agora a API é compatível com um relatório de retenção de público. Esse relatório mede a capacidade de um vídeo de manter o público. A nova dimensão
elapsedVideoTimeRatio
do relatório mede a quantidade de vídeo decorrido dos valores de métrica correspondentes:-
A métrica
audienceWatchRatio
identifica a proporção absoluta de espectadores que assistem ao vídeo em um determinado ponto do vídeo. A proporção é calculada comparando o número de vezes que uma parte de um vídeo foi assistida ao número total de visualizações do vídeo.Uma parte de um vídeo pode ser assistida mais de uma vez (ou não) em uma determinada visualização. Por exemplo, se os usuários retrocederem e assistirem a mesma parte de um vídeo várias vezes, a proporção absoluta para essa parte do vídeo poderá ser maior que
1
. -
A métrica
relativeRetentionPerformance
mostra como um vídeo retém os 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 os espectadores pior do que qualquer outro vídeo com duração semelhante, enquanto um valor de 1 indica que o vídeo retém os espectadores melhor do que qualquer outro vídeo com duração semelhante. Um valor mediano de 0,5 indica que metade dos vídeos com duração semelhante retém os espectadores melhor que os outros.
Também é possível usar o filtro
audienceType
para que o relatório retorne somente 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 uma pesquisa por um vídeo ou um clique em um vídeo sugerido. -
-
A API é compatível com várias novas métricas relacionadas a anotações. As métricas listadas abaixo podem ser recuperadas com relatórios que eram compatíveis com as 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 poderiam 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 fundamentais e estão sujeitas à Política de descontinuação. No entanto, os dados foram disponibilizados para as novas métricas a partir de 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 defina o filtroinsightTrafficSourceType
comoGOOGLE_SEARCH
. -
O documento de relatórios do proprietário do conteúdo foi atualizado para refletir que as métricas
subscribersGained
esubscribersLost
agora podem ser recuperadas para um conteúdo reivindicado ou enviado por um proprietário do conteúdo.A mudança aparece no primeiro relatório de estatísticas básicas para proprietários de conteúdo, que agora é compatível com os filtros
claimedStatus
euploaderType
. -
O documento de solicitações de amostra foi reformulado para agrupar exemplos em categorias usando um formato de guia semelhante ao recém-lançado para relatórios de proprietário de canal e 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
- Mídias sociais
- Ganhos/anúncios (somente para relatórios do proprietário do conteúdo)
-
O documento de solicitações de amostra agora inclui novos exemplos de recuperação de dados específicos da província nos relatórios de canais ou de proprietários do conteúdo.
-
Métricas específicas por província para estados dos EUA e Washington D.C.: Esse relatório recupera o detalhamento de contagens de visualizações por província e outras estatísticas para vídeos de um canal. Os dados abrangem estados dos EUA e Washington D.C. O exemplo usa a dimensão
province
e também o parâmetrofilters
para restringir a resposta a somente incluir resultados para os Estados Unidos. -
Informações demográficas do público na Califórnia (idade e gênero): esse relatório recupera estatísticas sobre a idade e o gênero dos espectadores na Califórnia que assistiram aos vídeos de um canal ou, para relatórios do proprietário do conteúdo, sobre o conteúdo reivindicado do proprietário. Este exemplo usa o parâmetro
filters
para garantir que a resposta inclua apenas dados de uma província específica.
-
-
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
. -
Os documentos que listam os relatórios de canal e de proprietário do conteúdo compatíveis foram reformulados. Em vez de fornecer uma tabela listando 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
- Mídias sociais
- Vídeos mais acessados
Cada documento exibe essas categorias como uma lista de guias. Clique em qualquer guia para ver os relatórios compatíveis.
-
Agora, a API é compatível com três novas dimensões geográficas:
province
,continent
esubContinent
.-
A dimensão
province
permite recuperar estatísticas dos estados dos EUA e do Distrito da Colômbia. A API oferece suporte a 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 do conteúdo.
- O relatório de estatísticas principais fornece várias estatísticas, incluindo contagens de visualizações e estimativa de minutos assistidos.
- O relatório com base no tempo fornece as mesmas estatísticas, mas agrega dados com base diária, 7, 30 ou mensal.
-
É possível usar o parâmetro de consulta
filters
para restringir um relatório para conter apenas estatísticas para um estado específico. Vários relatórios são compatíveis com esse tipo de filtro, incluindo os geográficos e de localização da reprodução, os relatórios de origem do tráfego e do dispositivo, além dos relatórios do sistema operacional e demográficos.
-
-
A dimensão
continent
especifica um código regional da ONU (UNN) que identifica um continente. Essa dimensão só pode ser usada como filtro. -
A dimensão
subContinent
especifica um código regional da ONU (UNN) que identifica uma sub-região de um continente. Essa dimensão só pode ser usada como filtro.Como cada sub-região está associada apenas a um continente, não é necessário usar também o filtro
continent
quando estiver usando o filtrosubContinent
. Na verdade, a API 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. -
A API YouTube Analytics agora está sujeita à política de suspensão de uso 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 descontinuação. As páginas de dimensões e métricas foram atualizadas para listar as principais 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.
-
A API agora oferece suporte a
EXTERNAL_APP
como valor da dimensãoinsightPlaybackLocationType
. Junto com essa atualização, desde 10 de setembro de 2013, as reproduções não são mais categorizadas como reproduçõesMOBILE
. No entanto, as reproduções feitas antes dessa data ainda são categorizadas com esse valor.Com essa atualização, as reproduções para dispositivos móveis agora são classificadas como
WATCH
,EMBEDDED
ouEXTERNAL_APP
, dependendo do tipo de aplicativo em que elas acontecem. -
A API agora oferece suporte a
PLAYLIST
como valor da dimensãoinsightTrafficSourceType
. O valor indica que as exibições de vídeo foram direcionadas de uma playlist. Anteriormente, essas visualizações eram classificadas usando a categoriaYT_OTHER_PAGE
da dimensão. -
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. -
A API agora oferece suporte a 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. Também é possível usar o filtrooperatingSystem
para restringir o relatório de tipo de dispositivo para conter apenas as estatísticas dos dispositivos com um sistema operacional específico, como Android ou iOS. -
O relatório
operatingSystem
permite recuperar contagens de visualizações e tempo de exibição estimado para diferentes sistemas operacionais, como Android, iOS, Linux, entre outros. Também é possível usar o filtrodeviceType
para restringir o relatório do sistema operacional para conter apenas as estatísticas de um tipo específico de dispositivo, como smartphones 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 que não são classificadas usando um dos outros valores da dimensão. -
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 relatório é o primeiro da segunda tabela da seção Relatórios de atividade do usuário e de ganhos.
-
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.
-
A API agora é compatível com a capacidade de recuperar métricas de tempo de exibição (
estimatedMinutesWatched
,averageViewDuration
eaverageViewPercentage
) em conjunto com outras métricas, incluindo métricas de visualização e de engajamento, de ganhos e de 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 são compatíveis com um filtro
country
opcional. -
Os proprietários do conteúdo agora podem recuperar esses relatórios usando qualquer uma das novas combinações
filter
a seguir. 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
-
-
-
O novo documento Exemplo de solicitações de API fornece exemplos que demonstram como recuperar muitos tipos diferentes de relatórios usando 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 oferece suporte aSUBSCRIBER
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 nesta origem de tráfego, o campoinsightTrafficSourceDetail
especificará o feed da página inicial ou outra página de onde as visualizações foram direcionadas. -
Agora, a API oferece suporte a duas novas métricas,
annotationClickThroughRate
eannotationCloseRate
, que estão relacionadas a interações do espectador com anotações mostradas durante seus vídeos. As listas de relatórios de canal e relatórios do proprietário do conteúdo foram atualizadas para identificar os relatórios que suportam as novas métricas.annotationClickThroughRate
: a proporção de anotações em que os espectadores clicaram com o número total de impressões de anotações clicáveis.annotationCloseRate
: a proporção de anotações que os espectadores fecharam em relação ao número total de impressões de anotação.
-
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 de acordo com o tipo de anúncio principal para as reproduções de vídeo que o relatório abrange, de parceiros do Google ou do DoubleClick.monetizedPlaybacks
– Número de reproduções que exibiram pelo menos uma impressão de anúncio.playbackBasedCpm
– Receita bruta estimada por mil reproduções.impressions
– Número de impressões de anúncios verificadas veiculadas.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 recupera ganhos ou métricas de desempenho de anúncios deve enviar um token de autorização que concede 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.
-
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. A amostra de código JavaScript é a mesma discutida em detalhes na documentação exemplo de aplicativo.
-
O Guia de referência da API agora apresenta o APIs Explorer, que permite chamar a API, ver a solicitação de API 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 em conformidade.
-
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.
-
-
O YouTube Analytics API agora está disponível para todos os desenvolvedores. É possível ativar a API para seu projeto, sem precisar solicitar o acesso, no painel Serviços em APIs console.
-
A nova seção Primeiros passos descreve os pré-requisitos e as etapas básicas para criar um aplicativo que usa o YouTube Analytics API.
-
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 do relatório serão agregados de modo que cada linha contenha dados de um período de sete dias.30DayTotals
: os dados do relatório serão agregados de modo que cada linha contenha dados de um período de 30 dias.month
: os dados do relatório serão agregados por mês.
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 dados usando uma dessas 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.
A API YouTube Reporting oferece suporte a três novos relatórios de tela final, além de novas dimensões e métricas. Os relatórios fornecem estatísticas de cliques e impressões das telas finais que são exibidas após a interrupção de um vídeo.
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 alterações na API YouTube Analytics:
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 da API gerenciados pelo sistema foram projetados para fornecer acesso programático aos dados que também estão disponíveis nos relatórios do Estúdio de Criação, disponíveis para download manualmente.
A visão geral dos relatórios gerenciados pelo sistema oferece uma visão geral dos novos relatórios e explica o processo de recuperação deles por meio da API. Esse processo é um pouco diferente do usado para recuperar relatórios em massa para o 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:
27 de setembro de 2016
Observação:este é um anúncio de descontinuação.
A métrica uniques
da API YouTube Analytics foi descontinuada. Essa não é uma métrica principal e poderá ser usada até 31 de outubro de 2016.
15 de setembro de 2016
Esta atualização contém as seguintes mudanças na API YouTube Reporting:
19 de agosto de 2016
Esta atualização contém a seguinte alteração na API YouTube Reporting:
11 de agosto de 2016
Esta atualização contém as seguintes alterações:
10 de agosto de 2016
Essa atualização inclui as seguintes alterações:
18 de julho de 2016
Essa atualização inclui as seguintes alterações:
28 de junho de 2016
A documentação da API YouTube Analytics foi atualizada para refletir o suporte para métricas de cartão em vários relatórios de canal e proprietário do conteúdo. As métricas recém-aceitas são:
As métricas são compatíveis com os seguintes tipos de relatório:
22 de junho de 2016
Esta atualização contém as seguintes mudanças da API YouTube Reporting. A primeira alteração refere-se à API em geral, e as demais afetam somente os relatórios do proprietário do conteúdo:
19 de maio de 2016
Esta atualização contém as seguintes mudanças na API YouTube Reporting:
12 de abril de 2016
Esta atualização contém as seguintes alterações, que só afetam a API YouTube Reporting:
28 de março de 2016
As APIs YouTube Reporting e YouTube Analytics agora retornam estatísticas de visualização para vários outros serviços de compartilhamento.
16 de março de 2016
Esta atualização contém as seguintes alterações que afetam tanto a API YouTube Reporting quanto a API YouTube Analytics:
API YouTube Reporting
API YouTube Analytics
8 de fevereiro de 2016
A lista de métricas compatíveis com a API YouTube Analytics foi atualizada para que as métricas do cartão não sejam mais exibidas como métricas aceitas pela API. Nenhum dos relatórios dessa API foi documentado como compatível com as métricas do cartão.
Você ainda pode recuperar métricas do card usando a API YouTube Reporting, que aceita essas métricas para vários relatórios de canal e proprietário do conteúdo.
6 de janeiro de 2016
As APIs YouTube Reporting e YouTube Analytics agora identificam especificamente as visualizações que ocorrem em um dispositivo 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 que estão sendo retornados nos relatórios. Anteriormente, 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 divulgações sejam fornecidas e consentimentos recebidos dos usuários finais na UE. Portanto, os usuários finais na União Europeia precisam estar de acordo com a Política de consentimento para usuários da União Europeia. Adicionamos um aviso desse requisito aos nossos Termos de Serviço da API do YouTube.
15 de dezembro de 2015
Esta atualização contém as seguintes alterações, que afetam a API YouTube Analytics:
10 de novembro de 2015
Esta atualização contém as seguintes alterações:
29 de outubro de 2015
Esta atualização contém as seguintes alterações:
8 de outubro de 2015
Esta atualização contém as seguintes alterações:
24 de setembro de 2015
Esta atualização contém as seguintes alterações:
20 de agosto de 2015
Esta atualização contém as seguintes alterações:
22 de julho de 2015
Esta atualização contém várias mudanças, todas aplicáveis apenas aos proprietários de conteúdo:
1o de junho de 2015
Esta atualização contém as seguintes alterações:
31 de março de 2015
Esta atualização contém as seguintes alterações:
16 de março de 2015
Esta atualização contém as seguintes alterações:
25 de fevereiro de 2015
Esta atualização contém as seguintes alterações:
13 de fevereiro de 2015
Esta atualização contém as seguintes alterações:
28 de agosto de 2014
Esta atualização contém as seguintes alterações:
16 de julho de 2014
Esta atualização contém as seguintes alterações:
31 de janeiro de 2014
Esta atualização contém as seguintes alterações:
16 de janeiro de 2014
Esta atualização contém as seguintes alterações:
6 de janeiro de 2014
Esta atualização contém as seguintes alterações:
30 de setembro de 2013
Esta atualização contém as seguintes alterações:
16 de julho de 2013
Esta atualização contém as seguintes alterações:
23 de maio de 2013
Esta atualização contém as seguintes alterações:
10 de maio de 2013
Esta atualização contém as seguintes alterações:
06 de maio de 2013
Esta atualização contém as seguintes alterações:
03 de maio de 2013
Esta atualização contém as seguintes alterações:
28 de março de 2013
Esta atualização contém as seguintes alterações:
21 de março de 2013
Esta atualização contém as seguintes alterações:
04 de fevereiro de 2013
Esta atualização contém as seguintes alterações:
14 de novembro de 2012
Esta atualização contém as seguintes alterações:
02 de outubro de 2012
Esta atualização contém as seguintes alterações:
12 de setembro de 2012
Esta atualização contém as seguintes alterações: