Este documento define as dimensões compatíveis com a API YouTube Analytics. Essa API oferece suporte a consultas segmentadas em tempo real para gerar relatórios personalizados do YouTube Analytics.
As dimensões são critérios comuns usados para agregar dados, como a data em que a atividade do usuário ocorreu ou o país em que os usuários estavam localizados.
Cada relatório de consulta identifica as dimensões compatíveis. Por exemplo, ao recuperar a atividade do usuário por tempo, você escolhe o período em que os dados serão informados: dia ou mês. Em qualquer relatório, cada linha de dados tem uma combinação exclusiva de valores de dimensão.
Para recuperar um relatório de consulta, chame o método reports.query
da API YouTube Analytics. Na solicitação, use o parâmetro dimensions
para especificar as dimensões que o YouTube vai usar para calcular os valores das métricas nos relatórios.
Dimensões principais
Embora a API YouTube Analytics esteja sujeita à Política de descontinuação definida nos Termos de Serviço, as dimensões e métricas não principais não estão sujeitas a ela. Nas definições desta página, qualquer dimensão que seja principal é identificada explicitamente como tal.
A lista a seguir identifica as dimensões principais da API.
Para mais informações, consulte a lista de APIs do YouTube sujeitas à política de descontinuação.
Filtros
Todos os relatórios de consulta são compatíveis com filtros. Os filtros identificam os valores de dimensão que precisam estar presentes no conjunto de dados recuperado. Por isso, eles limitam a resposta de uma API para incluir apenas dados que correspondem a um valor ou conjunto de valores específico. Por exemplo, em vez de extrair métricas de atividade do usuário de todos os países, você pode usar um filtro para extrair apenas dados de um país específico.
Em uma solicitação para recuperar um relatório de consulta, o parâmetro de solicitação filters
opcional especifica os valores de dimensão para os quais você quer filtrar os dados. Por exemplo, para extrair as métricas de atividade do usuário na Europa, defina o valor do parâmetro filters
como continent==150
.
Importante:as solicitações de API para recuperar relatórios do proprietário de conteúdo precisam filtrar dados usando uma das dimensões da entidade de relatórios ou uma combinação compatível das dimensões claimedStatus
e uploaderType
.
Dimensões
As seções a seguir definem as dimensões usadas nos relatórios de consulta da API do YouTube Analytics. A menos que indicado de outra forma, essas dimensões são usadas nos relatórios de canal e de proprietário de conteúdo. As dimensões que só podem ser usadas como filtros também são identificadas.
Recursos
Essas dimensões correspondem aos recursos que os canais e proprietários de conteúdo gerenciam no YouTube:
Observação:a API permite especificar vários valores para as dimensões video
, playlist
e channel
quando elas são usadas como filtros. Para isso, defina o valor do parâmetro filters
como uma lista separada por vírgulas dos IDs de vídeo, playlist ou canal para os quais a resposta da API precisa ser filtrada. O valor do parâmetro pode especificar até 500 IDs.
- vídeo (dimensão principal)
- O ID de um vídeo do YouTube. Na API Data do YouTube, esse é o valor da propriedade
id
de um recursovideo
. This is a core dimension and is subject to the Deprecation Policy. - playlist
- O ID de uma playlist do YouTube. Na API Data do YouTube, esse é o valor da propriedade
id
de um recursoplaylist
. - canal (dimensão principal) (usado apenas em relatórios de proprietários de conteúdo)
- O ID de um canal do YouTube. Na API Data do YouTube, esse é o valor da propriedade
id
de um recursochannel
. This is a core dimension and is subject to the Deprecation Policy.
A dimensãochannel
é usada com frequência nos relatórios de proprietários de conteúdo porque eles geralmente agregam dados de vários canais. - group (somente filtro)
- O ID de um grupo do YouTube Analytics. É possível recuperar esse valor usando o método
groups.list
da API YouTube Analytics. Quando você usa o filtrogroup
, a resposta da API contém dados de todos os vídeos, playlists ou canais desse grupo.
Exemplos
As solicitações de exemplo a seguir usam dimensões ou filtros de entidade de relatórios:
Exemplos de canais
-
Estatísticas básicas
- 10 mais – Vídeos mais assistidos para um canal
- Top 10: taxas de cliques em anotações dos vídeos mais visualizados de um canal
- Estatísticas de uma playlist específica
- Top 10: playlists mais assistidas de um canal
-
Geográfica
- 10 mais – Vídeos mais visualizados em um país específico
- Top 10: vídeos mais assistidos na Europa
-
Estatísticas básicas
Exemplos de proprietários de conteúdo
-
Estatísticas básicas
- Top 10: vídeos mais assistidos de um proprietário do conteúdo
- Os 10 vídeos mais assistidos de um proprietário de conteúdo
- Os 10 vídeos mais acessados do canal de um proprietário de conteúdo
- Top 10: taxas de cliques em anotações dos vídeos mais visualizados de um canal
- Top 10: playlists mais assistidas de um proprietário de conteúdo
-
Geográfica
- Os 10 vídeos mais assistidos na Europa de um proprietário de conteúdo
- Top 10: playlists mais iniciadas nos Estados Unidos
-
Estatísticas básicas
Áreas geográficas
Essas dimensões identificam uma região geográfica associada à atividade do usuário, à performance do anúncio ou às métricas de receita estimada.
- country (dimensão principal)
- O país associado às métricas na linha do relatório. O valor da dimensão é um código de país ISO-3166-1 de duas letras, como
US
,CN
(China) ouFR
(França). O código de paísZZ
é usado para informar métricas em que o YouTube não conseguiu identificar o país associado. This is a core dimension and is subject to the Deprecation Policy. - province
- O estado ou território dos EUA associado às métricas na linha do relatório. O valor da dimensão é um código ISO 3166-2 que identifica um estado dos EUA ou o Distrito de Columbia, como
US-MI
(Michigan) ouUS-TX
(Texas). O código da provínciaUS-ZZ
é usado para informar métricas em que o YouTube não conseguiu identificar o estado dos EUA associado. Quando uma solicitação de API incluiprovince
no valor do parâmetrodimensions
, ela também precisa restringir os dados aos Estados Unidos, incluindocountry==US
no valor do parâmetrofilters
.Observação:essa dimensão não oferece suporte a valores ISO 3166-2 que identificam áreas periféricas dos EUA, já que esses territórios também têm seus próprios códigos de país ISO 3166-1. Ele também não oferece suporte a subdivisões de países diferentes dos Estados Unidos.
- dma
- O identificador de três dígitos que a Nielsen usa para identificar a área designada do mercado (DMA, na sigla em inglês) associada aos eventos de visualização descritos na linha de dados.
- city
- A cidade estimada associada às métricas na linha do relatório. Os dados dessa dimensão estão disponíveis para datas a partir de 1º de janeiro de 2022.
- continent (somente filtro)
-
Um código de região estatística das Nações Unidas (ONU). A API oferece suporte aos seguintes valores:
Valores 002
África 019
Américas (América do Norte, América Latina, América do Sul e Caribe) 142
Ásia 150
Europa 009
Oceania filters
comocontinent==REGION_CODE
, especificando um valorREGION_CODE
da tabela. - subContinent (somente filtro)
-
Um código de região estatística da ONU que identifica uma sub-região geográfica. A Divisão de Estatísticas das Nações Unidas lista as sub-regiões e os países associados a cada região.
Essa dimensão só pode ser usada para filtrar dados. Para usar essa dimensão, defina o valor do parâmetro
filters
comosubContinent==REGION_CODE
, especificando um valorREGION_CODE
da lista da ONU.
Exemplos
Os exemplos de solicitações a seguir usam dimensões ou filtros geográficos:
Exemplos de canais
- Estatísticas básicas: contagens de visualizações específicas para cada país (e mais) de um canal
-
Geográfica
- Métricas de tempo de exibição específicas de um país para vídeos de um canal
- Métricas de anotação específicas de um país para vídeos de um canal
- Métricas específicas de províncias para os estados dos EUA e Washington, D.C.
- Métricas de tempo de exibição específicas de cada país para as playlists de um canal
- Top 10: playlists mais iniciadas nos Estados Unidos
- Local da reprodução: contagens de visualizações diárias e tempo de exibição de diferentes locais de reprodução
- Origem de tráfego: visualizações e tempo de exibição de diferentes origens de tráfego em um país
- Informações demográficas: informações demográficas dos espectadores na Califórnia (faixa etária e gênero)
-
Vídeos mais acessados
- 10 mais – Vídeos mais visualizados em um país específico
- Top 10: vídeos mais assistidos na Europa
Exemplos de proprietários de conteúdo
- Estatísticas básicas: contagens de visualizações específicas para cada país (e mais) de todos os vídeos enviados por você
-
Geográfica
- Métricas do tempo de exibição específico de um país para o conteúdo enviado automaticamente
- Métricas de anotação específicas de um país para o conteúdo enviado automaticamente
- Métricas específicas de províncias para os estados dos EUA e Washington, D.C.
- Métricas de tempo de exibição específicas por país para as playlists de um proprietário de conteúdo
- Top 10: playlists mais iniciadas nos Estados Unidos
- Local da reprodução: contagens de visualizações diárias e tempo de exibição de diferentes locais de reprodução
- Informações demográficas: informações demográficas dos espectadores na Califórnia (faixa etária e gênero)
- Vídeos mais acessados: os 10 vídeos mais assistidos na Europa de um proprietário de conteúdo
- Receita/performance do anúncio: métricas de receita e performance do anúncio específicas do país
Períodos
Essas dimensões indicam que um relatório precisa agregar dados com base em um período, como um dia, uma semana ou um mês. Os parâmetros de solicitação startDate
e endDate
especificam o período em que o relatório inclui dados. O relatório retorna dados até o último dia em que todas as métricas especificadas na solicitação estão disponíveis no momento da consulta. Nos relatórios, as datas são listadas no formato YYYY-MM-DD
.
Importante: todas as datas se referem ao período que começa às 12h (UTC-7 ou UTC-8) e termina às 23h59 (horário do Pacífico) no dia, mês e ano especificados. Como resultado, as datas em que os relógios são ajustados para o horário de verão 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.
A dimensão mês se refere ao período que começa às 12h do horário do Pacífico (UTC-7 ou UTC-8) no primeiro dia do mês e ano especificado.
- dia (dimensão principal)
- Quando você usa essa dimensão, os dados no relatório são agregados diariamente, e cada linha contém dados de um dia. Você pode usar outras dimensões para detalhar ainda mais os dados. Por exemplo, um relatório de origem do tráfego pode agregar estatísticas de visualização diárias com base na forma como os usuários acessam seus vídeos. This is a core dimension and is subject to the Deprecation Policy.
- month (dimensão principal)
- Os dados no relatório são agregados por mês. Assim como acontece com relatórios diários, é possível usar outros filtros para segmentar os dados ainda mais. No relatório, as datas são listadas no formato
YYYY-MM
.
Observação:se a consulta da API usar a dimensãomonth
, os parâmetrosstart-date
eend-date
precisam ser definidos como o primeiro dia do mês. This is a core dimension and is subject to the Deprecation Policy.
Exemplos
As solicitações de exemplo a seguir usam dimensões ou filtros temporais:
Exemplos de canais
-
Baseado no tempo
- Métricas diárias de tempo de exibição para vídeos de um canal
- Métricas de anotação diárias para vídeos de um canal
- Visualizações diárias de playlists de um canal
- Local da reprodução: contagens de visualizações diárias e tempo de exibição de diferentes locais de reprodução
- Origem do tráfego: contagens de visualizações diárias e tempo de exibição de diferentes origens de tráfego
-
Dispositivo/SO
- Métricas diárias do tipo de dispositivo para o sistema operacional Android
- Métricas diárias do sistema operacional para dispositivos móveis
- Métricas diárias do sistema operacional e do tipo de dispositivo
-
Baseado no tempo
Exemplos de proprietários de conteúdo
-
Baseado no tempo
- Métricas diárias do tempo de exibição para o conteúdo enviado automaticamente
- Métricas de anotação para o conteúdo reivindicado
- Visualizações diárias de playlists de um proprietário de conteúdo
- Local da reprodução: contagens de visualizações diárias e tempo de exibição de diferentes locais de reprodução
- Origem do tráfego: contagens de visualizações diárias e tempo de exibição de diferentes origens de tráfego
-
Dispositivo/SO
- Métricas diárias do tipo de dispositivo para vídeos reivindicados
- Métricas diárias do sistema operacional para vídeos reivindicados visualizados em dispositivos móveis
- Métricas diárias do sistema operacional e do tipo de dispositivo
- Receita/performance do anúncio: métricas diárias de receita e performance do anúncio
-
Baseado no tempo
Locais de reprodução
Essas dimensões fornecem insights sobre a página ou o aplicativo em que a atividade do usuário ocorreu.
- insightPlaybackLocationType
-
Os dados no relatório são agregados com base no tipo de página ou aplicativo em que as reproduções de vídeo ocorreram. Os valores possíveis para essa dimensão são:
-
BROWSE
: os dados descrevem visualizações que aconteceram na página inicial ou na tela inicial do YouTube, no feed de inscrições do usuário ou em outro recurso de navegação do YouTube. -
CHANNEL
: os dados descrevem as visualizações que ocorreram na página de um canal. -
EMBEDDED
: os dados descrevem as visualizações que ocorreram em outro site ou aplicativo em que o vídeo foi incorporado usando um<iframe>
ou<object>
. -
EXTERNAL_APP
: os dados descrevem as visualizações que ocorreram em um app de terceiros em que o vídeo foi reproduzido usando um método diferente de incorporação<iframe>
ou<object>
. Por exemplo, as exibições em apps que usam a API YouTube Android Player seriam categorizadas usando esse valor. -
MOBILE
: os dados descrevem as visualizações que ocorreram no site para dispositivos móveis do YouTube ou em clientes aprovados da API do YouTube, incluindo dispositivos móveis.Desde 10 de setembro de 2013, as visualizações não são mais categorizadas como
MOBILE
nos relatórios do YouTube Analytics. O valor pode permanecer nos relatórios, já que os dados legados ainda se enquadram nessa categoria. No entanto, após essa data, as reproduções em dispositivos móveis são classificadas comoWATCH
,EMBEDDED
ouEXTERNAL_APP
, dependendo do tipo de aplicativo em que elas ocorrem. -
SEARCH
: os dados descrevem as visualizações que aconteceram diretamente na página de resultados da pesquisa do YouTube. -
WATCH
: os dados descrevem as visualizações que ocorreram na página de exibição do vídeo no YouTube ou em um aplicativo oficial do YouTube, como o app para Android. -
YT_OTHER
: os dados descrevem visualizações que não são classificadas.
-
- insightPlaybackLocationDetail
- Os dados são agregados com base na página em que o player está localizado. Esse relatório é suportado apenas por visualizações que ocorreram em players integrados e identifica os players integrados que geraram o maior número de visualizações de um vídeo especificado. Dessa forma, ele fornece uma visualização mais refinada do que o relatório de local de reprodução identificando os URLs ou os aplicativos associados aos principais players integrados.
Exemplos
Os seguintes exemplos de solicitação usam dimensões de local de reprodução:
Exemplos de canais
-
Local da reprodução
- Contagens de exibições e tempo de exibição de diferentes locais de reprodução
- Contagem de visualizações diárias e tempo de exibição em diferentes locais de reprodução
- 10 mais – Sites de terceiros que geram o maior número de visualizações para um vídeo incorporado
- Contagem de visualizações de playlist e tempo de exibição de diferentes locais de reprodução
- Contagem de visualizações diárias de playlists e tempo de exibição de diferentes locais de reprodução
-
Local da reprodução
Exemplos de proprietários de conteúdo
-
Local da reprodução
- Contagens de exibições e tempo de exibição de diferentes locais de reprodução
- Contagem de visualizações diárias e tempo de exibição em diferentes locais de reprodução
- 10 mais – Sites de terceiros que geram o maior número de visualizações para um vídeo incorporado
- Contagem de visualizações de playlist e tempo de exibição de diferentes locais de reprodução
- Contagem de visualizações diárias de playlists e tempo de exibição de diferentes locais de reprodução
-
Local da reprodução
Detalhes da reprodução
- creatorContentType
- Essa dimensão identifica o tipo de conteúdo associado às métricas de atividade do usuário na linha de dados. Os dados dessa dimensão estão disponíveis para datas a partir de 1º de janeiro de 2019.
A tabela a seguir lista os valores da dimensão:
Valores LIVE_STREAM
O conteúdo assistido foi uma transmissão ao vivo do YouTube. SHORTS
O conteúdo assistido foi um Short do YouTube. STORY
O conteúdo assistido foi um YouTube Story. VIDEO_ON_DEMAND
O conteúdo visualizado foi um vídeo do YouTube que não se enquadra em um dos outros valores de dimensão. UNSPECIFIED
O tipo de conteúdo visualizado é desconhecido. - liveOrOnDemand
- Essa dimensão indica se as métricas de atividade do usuário na linha de dados estão associadas a visualizações de uma transmissão ao vivo. Os dados dessa dimensão estão disponíveis para datas a partir de 1º de abril de 2014.
A tabela a seguir lista os valores da dimensão:
Valores LIVE
Os dados da linha descrevem a atividade do usuário que ocorreu durante uma transmissão ao vivo. ON_DEMAND
Os dados da linha descrevem a atividade do usuário que não ocorreu durante uma transmissão ao vivo. - subscribedStatus
- Essa dimensão indica se as métricas de atividade do usuário na linha de dados estão associadas a espectadores inscritos no canal do vídeo ou da playlist.
Os valores possíveis são
SUBSCRIBED
eUNSUBSCRIBED
.
O valor da dimensão é preciso a partir do momento em que a atividade do usuário ocorre. Por exemplo, suponha que um usuário não tenha se inscrito em um canal e assista um dos vídeos dele, depois se inscreva e assista outro vídeo, tudo no mesmo dia. O relatório do canal indica que uma visualização tem um valor desubscribedStatus
deSUBSCRIBED
e outra desubscribedStatus
deUNSUBSCRIBED
. - youtubeProduct
- Essa dimensão identifica o serviço do YouTube em que a atividade do usuário ocorreu. Os dados dessa dimensão estão disponíveis desde 18 de julho de 2015.
A tabela a seguir lista os valores da dimensão:
Valores CORE
A atividade do usuário que não ocorreu em um dos apps especializados do YouTube (YouTube Gaming, YouTube Kids ou YouTube Music). Exceção: a atividade do usuário que ocorreu no YouTube Music antes de 1º de março de 2021 está incluída em CORE
.GAMING
A atividade do usuário ocorreu no YouTube Gaming. KIDS
A atividade do usuário ocorreu no YouTube Kids. MUSIC
A atividade do usuário ocorreu no YouTube Music em ou após 1º de março de 2021. Os dados anteriores a 1º de março de 2021 estão incluídos em CORE
. Os dados em tempo real não são gravados.UNKNOWN
A atividade do usuário ocorreu antes de 18 de julho de 2015.
Origens de tráfego
- insightTrafficSourceType
- Os dados no relatório são agregados com base no tipo de referência, que descreve a maneira como os usuários acessaram o vídeo. Os valores possíveis para essa dimensão são:
ADVERTISING
: o espectador foi direcionado para o vídeo por um anúncio. Se você filtrar com base nessa origem de tráfego, o campoinsightTrafficSourceDetail
vai identificar o tipo de anúncio.ANNOTATION
: os espectadores acessaram o vídeo clicando em uma anotação em outro vídeo.CAMPAIGN_CARD
: visualizações originadas de vídeos reivindicados enviados por usuários que o proprietário do conteúdo usou para promover o conteúdo visualizado. Essa origem de tráfego só tem suporte para relatórios de proprietários de conteúdo.END_SCREEN
: as visualizações foram direcionadas da tela final de outro vídeo.EXT_URL
: as visualizações do vídeo foram geradas por um link em outro site. Se você filtrar com base nessa origem de tráfego, o campoinsightTrafficSourceDetail
vai identificar a página da Web. Essa origem de tráfego inclui referências dos resultados da Pesquisa Google.HASHTAGS
: visualizações originadas de páginas de hashtag de VOD ou de Shorts.LIVE_REDIRECT
: as visualizações do vídeo foram encaminhadas pelo Redirecionamento em tempo real.NO_LINK_EMBEDDED
: o vídeo foi incorporado em outro site quando foi visualizado.NO_LINK_OTHER
: o YouTube não identificou um referrer para o tráfego. Esta categoria engloba o tráfego direto a um vídeo, o tráfego de aplicativos móveis.NOTIFICATION
: as visualizações do vídeo foram encaminhadas por um e-mail ou notificação do YouTube.PLAYLIST
: as visualizações ocorreram enquanto o vídeo era reproduzido como parte de uma playlist. Ele inclui o tráfego proveniente da página da playlist.PRODUCT_PAGE
: as visualizações do vídeo foram encaminhadas de uma página de produto.PROMOTED
: as visualizações do vídeo foram encaminhadas por uma promoção não paga do YouTube, como a página "Vídeos em destaque".RELATED_VIDEO
: as visualizações do vídeo foram redirecionadas de uma ficha de vídeo relacionada em outra página de exibição. Se você filtrar com base nessa origem de tráfego, o campoinsightTrafficSourceDetail
vai especificar o ID do vídeo.SHORTS
: o espectador foi redirecionado deslizando verticalmente do vídeo anterior na experiência de visualização dos Shorts.SOUND_PAGE
: visualizações originadas das páginas de pivot de áudio dos Shorts.SUBSCRIBER
: as visualizações do vídeo foram encaminhadas de feeds na página inicial do YouTube ou de recursos de inscrição do YouTube. Se você filtrar com base nessa origem de tráfego, o campoinsightTrafficSourceDetail
especifica os itens do feed da página inicial ou outra página de onde as visualizações foram originadas.YT_CHANNEL
: as visualizações do vídeo ocorreram na página de um canal. Se você filtrar com base nessa origem de tráfego, o campoinsightTrafficSourceDetail
vai especificar o ID do canal.YT_OTHER_PAGE
: as visualizações do vídeo foram geradas por um link que não é um resultado de pesquisa ou um link de vídeo relacionado que apareceu em uma página do YouTube. Se você filtrar com base nessa origem de tráfego, o campoinsightTrafficSourceDetail
vai identificar a página.YT_SEARCH
: as visualizações do vídeo foram geradas pelos resultados da pesquisa do YouTube. Se você filtrar com base nessa origem de tráfego, o campoinsightTrafficSourceDetail
vai especificar o termo de pesquisa.VIDEO_REMIXES
: as visualizações do vídeo foram direcionadas pelo link do vídeo remixado no player dos Shorts. Se você filtrar com base nessa origem de tráfego, o campoinsightTrafficSourceDetail
vai especificar o vídeo de onde o espectador foi redirecionado.
- insightTrafficSourceDetail
- Os dados do relatório são agregados com base nos referrers que geraram mais visualizações para um vídeo e um tipo de origem de tráfego específicos. A lista a seguir identifica as origens de tráfego em que esse relatório está disponível. Para cada origem de tráfego, a lista identifica as informações fornecidas pela dimensão
insightTrafficSourceDetail
.ADVERTISING
: o tipo de anúncio que gerou as visualizações. Valores possíveis:- Anúncio de engajamento clique para ver
- Anúncio de engajamento
- Anúncios da Pesquisa Google
- Anúncio em vídeo na página inicial
- In-stream pulável reservado
- TrueView in-search e in-display
- TrueView in-stream
- Publicidade no YouTube sem classificação
- Mural de vídeos
CAMPAIGN_CARD
: o vídeo reivindicado que levou os espectadores ao vídeo identificado no relatório.END_SCREEN
: o vídeo que levou os espectadores ao vídeo identificado na denúncia.EXT_URL
: o site que direcionou os espectadores ao vídeo.HASHTAGS
: a hashtag que levou às visualizações.NOTIFICATION
: o e-mail ou a notificação que indicou o tráfego.RELATED_VIDEO
: o vídeo relacionado que levou os espectadores ao vídeo mencionado na denúncia.SOUND_PAGE
: o vídeo que gerou as visualizações.SUBSCRIBER
: o item do feed da página inicial ou o recurso de inscrição do YouTube que levou os espectadores ao vídeo mencionado no relatório. Os valores válidos são:activity
: visualizações de itens nos feeds de inscrição da página inicial que resultaram de atividades não relacionadas a envios e redes sociais, como marcações "Gostei", adição aos favoritos, postagens no boletim e adições à playlist.blogged
: visualizações de itens nos feeds de inscrições da página inicial que resultaram de links de blogs importantes.mychannel
: visualizações de itens em outros feeds listados na página inicial, como "Gostei", "Histórico de exibição" e "Assistir mais tarde".podcasts
: visualizações originadas de itens na página de destino do Google Podcasts.sdig
: visualizações originadas de e-mails de atualização de assinatura.uploaded
: visualizações dos itensuploaded
nos feeds de inscrição da página inicial./
: outras visualizações originadas da página inicial do YouTube./my_subscriptions
: visualizações originadas das páginas Minhas inscrições dos usuários no YouTube.
YT_CHANNEL
: a página do canal em que os espectadores assistiram o vídeo.YT_OTHER_PAGE
: a página do YouTube de onde os espectadores foram direcionados para o vídeo.YT_SEARCH
: o termo de pesquisa que levou os espectadores ao vídeo.VIDEO_REMIXES
: o vídeo que gerou as visualizações.
Exemplos
Os seguintes exemplos de solicitação usam dimensões de origem de tráfego:
Exemplos de canais
-
Origem do tráfego
- Contagens de exibições e tempo de exibição de diferentes origens de tráfego em um país
- Contagem de visualizações diárias e tempo de exibição de diferentes origens de tráfego
- 10 mais – Termos de pesquisa do YouTube que geram mais tráfego para um vídeo
- Top 10: termos da Pesquisa Google que geram mais tráfego para um vídeo
- Contagens de visualizações de playlist e tempo de exibição de diferentes origens de tráfego em um país
- Contagem de visualizações diárias de playlists e tempo de exibição de diferentes origens de tráfego
-
Origem do tráfego
Exemplos de proprietários de conteúdo
-
Origem do tráfego
- Contagens de exibições e tempo de exibição de diferentes origens de tráfego
- Contagem de visualizações diárias e tempo de exibição de diferentes origens de tráfego
- 10 mais – Termos de pesquisa do YouTube que geram mais tráfego para um vídeo
- Top 10: termos da Pesquisa Google que geram mais tráfego para um vídeo
- Contagens de visualizações de playlist e tempo de exibição de diferentes origens de tráfego em um país
- Contagem de visualizações diárias de playlists e tempo de exibição de diferentes origens de tráfego
-
Origem do tráfego
Dispositivos
- deviceType
- Essa dimensão identifica o formato físico do dispositivo em que a visualização ocorreu.
A lista a seguir identifica os tipos de dispositivos para os quais a API retorna dados. Também é possível usar a dimensão
deviceType
como um filtro para restringir um relatório do sistema operacional a apenas dados de um tipo específico de dispositivo.DESKTOP
GAME_CONSOLE
MOBILE
TABLET
TV
UNKNOWN_PLATFORM
- operatingSystem
- Essa dimensão identifica o sistema de software do dispositivo em que a visualização ocorreu.
A lista a seguir identifica os sistemas operacionais para os quais a API retorna dados. Também é possível usar o
operatingSystem
como filtro para restringir um relatório de tipo de dispositivo a apenas dados de um sistema operacional específico.ANDROID
BADA
BLACKBERRY
CHROMECAST
DOCOMO
FIREFOX
HIPTOP
IOS
KAIOS
LINUX
MACINTOSH
MEEGO
NINTENDO_3DS
OTHER
PLAYSTATION
PLAYSTATION_VITA
REALMEDIA
SMART_TV
SYMBIAN
TIZEN
VIDAA
WEBOS
WII
WINDOWS
WINDOWS_MOBILE
XBOX
Exemplos
Os seguintes exemplos de solicitação usam dimensões do dispositivo:
Exemplos de canais
-
Dispositivo/SO
- Métricas diárias do tipo de dispositivo para o sistema operacional Android
- Métricas diárias do sistema operacional para dispositivos móveis
- Métricas diárias do sistema operacional e do tipo de dispositivo
- Métricas diárias de tipo de dispositivo para visualizações de playlist no sistema operacional Android
- Métricas diárias do sistema operacional para visualizações de playlist em dispositivos móveis
-
Dispositivo/SO
Exemplos de proprietários de conteúdo
-
Dispositivo/SO
- Métricas diárias do tipo de dispositivo para vídeos reivindicados
- Métricas diárias do sistema operacional para vídeos reivindicados visualizados em dispositivos móveis
- Métricas diárias do sistema operacional e do tipo de dispositivo
- Métricas diárias de tipo de dispositivo para visualizações de playlist no sistema operacional Android
- Métricas diárias do sistema operacional para visualizações de playlist em dispositivos móveis
-
Dispositivo/SO
Informações demográficas
As dimensões demográficas ajudam a entender a faixa etária e a distribuição de gênero do seu público. A Central de Ajuda do YouTube tem mais informações sobre dados demográficos nos relatórios YouTube Analytics.
- ageGroup (dimensão principal)
- Essa dimensão identifica o grupo de idade dos usuários conectados associados aos dados do relatório. A API usa as seguintes faixas etárias:
- age13-17
- age18-24
- age25-34
- age35-44
- age45-54
- age55-64
- age65-
- gênero (dimensão principal)
- Essa dimensão identifica o gênero dos usuários conectados associados aos dados do relatório.
Os valores válidos são
female
,male
euser_specified
. This is a core dimension and is subject to the Deprecation Policy.
Exemplos
Os seguintes exemplos de solicitação usam dimensões demográficas:
Exemplos de canais
-
Demográficas
- Informações demográficas dos espectadores na Califórnia (faixa etária e gênero)
- Informações demográficas dos espectadores da playlist na Califórnia (faixa etária e gênero)
-
Demográficas
Exemplos de proprietários de conteúdo
-
Demográficas
- Informações demográficas dos espectadores na Califórnia (faixa etária e gênero)
- Informações demográficas dos espectadores da playlist na Califórnia (faixa etária e gênero)
-
Demográficas
Engajamento e compartilhamento de conteúdo
- sharingService (dimensão principal)
- Essa dimensão identifica o serviço usado para compartilhar vídeos. Os vídeos podem ser compartilhados no YouTube (ou pelo player do YouTube), utilizando o botão "Compartilhar". This is a core dimension and is subject to the Deprecation Policy.
A tabela a seguir lista os valores de dimensão válidos:
Serviço de compartilhamento Valor da API Ameba AMEBA
Android Email ANDROID_EMAIL
Android Messenger ANDROID_MESSENGER
Mensagens do Android ANDROID_MMS
BlackBerry Messenger BBM
Blogger BLOGGER
Copiar para a área de transferência COPY_PASTE
Cyworld CYWORLD
Digg DIGG
Dropbox DROPBOX
Incorporar EMBED
E-mail MAIL
Facebook FACEBOOK
Facebook Messenger FACEBOOK_MESSENGER
Páginas do Facebook FACEBOOK_PAGES
Fotka FOTKA
Gmail GMAIL
goo GOO
Google+ GOOGLEPLUS
Go SMS GO_SMS
GroupMe GROUPME
Hangouts HANGOUTS
hi5 HI5
Mensagem de texto da HTC HTC_MMS
Caixa de entrada do Google INBOX
Caixa de diálogo de atividade do sistema iOS IOS_SYSTEM_ACTIVITY_DIALOG
KAKAO Story KAKAO_STORY
Kakao (Kakao Talk) KAKAO
Kik KIK
E-mail da LGE LGE_EMAIL
Linha LINE
LinkedIn LINKEDIN
LiveJournal LIVEJOURNAL
menéame MENEAME
mixi MIXI
Motorola Messaging MOTOROLA_MESSAGING
Myspace MYSPACE
Naver NAVER
Compartilhar por proximidade NEARBY_SHARE
NUjij NUJIJ
Odnoklassniki (Одноклассники) ODNOKLASSNIKI
Outro OTHER
Pinterest PINTEREST
Rakuten (楽天市場) RAKUTEN
reddit REDDIT
Skype SKYPE
Skyrock SKYBLOG
Sony Conversations SONY_CONVERSATIONS
StumbleUpon STUMBLEUPON
Telegram TELEGRAM
Mensagem de texto TEXT_MESSAGE
Tuenti TUENTI
Tumblr. TUMBLR
Twitter TWITTER
Desconhecido UNKNOWN
Mensagens da Verizon VERIZON_MMS
Viber VIBER
VKontakte (ВКонтакте) VKONTAKTE
WeChat WECHAT
Weibo WEIBO
WhatsApp WHATS_APP
Wykop WYKOP
Yahoo! Japan YAHOO
YouTube Gaming YOUTUBE_GAMING
YouTube Kids YOUTUBE_KIDS
YouTube Music YOUTUBE_MUSIC
YouTube TV YOUTUBE_TV
Consulte os documentos de ajuda para mais informações.
Exemplos
Os seguintes exemplos de solicitação usam dimensões sociais:
Exemplos de canais
- Redes sociais: métricas de compartilhamento, agregadas por serviço em que os vídeos foram compartilhados
Exemplos de proprietários de conteúdo
- Redes sociais: métricas de compartilhamento, agregadas por serviço em que os vídeos foram compartilhados
Retenção de público
- elapsedVideoTimeRatio
- Esta dimensão especifica a proporção da parte decorrido do vídeo em relação à duração dele. As dimensões e métricas de retenção são usadas para medir a retenção do público ao longo do tempo, e a dimensão
elapsedVideoTimeRatio
é a medição do tempo. Por exemplo, um valor de0.4
indica que os dados do relatório correspondente mostram dados de retenção após 40% do vídeo ter passado.
A API retorna 100 pontos de dados para cada vídeo com valores de proporção que variam de0.01
a1.0
. Os momentos em que os dados são medidos durante a reprodução de vídeo são espaçados igualmente para cada vídeo. Isso significa que, para um vídeo de dois minutos, o intervalo entre os pontos de dados é de 1,2 segundos. No entanto, para um vídeo de duas horas, o intervalo entre os pontos de dados é de 72 segundos. O valor da dimensão indica o fim exclusivo do intervalo. - audienceType (somente filtro)
- O valor da dimensão identifica o tipo de tráfego associado aos dados do relatório.
Os valores aceitos são
ORGANIC
,AD_INSTREAM
eAD_INDISPLAY
. Consulte a Central de Ajuda do YouTube para saber mais sobre esses tipos de origem de tráfego.
Os dados do filtroaudienceType
estão disponíveis desde 25 de setembro de 2013. A API não retorna dados para consultas que usam o filtro para tentar recuperar dados de datas anteriores. As consultas que não usam o filtro funcionam para qualquer data após 1º de julho de 2008.
Exemplos
As solicitações de exemplo a seguir usam dimensões de retenção de público-alvo:
Exemplos de canais
- Retenção de público: métricas de retenção de público de um vídeo
Exemplos de proprietários de conteúdo
- Retenção de público: métricas de retenção de público de um vídeo
transmissão ao vivo;
- livestreamPosition
- Esta dimensão especifica um minuto específico durante uma transmissão de vídeo ao vivo. As métricas do relatório indicam quantos usuários estavam assistindo a transmissão ao vivo naquele momento.
Cancelamentos de assinaturas
- membershipsCancellationSurveyReason
- O número de pesquisas concluídas por usuários do YouTube que cancelaram a assinatura do canal especificado durante o período do relatório. A tabela a seguir lista os valores de dimensão válidos:
Valor da API Explicação UNKNOWN
O usuário não concluiu a pesquisa. DISLIKE_PERKS
O usuário não gostou dos benefícios da assinatura. PERKS_NOT_DELIVERED
O usuário disse que os benefícios prometidos da assinatura não foram entregues. CANNOT_ACCESS_PERKS
O usuário não conseguiu acessar os benefícios. NO_LONGER_INTERESTED
O usuário não tem mais interesse em ser membro do canal. FEEL_UNAPPRECIATED
O usuário não se sentiu valorizado como membro do canal. FINANCIAL_REASONS
O usuário cancelou por motivos financeiros. JOIN_LIMITED_TIME
O usuário só queria participar por um tempo limitado. OTHER
O usuário tinha outro motivo para cancelar.
Desempenho do anúncio
- adType
- A dimensão
adType
é usada nos relatórios de performance de anúncios e agrega as métricas solicitadas com base nos tipos de anúncios veiculados durante a reprodução de vídeo. A lista a seguir explica os valores de dimensão possíveis. Consulte a Central de Ajuda do YouTube para mais informações sobre os formatos de publicidade do YouTube.
-
auctionBumperInstream
: anúncios em vídeo não puláveis, veiculados por leilão, de até seis segundos que precisam ser assistidos antes que um vídeo seja exibido. -
auctionDisplay
: um anúncio rich media ou de imagem que aparece como uma sobreposição na parte de baixo do player de vídeo, como um bloco de 300 x 250 na página de exibição do vídeo ou como uma combinação dos dois. Quando a sobreposição é executada, ela é automaticamente fechada após a exibição por determinado período. O usuário também pode fechá-la. Se uma sobreposição e um banner forem exibidos juntos, cada anúncio é contado como uma impressão separada. -
auctionInstream
: anúncios em vídeo não puláveis que são veiculados antes, durante ou depois do vídeo principal. -
auctionTrueviewInslate
: o espectador escolhe um dos vários anúncios em vídeo de uma seleção de opções exibidas antes de um vídeo. See the TrueView documentation for more information. -
auctionTrueviewInstream
: anúncios em vídeo puláveis exibidos antes ou durante o vídeo principal. Consulte a documentação do TrueView para mais informações. -
auctionUnknown
: um anúncio comprado pelo leilão do AdWords, mas que não foi classificado em um dos outros tipos de anúncio. -
reservedBumperInstream
: anúncios em vídeo não puláveis, vendidos com base na reserva, de até seis segundos que precisam ser assistidos antes que um vídeo seja exibido. -
reservedClickToPlay
: um anúncio em vídeo que o usuário precisa clicar para iniciar a reprodução. Uma impressão de anúncio é registrada em qualquer momento em que o bloco de anúncio click-to-play for exibido, independentemente de o usuário iniciar a reprodução. Eles são vendidos de forma reservada. -
reservedDisplay
: um anúncio rich media ou de imagem que aparece como uma sobreposição na parte de baixo do player de vídeo, como um bloco de 300 x 250 na página de exibição do vídeo ou como uma combinação dos dois. Quando a sobreposição é executada, ela é automaticamente fechada após a exibição por determinado período. O usuário também pode fechá-la. Se uma sobreposição e um banner forem exibidos juntos, cada anúncio é contado como uma impressão separada. -
reservedInstream
: anúncios em vídeo não puláveis inseridos antes, durante ou depois do vídeo principal. -
reservedInstreamSelect
-
reservedMasthead
: um anúncio grande, que pode incluir elementos gráficos e em vídeo, que aparece na página inicial. -
reservedUnknown
: um anúncio vendido com base em reserva que não pôde ser classificado em um dos outros tipos de anúncio. -
unknown
: o YouTube não conseguiu classificar esse tipo de anúncio.
-
Exemplos
Os relatórios de amostra a seguir recuperam as métricas de performance ou receita do anúncio:
Exemplos de canais
-
Receita/anúncios
- Métricas de receita do canal e de performance do anúncio
- Métricas de receita diária e performance de anúncios
- Métricas de receita e performance de anúncios específicas por país
- Top 10: vídeos com a maior receita
- Métricas de desempenho de anúncios para diferentes tipos de anúncios
-
Receita/anúncios
Exemplos de proprietários de conteúdo
-
Receita/anúncios
- Métricas de receita e performance de anúncios para conteúdo reivindicado
- Métricas de receita diária e performance de anúncios
- Métricas de receita e performance de anúncios específicas por país
- Top 10: vídeos com a maior receita
- Métricas de desempenho de anúncios para diferentes tipos de anúncios
-
Receita/anúncios
Dimensões do proprietário do conteúdo
As dimensões a seguir são suportadas somente para relatórios do proprietário do conteúdo.
- claimedStatus (usado apenas em relatórios do proprietário do conteúdo)
- Essa dimensão permite indicar que uma resposta da API deve conter apenas métricas para conteúdo reivindicado. O único valor válido para essa dimensão é
claimed
. Se o parâmetrofilters
restringir a consulta aclaimedStatus==claimed
, a API só vai recuperar dados do conteúdo reivindicado. A tabela na definição da dimensãouploaderType
fornece mais detalhes sobre como usar essa dimensão.
- uploaderType (dimensão principal) (usado apenas em relatórios de proprietários de conteúdo)
- Essa dimensão permite indicar se uma resposta da API precisa conter métricas para conteúdo enviado por upload pelo proprietário de conteúdo especificado e/ou por terceiros, como vídeos enviados por usuários. Os valores válidos são
self
ethirdParty
. Essa é uma dimensão principal e está sujeita à política de descontinuação.
A tabela abaixo mostra as combinações compatíveis para as dimensõesclaimedStatus
euploaderType
, que são usadas no parâmetrofilters
:
Valor de claimedStatus
Valor de uploaderType
Descrição [Não definido] self Recupera dados do YouTube Analytics para o conteúdo reivindicado e não reivindicado enviado pelo proprietário do conteúdo. reivindicados [Não definido] Recupera dados para o conteúdo reivindicado enviado pelo proprietário do conteúdo ou por um terceiro. reivindicados self Recupera dados para o conteúdo reivindicado enviado pelo proprietário do conteúdo. reivindicados thirdParty Recupera dados para o conteúdo reivindicado enviado por um terceiro.
Exemplos
Muitas das solicitações de API de exemplo para relatórios de proprietários de conteúdo usam uma combinação compatível das dimensões claimedStatus
e uploaderType
para filtrar dados.