Esta página lista os relatórios que os proprietários de canais podem recuperar com a API YouTube Analytics. Os relatórios de canal mostram métricas de atividade do usuário para um canal específico e medem itens como visualizações de vídeo, classificações e número de inscritos.
Os relatórios de vídeo mostram estatísticas de todas as atividades dos usuários relacionadas aos vídeos de um canal.
Os relatórios de playlists mostram estatísticas relacionadas especificamente às visualizações de vídeo que ocorrem no contexto de uma playlist.
Os relatórios de performance de anúncios contêm métricas relacionadas à receita e ao desempenho do anúncio. Eles usam a dimensão adType para agrupar métricas com base nos tipos de anúncios veiculados durante a reprodução de vídeo. A seção Relatórios de performance do anúncio explica os dois tipos de métricas de performance do anúncio com suporte da API.
Como recuperar um relatório
Para recuperar um relatório de canal, defina o valor do parâmetro ids na solicitação da API como um dos seguintes valores:
channel==MINE: a API retorna dados do canal do YouTube do usuário autenticado.
channel==CHANNEL_ID: defina CHANNEL_ID como o ID exclusivo do canal do canal para o qual você está extraindo dados. O usuário que autoriza a solicitação precisa ser o proprietário do canal.
No momento, o ID do canal é uma string que começa com as letras UC, mas o formato está sujeito a alterações. Você pode encontrar o ID do seu canal na página Configurações avançadas da conta do YouTube ou recuperá-lo por programação usando o método YouTube Data API'schannels.list.
Autorização
Todas as solicitações da API YouTube Analytics precisam ser autorizadas. O guia de autorização explica como usar o protocolo OAuth 2.0 para recuperar tokens de autorização.
As solicitações da API YouTube Analytics usam os seguintes escopos de autorização:
Visualizar os relatórios do YouTube Analytics para seu conteúdo do YouTube. Este escopo fornece acesso às métricas de atividade do usuário, como contagens de visualização e de classificação.
Visualizar os relatórios monetários do YouTube Analytics para seu conteúdo do YouTube. Esse escopo dá acesso às métricas de atividade do usuário e às métricas de receita estimada e performance do anúncio.
https://www.googleapis.com/auth/youtube
Gerenciar sua conta do YouTube. Na API YouTube Analytics, os proprietários de canais usam esse escopo para gerenciar grupos e itens de grupo do YouTube Analytics.
https://www.googleapis.com/auth/youtubepartner
Acessar e gerenciar recursos e conteúdo associado no YouTube. Na API YouTube Analytics, os proprietários de conteúdo usam esse escopo para gerenciar grupos e itens de grupo do YouTube Analytics.
Observação:no momento, as métricas de performance de anúncios e receita estimada não são compatíveis com os relatórios de canal. Por isso, o escopo https://www.googleapis.com/auth/yt-analytics-monetary.readonly não concede acesso a dados monetários nesses relatórios.
Filtros
As tabelas que explicam os relatórios compatíveis identificam os filtros que podem ser usados em cada um deles. Nas tabelas, os filtros entre parênteses são opcionais. Por exemplo, para a opção de filtragem video(,country), o filtro vídeo é obrigatório, e o filtro país é opcional.
A API também oferece suporte à capacidade de especificar vários valores para os filtros video e playlist. Se você especificar vários valores para um desses filtros, também poderá adicionar esse filtro à lista de dimensões especificada para a solicitação. Isso é válido mesmo que o filtro não esteja listado como uma dimensão compatível com um relatório específico.
Consulte a definição do parâmetro filters para uma explicação completa sobre como filtrar os resultados da API para um valor ou conjunto de valores específico.
Sobre as tabelas de relatórios
Esta seção explica a formatação e a terminologia usadas nas tabelas que definem os relatórios compatíveis com a API. A tabela a seguir lista as dimensões, métricas e filtros compatíveis com o
Relatório de detalhes de reprodução de vídeo usando a dimensão de tempo e a métrica averageViewPercentage.
A tabela contém duas linhas para dimensões, uma para métricas e três para filtros. Para dimensões e filtros, os valores de cada linha podem ser combinados em uma solicitação de API, desde que a combinação siga as regras de uso na tabela. Por exemplo, os valores de parâmetro dimensions válidos para esse relatório incluem:
dimensions=day
dimensions=day,subscribedStatus
dimensions=month,subscribedStatus,youtubeProduct
dimensions=month,youtubeProduct
No entanto, o valor do parâmetro day,month é inválido porque usa duas dimensões baseadas em tempo, e a solicitação precisa usar 0 ou 1.
Terminologia da tabela de relatórios
As tabelas usam a seguinte terminologia para indicar se as dimensões são obrigatórias ou opcionais:
Estes termos significam que um valor é obrigatório:
Obrigatório:é necessário incluir o valor.
Usar exatamente 1:é necessário incluir um valor do grupo.
Usar um ou mais:é possível incluir qualquer valor do grupo, mas é necessário incluir pelo menos um.
Estes termos significam que um valor é opcional:
Opcional:você tem a opção de incluir o valor.
Usar 0 ou 1:você tem a opção de incluir um valor do grupo.
Usar 0 ou mais:você tem a opção de incluir qualquer valor ou todos os valores do grupo.
Relatórios de vídeo
Estatísticas básicas
Estatísticas básicas de atividade do usuário básica
Neste relatório, são exibidas as estatísticas relacionadas às ações dos usuários em um canal. É possível filtrar o relatório para retornar somente os dados de um vídeo ou país específicos.
Estatísticas básicas de atividade do usuário para os estados nos EUA
Neste relatório, são exibidas as estatísticas para um estado específico nos EUA ou para o Distrito de Columbia. Ele é compatível apenas com um subconjunto das métricas disponíveis no relatório de país específico descrito acima.
Atividade do usuário por país em períodos específicos
Neste relatório, são exibidas as estatísticas relacionadas às ações do usuário em um canal em intervalos de tempo específicos. É possível filtrar o relatório para retornar somente os dados de um vídeo ou país específicos.
Atividade do usuário em estados nos EUA em períodos específicos
Neste relatório, são exibidas as estatísticas relacionadas à atividade do usuário para um estado específico nos EUA ou para o Distrito de Columbia. Ele é compatível apenas com um subconjunto das métricas disponíveis no relatório de país específico descrito acima.
Neste relatório, são exibidas as estatísticas relacionadas à atividade do usuário em um canal para cada país. É possível filtrar o relatório para retornar somente os dados de um vídeo específico.
Neste relatório, são exibidas as estatísticas da atividade do usuário para estados nos EUA e para o Distrito de Columbia.
Para esse relatório, defina o valor do parâmetro filters como country==US.
Atividade do usuário por cidade (até 250 resultados)
Observação:esse relatório exige que você defina o parâmetro maxResults como um valor inteiro de 250 ou menos. Ao contrário da maioria dos outros relatórios, este relatório
também exige que você especifique um valor para o parâmetro de solicitação sort.
Este relatório mostra as estatísticas de atividade do usuário por cidade.
Este relatório mostra as estatísticas de atividade do usuário por área de mercado designada (DMA, na sigla em inglês). Para esse relatório,
defina o valor do parâmetro filters como country==US ou
filtre para uma província específica (estado dos EUA).
Os relatórios de detalhes da reprodução fornecem estatísticas relacionadas aos seguintes atributos de visualização:
A visualização foi de uma transmissão ao vivo ou de um vídeo sob demanda?
O espectador estava inscrito no canal do proprietário do vídeo?
Em qual produto do YouTube a visualização ocorreu?
Observação:a dimensão e o filtro liveOrOnDemand não podem ser usados com a métrica averageViewPercentage. Portanto, cada uma das subseções a seguir lista dois relatórios. Um relatório aceita a dimensão (e o filtro) liveOrOnDemand, e o outro aceita a métrica averageViewPercentage.
Atividade do usuário por status de inscrição
Esse relatório mostra as métricas de atividade do usuário para espectadores inscritos e não inscritos. As estatísticas podem ser agrupadas por período (dia ou mês), e o relatório também pode ser filtrado por país, continente ou subContinent.
Atividade do usuário por status de inscrição em províncias
Esse relatório mostra as métricas de atividade do usuário para espectadores inscritos e não inscritos nos estados dos EUA ou no Distrito de Columbia. Esse relatório tem menos métricas do que o anterior.
Detalhes da reprodução com dimensão de tempo opcional
A dimensão de tempo (dia ou mês) é opcional para esses relatórios porque, de qualquer forma, você precisa usar os parâmetros de solicitação startDate e endDate para especificar o período que o relatório vai abranger. Se presente, a dimensão indica que você quer que os dados no relatório sejam agregados por dia, mês etc.
Detalhes da reprodução com a dimensão de tempo opcional e estatísticas liveOrOnDemand
Esse relatório mostra estatísticas detalhadas sobre a reprodução em intervalos de tempo específicos. Ele aceita a dimensão (e o filtro) liveOrOnDemand.
Detalhes da reprodução com a dimensão de tempo opcional e a métrica averageViewPercentage
Esse relatório mostra estatísticas detalhadas sobre a reprodução em intervalos de tempo específicos. Ela oferece suporte à métrica averageViewPercentage.
O relatório a seguir é semelhante ao anterior. Ele adiciona suporte à métrica averageViewPercentage, mas não oferece suporte a liveOrOnDemand como uma dimensão ou um filtro.
Detalhes da reprodução por província com estatísticas liveOrOnDemand
Este relatório mostra estatísticas detalhadas de reprodução para os estados dos EUA e o Distrito de Columbia. Ele aceita a dimensão (e o filtro) liveOrOnDemand.
O relatório a seguir é semelhante ao anterior. Ele adiciona suporte à métrica averageViewPercentage, mas não oferece suporte a liveOrOnDemand como uma dimensão ou um filtro.
Detalhes do local da visualização (até 25 resultados)
Observação:para gerar esse relatório, é necessário definir o parâmetro maxResults como um valor inteiro de 25 ou menos. Ao contrário da maioria dos outros relatórios, esse relatório também exige que você especifique um valor para o parâmetro de solicitação sort.
Neste relatório, são exibidos os players de vídeo incorporados por meio dos quais foi gerado o maior número de visualizações ou o maior tempo de visualização para os vídeos de um canal.
Esse relatório agrega estatísticas de visualização com base na forma como os espectadores acessaram seu conteúdo
em vídeo. Por exemplo, ele identifica o número de visualizações que vieram de uma pesquisa no Google ou de
um link para um vídeo relacionado.
Observação:esse relatório vai retornar um erro se o produto de
# de vídeos consultados X # de dias no período exceder 50.000. Por exemplo, uma consulta
que recupera dados de 500 IDs de vídeo pode solicitar dados por um máximo de 100 dias. Para reduzir o
número de linhas que uma solicitação retorna, divida a consulta em várias consultas que especifiquem menos
vídeos ou defina períodos mais curtos.
Observação:para gerar esse relatório, é necessário definir o parâmetro maxResults como um valor inteiro de 25 ou menos. Ao contrário da maioria dos outros relatórios, esse relatório também exige que você especifique um valor para o parâmetro de solicitação sort.
Neste relatório, são agregadas as estatísticas de visualização com base nos referenciadores por meio dos quais foi gerado o maior número de visualizações para o conteúdo do canal. Os referenciadores são categorizados por tipo de origem do tráfego, e na definição da dimensão insightTrafficSourceDetail são identificadas as origens do tráfego para o qual o relatório está disponível. Por exemplo, se você definir o filtro insightTrafficSourceType como ADVERTISING, o relatório vai listar os tipos de anúncios que geraram mais visualizações ou tempo de exibição para o conteúdo do canal.
Nota: este relatório é compatível apenas com origens do tráfego específicas. As origens de tráfego VIDEO_REMIXES, NOTIFICATION, END_SCREEN, CAMPAIGN_CARD, VIDEO_REMIXES e NO_LINK_EMBEDDED são algumas das que não são compatíveis.
Tipo de dispositivo e sistema operacional
Tipo de dispositivo
Neste relatório, são agregadas as estatísticas de visualização com base na forma como os espectadores chegaram ao conteúdo de seu vídeo. Por exemplo, ele identifica o número de visualizações que ocorreram em dispositivos móveis ou consoles de jogos.
Neste relatório, são agregadas as estatísticas de visualização com base nos sistemas operacionais dos espectadores. Por exemplo, nele é identificado o número de visualizações que ocorreram em dispositivos Android ou em PlayStations.
Neste relatório, são agregadas as estatísticas de visualização com base nos sistemas operacionais e nos tipos de dispositivo dos espectadores. Por exemplo, nele é identificado o número de visualizações que ocorreram em tablets Android ou em computadores com Windows.
Por exemplo, um relatório que usa a dimensão subscribedStatus retorna dados de viewerPercentage que somam 100% para visualizações de inscritos e dados de viewerPercentage que somam 100% para visualizações de não inscritos. O valor total de todos os campos viewerPercentage no relatório é 200%.
É possível usar filtros para garantir que o relatório contenha apenas dados de viewerPercentage para um valor (ou combinação de valores) nas dimensões de detalhes de reprodução.
Engajamento e compartilhamento de conteúdo
Neste relatório, são exibidas as estatísticas da frequência em que vídeos do canal foram compartilhados em diferentes plataformas sociais.
Esse relatório mede a capacidade de um vídeo de reter o público e também mostra com que frequência partes específicas de um vídeo foram assistidas. A dimensão elapsedVideoTimeRatio mede
o tempo decorrido do vídeo para os valores de métrica correspondentes. As métricas podem
ser divididas em duas categorias:
Retenção de público
Essas métricas mostram o quanto o vídeo consegue manter o público assistindo.
audienceWatchRatio é uma proporção que compara o número de vezes que uma
parte de um vídeo foi assistida com o número total de visualizações do vídeo.
relativeRetentionPerformance mostra o quanto um vídeo retém os espectadores
durante as reproduções em comparação com outros vídeos do YouTube de duração semelhante.
Estatísticas granulares do relógio
Essas métricas fornecem informações sobre a frequência com que partes específicas de um vídeo foram assistidas.
startedWatching indica com que frequência os espectadores começaram a assistir um vídeo
durante um determinado trecho do vídeo.
stoppedWatching indica a frequência com que os espectadores pararam de assistir um vídeo
durante um determinado trecho do vídeo.
totalSegmentImpressions indica com que frequência um segmento específico do
vídeo foi visualizado.
Observação:este relatório não oferece suporte para especificar uma
lista de valores separados por vírgulas para o filtro video. O valor precisa especificar um único
ID de vídeo.
Espectadores simultâneos (para transmissões ao vivo)
Esse relatório mostra os espectadores simultâneos em uma determinada posição para um único vídeo transmitido ao vivo.
O filtro especifica o vídeo. A dimensão de posição geralmente representa um único minuto.
Observação:esses relatórios exigem que você defina o parâmetro maxResults como um valor inteiro de 200 ou menos. Os dados anteriores a 1º de janeiro de 2013 estão disponíveis apenas para os 10 vídeos mais assistidos. Ao contrário da maioria dos outros relatórios, esses relatórios também exigem que você especifique um valor para o parâmetro de solicitação sort.
Vídeos em alta com filtros regionais opcionais (até 200 resultados)
Esse relatório lista os vídeos mais assistidos do canal. O relatório pode ser filtrado para listar os principais vídeos por país, continente ou subContinent.
Neste relatório, são listados os vídeos mais acessados em um estado específico nos EUA ou no Distrito de Columbia. Ele é compatível apenas com um subconjunto das métricas disponíveis no relatório de país específico descrito acima.
Principais vídeos para espectadores inscritos ou não inscritos(<= 200 resultados)
Esse relatório lista os principais vídeos do canal para espectadores inscritos ou não inscritos. O relatório pode ser filtrado para listar os principais vídeos por país, continente ou subContinent. O relatório anterior permite que você extraia os vídeos mais assistidos em um determinado estado dos EUA para espectadores inscritos ou não inscritos, mas ele tem menos métricas do que este relatório.
Vídeos mais acessados por produto do YouTube (até 200 resultados)
Esse relatório lista os principais vídeos do canal e oferece suporte a detalhes de reprodução e filtros geográficos. Esse relatório é semelhante ao anterior, mas oferece suporte a menos métricas e adiciona suporte ao filtro youtubeProduct.
Principais vídeos com filtros de detalhes de reprodução (até 200 resultados)
Este relatório lista os principais vídeos do canal, filtrando por qualquer uma ou todas as dimensões de detalhes de reprodução: liveOrOnDemand, subscribedStatus e youtubeProduct. Ao contrário do relatório anterior, este é compatível com o filtro liveOrOnDemand e não é compatível com a métrica averageViewPercentage.
Os relatórios de playlist contêm métricas relacionadas à atividade do usuário em vídeos nas playlists do proprietário do canal. Há duas versões desses relatórios disponíveis, e, para cada um deles,
as seções a seguir contêm uma descrição de cada versão:
A guia Recomendada em cada seção descreve o formato de solicitação de API preferencial para
extrair o relatório correspondente. Os relatórios recomendados oferecem suporte a um conjunto mais amplo de métricas,
que inclui métricas de vídeo agregadas e
métricas na playlist. Esse formato de solicitação não usa a dimensão isCurated.
A guia Usar isCurated em cada seção descreve um formato de solicitação de API mais antigo em que a dimensão isCurated é necessária. Esses relatórios são compatíveis apenas com as métricas da playlist. A dimensão isCurated foi descontinuada para todos os relatórios. A observação de aviso abaixo
explica o cronograma de descontinuação.
A nota de aviso a seguir explica as mudanças entre as duas versões do relatório com mais detalhes.
Métricas de vídeo agregadas
Essas métricas fornecem informações sobre impressões e atividade do usuário que são agregadas para todos os vídeos
da playlist que também pertencem ao canal que a possui. As métricas de vídeos
de outros canais não são computadas na agregação. Como resultado, se um canal criar uma
playlist que contém apenas vídeos de outros canais, os relatórios dessas playlists não
vão mostrar valores para essas métricas.
Essas métricas refletem a atividade e o engajamento do usuário no contexto da página da playlist. Essas
métricas incluem visualizações de todos os vídeos da playlist, independentemente de qual canal é o proprietário, mas
só contam as visualizações que ocorreram no contexto da playlist.
Esse relatório mostra estatísticas relacionadas às interações dos usuários com os vídeos nas playlists
do canal. É possível filtrar o relatório para retornar apenas os dados de uma playlist específica.
Esse relatório mostra estatísticas relacionadas às interações dos usuários com os vídeos nas playlists
do canal. É possível filtrar o relatório para retornar apenas os dados de uma playlist específica.
Este relatório mostra as estatísticas de atividade das playlists nos estados dos EUA e no Distrito de Columbia.
Para esse relatório, você precisa filtrar os resultados para retornar dados apenas dos Estados Unidos.
Detalhes do local da visualização (até 25 resultados)
Observação:para gerar esse relatório, é necessário definir o parâmetro maxResults como um valor inteiro de 25 ou menos. Ao contrário da maioria dos outros relatórios, esse relatório também exige que você especifique um valor para o parâmetro de solicitação sort.
Esse relatório identifica os players de vídeo incorporados que geraram mais visualizações ou tempo de exibição
para os vídeos nas playlists do canal.
Esse relatório agrega estatísticas de visualização com base em como os espectadores acessaram o conteúdo da playlist.
Por exemplo, ele identifica o número de visualizações que vieram de uma pesquisa no Google.
Observação:esse relatório exige que você defina o parâmetro maxResults
como um valor inteiro de 25 ou menos. Ao contrário da maioria dos outros relatórios, este relatório
também exige que você especifique um valor para o parâmetro de solicitação sort.
Esse relatório agrega estatísticas de visualização com base nos sites de referência que geraram mais visualizações
para os vídeos nas playlists do canal. Os referenciadores são categorizados por tipo de origem de tráfego, e
a definição da dimensão insightTrafficSourceDetail identifica as origens de tráfego para
as quais o relatório está disponível.
Por exemplo, se você definir o filtro insightTrafficSourceType
como ADVERTISING, o relatório vai listar os tipos de anúncios que geraram mais
visualizações ou tempo de exibição para as playlists do canal.
Nota: este relatório é compatível apenas com origens do tráfego específicas. As origens de tráfego VIDEO_REMIXES, NOTIFICATION, END_SCREEN, CAMPAIGN_CARD, VIDEO_REMIXES e NO_LINK_EMBEDDED são algumas das que não são compatíveis.
Tipo de dispositivo e sistema operacional
Tipo de dispositivo
Esse relatório agrega estatísticas de visualização com base em como os espectadores acessaram os vídeos nas suas
playlists. Por exemplo, ele identifica o número de visualizações que ocorreram em dispositivos móveis ou consoles de
jogos.
Neste relatório, são agregadas as estatísticas de visualização com base nos sistemas operacionais dos espectadores. Por exemplo, ele
identifica o número de visualizações que ocorreram em dispositivos Android ou PlayStations.
Neste relatório, são agregadas as estatísticas de visualização com base nos sistemas operacionais e nos tipos de dispositivo dos espectadores.
Por exemplo, ele identifica quantas visualizações ocorreram em tablets Android ou dispositivos desktop Windows.
Observação:os valores de viewerPercentage neste relatório não são normalizados para valores diferentes da dimensão de detalhes de reprodução subscribedStatus.
Por exemplo, um relatório que usa a dimensão subscribedStatus retorna dados de viewerPercentage que somam 100% para visualizações de inscritos e dados de viewerPercentage que somam 100% para visualizações de não inscritos. O valor total de todos os campos viewerPercentage no relatório é 200%.
Você pode usar filtros para garantir que o relatório contenha apenas dados de viewerPercentage para um valor das dimensões subscribedStatus.
Playlists mais acessadas
Observação:esses relatórios exigem que você defina o parâmetro maxResults como um valor inteiro de 200 ou menos. Os dados anteriores a 1º de janeiro de 2013 estão disponíveis apenas para as 10 principais playlists. Ao contrário da maioria dos outros relatórios, esses relatórios também exigem que você especifique um valor para o parâmetro de solicitação sort.
Esse relatório lista as principais playlists do canal com base nos critérios de filtragem e classificação especificados.
Observação:os relatórios de performance de anúncios exigem um token de autorização que conceda acesso ao escopo https://www.googleapis.com/auth/yt-analytics-monetary.readonly.
Os relatórios de performance dos anúncios fornecem métricas baseadas em impressões para anúncios veiculados durante a reprodução de vídeos. Essas métricas representam cada impressão de anúncio, e cada reprodução de vídeo pode gerar várias impressões.
As métricas de performance de anúncios com base em impressões são:
Além disso, alguns relatórios de vídeo oferecem suporte às seguintes métricas de performance de anúncios com base na reprodução: No entanto, essas métricas não são incluídas nos relatórios de performance do anúncio.
