Dimensions

Neste documento, definimos as dimensões compatíveis com a API YouTube Analytics. Essa API é compatível com 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 ocorreu a atividade do usuário ou o país onde 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 hora, 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 única de valores de dimensão.

Para recuperar um relatório de consulta, chame o método reports.query da API YouTube Analytics. Na sua solicitação, use o parâmetro dimensions para especificar as dimensões que o YouTube usará para calcular os valores de métricas nos relatórios.

Principais dimensões

Embora a API YouTube Analytics esteja sujeita à política de suspensão de uso definida nos Termos de Serviço, as dimensões (e as métricas não principais) não estão sujeitas à política. Nas definições desta página, qualquer dimensão que seja uma dimensão principal é identificada explicitamente como tal.

A lista a seguir identifica as principais dimensões 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 valores de dimensão que precisam estar presentes no conjunto de dados recuperado. Dessa forma, eles limitam uma resposta de API para incluir apenas dados que correspondam a um determinado valor ou conjunto de valores. Por exemplo, em vez de recuperar as métricas de atividade do usuário para todos os países, você pode usar um filtro para recuperar dados somente para 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 que você quer filtrar. Por exemplo, para recuperar 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 do conteúdo precisam filtrar os 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 YouTube Analytics. A menos que indicado de outra forma, essas dimensões são usadas nos relatórios de canal e de proprietário do conteúdo. As dimensões que só podem ser usadas como filtros também são identificadas.

Recursos

Estas dimensões correspondem aos recursos que os canais e os proprietários de conteúdo gerenciam no YouTube:

Observação:a API permite que você especifique vários valores para as dimensões video, playlist e channel quando elas forem 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 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, este é o valor da propriedade id de um recurso video. 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, este é o valor da propriedade id de um recurso playlist.
canal (dimensão principal) (usado somente em relatórios do proprietário do conteúdo)
O ID de um canal do YouTube. Na API Data do YouTube, este é o valor da propriedade id de um recurso channel. This is a core dimension and is subject to the Deprecation Policy.

A dimensão channel é usada com frequência em relatórios do proprietário do conteúdo porque eles geralmente agregam dados de vários canais.
group (somente filtro)
O ID de um grupo do YouTube Analytics. Você pode recuperar esse valor usando o método groups.list da API YouTube Analytics. Quando você usa o filtro group, a resposta da API contém dados de todos os vídeos, playlists ou canais desse grupo.

Exemplos

Os seguintes exemplos de solicitação 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
      • 10 mais – Taxas de clique de anotação para os vídeos mais visualizados de um canal
      • Estatísticas para uma playlist específica
      • 10 mais – Playlists mais assistidas de um canal
    • Informações geográficas
      • 10 mais – Vídeos mais visualizados em um país específico
      • 10 mais – Vídeos mais vistos na Europa

  • Exemplos de proprietários de conteúdo

    • Estatísticas básicas
      • 10 mais – Vídeos mais visualizados para um proprietário de conteúdo
      • 10 mais – Vídeos mais assistidos para um proprietário de conteúdo
      • 10 mais – Vídeos mais visualizados para o canal de um proprietário de conteúdo
      • 10 mais – Taxas de clique de anotação para os vídeos mais visualizados de um canal
      • 10 mais – Playlists mais assistidas para um proprietário de conteúdo
    • Informações geográficas
      • 10 mais – Vídeos mais assistidos na Europa para um proprietário de conteúdo
      • 10 mais – Playlists mais iniciadas nos Estados Unidos

Áreas geográficas

Essas dimensões identificam uma região geográfica associada à métrica de atividade do usuário, desempenho do anúncio ou receita estimada.

país (dimensão principal)
O país associado às métricas da 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) ou FR (França). O código de país ZZ é usado para gerar relatórios sobre 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 Colúmbia, como US-MI (Michigan) ou US-TX (Texas). O código da província US-ZZ é usado para gerar relatórios sobre métricas em que o YouTube não conseguiu identificar o estado associado dos EUA. Quando uma solicitação de API inclui province no valor de parâmetro dimensions, a solicitação também precisa restringir dados aos Estados Unidos, incluindo country==US no valor de parâmetro filters.

Observação:essa dimensão não é compatível com os valores de ISO 3166-2 que identificam as áreas fora dos EUA, já que esses territórios também têm os próprios códigos de país ISO 3166-1. Ele também não tem suporte a subdivisões de outros países além dos Estados Unidos.

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 1o de janeiro de 2022.
continent (somente filtro)
Um código de região estatística da ONU. A API é compatível com os 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
Essa dimensão só pode ser usada para filtrar dados. Para usar essa dimensão, defina o valor do parâmetro filters como continent==REGION_CODE, especificando um valor REGION_CODE da lista acima.
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, bem como os países associados a cada uma delas.

Essa dimensão só pode ser usada para filtrar dados. Para usar essa dimensão, defina o valor do parâmetro filters como subContinent==REGION_CODE, especificando um valor REGION_CODE da lista da ONU.

Exemplos

Os seguintes exemplos de solicitação usam filtros ou dimensões geográficas:

  • Exemplos de canais

    • Estatísticas básicas: contagem de visualizações específica do país para um canal.
    • Informações geográficas
      • 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íncia para estados dos EUA e para Washington D.C.
      • Métricas de tempo de exibição específicas de um país para as playlists de um canal
      • 10 mais – Playlists mais iniciadas nos Estados Unidos
    • Local da reprodução: mostra a contagem diária de visualizações e o tempo de exibição de diferentes locais.
    • Origem do tráfego: número de 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 (idade e gênero)
    • Principais vídeos
      • 10 mais – Vídeos mais visualizados em um país específico
      • 10 mais – Vídeos mais vistos na Europa

  • Exemplos de proprietários de conteúdo

    • Estatísticas básicas: contagem de visualizações específicas do país (e mais) para todos os vídeos enviados automaticamente.
    • Informações geográficas
      • Métricas do tempo de exibição específicas 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íncia para estados dos EUA e para Washington D.C.
      • Métricas de tempo de exibição específicas do país para as playlists de um proprietário de conteúdo
      • 10 mais – Playlists mais iniciadas nos Estados Unidos
    • Local da reprodução: mostra a contagem diária de visualizações e o tempo de exibição de diferentes locais.
    • Informações demográficas: informações demográficas dos espectadores na Califórnia (idade e gênero)
    • Principais vídeos: os 10 mais – Vídeos mais assistidos na Europa para um proprietário de conteúdo
    • Receita/desempenho do anúncio: métricas de desempenho de anúncios e receita específicas do país.

Períodos

Essas dimensões indicam que um relatório deve 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, para o qual todas as métricas especificadas na solicitação estão disponíveis no momento em que a consulta é feita. 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 00h do horário do Pacífico (UTC-7 ou UTC-8) e termina às 23h59 do dia do mês, 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 refere-se ao período que começa às 00h do horário do Pacífico (UTC-7 ou UTC-8) no primeiro dia do mês e do ano especificados.

dia (dimensão principal)
Quando você usa essa dimensão, os dados do relatório são agregados diariamente, e cada linha contém dados de um dia. É possível usar outras dimensões para detalhar ainda mais os dados. Por exemplo, um relatório de origem de tráfego pode agregar estatísticas diárias de visualização com base na maneira como os usuários alcançam seus vídeos. This is a core dimension and is subject to the Deprecation Policy.
mês (dimensão principal)
Os dados do 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 usa a dimensão month, os parâmetros start-date e end-date precisam ser definidos para o primeiro dia do mês. This is a core dimension and is subject to the Deprecation Policy.

Exemplos

Os seguintes exemplos de solicitação usam dimensões ou filtros temporais:

  • Exemplos de canais

    • Baseado no período do dia
      • 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 da playlist de um canal
    • Local da reprodução: mostra a contagem diária de visualizações e o tempo de exibição de diferentes locais.
    • 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

  • Exemplos de proprietários de conteúdo

    • Baseado no período do dia
      • Métricas diárias de tempo de exibição para conteúdo enviado automaticamente
      • Métricas de anotação para o conteúdo reivindicado
      • Visualizações diárias da playlist em um proprietário de conteúdo
    • Local da reprodução: mostra a contagem diária de visualizações e o tempo de exibição de diferentes locais.
    • 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/desempenho do anúncio: métricas diárias de receita e do anúncio.

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 do vídeo ocorreram. Os valores possíveis para essa dimensão são:

  • BROWSE: os dados descrevem as visualizações que ocorreram 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 em uma página do canal.

  • EMBEDDED – Os dados descrevem as visualizações que ocorreram em outro site ou aplicativo em que o vídeo foi incorporado usando uma incorporação <iframe> ou <object>.

  • EXTERNAL_APP: os dados descrevem as visualizações que ocorreram em um aplicativo de terceiros em que o vídeo foi reproduzido usando um método diferente de uma incorporação <iframe> ou <object>. Por exemplo, as reproduções em aplicativos que usam a API do Player do YouTube para Android seriam categorizadas usando esse valor.

  • MOBILE – Os dados descrevem as visualizações que ocorreram no site móvel do YouTube ou em clientes aprovados da API YouTube, incluindo dispositivos móveis.

    Desde 10 de setembro de 2013, as reproduções não são mais categorizadas como MOBILE reproduções 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 serão classificadas como WATCH, EMBEDDED ou EXTERNAL_APP, dependendo do tipo de aplicativo em que elas forem feitas.

  • SEARCH – Os dados descrevem as visualizações que ocorreram 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 ou em um app oficial do YouTube, como o app YouTube para Android.

  • YT_OTHER: os dados descrevem as visualizações não classificadas de outra forma.

insightPlaybackLocationDetail.
Os dados são agregados com base na página do jogador. 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
      • Contagens de visualização diárias e tempo de exibição de diferentes locais de reprodução
      • 10 mais – Sites de terceiros que geram o maior número de visualizações para um vídeo incorporado
      • Contagens de visualização da playlist e tempo de exibição de diferentes locais de reprodução
      • Contagens de visualização diária da playlist e tempo de exibição de diferentes locais de 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
      • Contagens de visualização diárias e tempo de exibição de diferentes locais de reprodução
      • 10 mais – Sites de terceiros que geram o maior número de visualizações para um vídeo incorporado
      • Contagens de visualização da playlist e tempo de exibição de diferentes locais de reprodução
      • Contagens de visualização diária da playlist e tempo de exibição de diferentes locais de reprodução

Detalhes da reprodução

creatorContentType (link em inglês)
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 1o de janeiro de 2019.

A tabela a seguir lista os valores de dimensão:
Valores
LIVE_STREAM O conteúdo visualizado foi uma transmissão ao vivo do YouTube.
SHORTS O conteúdo assistido era um Short do YouTube.
STORY O conteúdo exibido era uma história do YouTube.
VIDEO_ON_DEMAND O conteúdo assistido era um vídeo do YouTube que não se enquadra em nenhum dos outros valores de dimensão.
UNSPECIFIED O tipo do 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 desta dimensão estão disponíveis a partir de 1° de abril de 2014.

A tabela a seguir lista os valores de 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.
Status da assinatura
Essa dimensão indica se as métricas de atividade do usuário na linha de dados estão associadas a espectadores que se inscreveram no canal do vídeo ou da playlist. Os valores possíveis são SUBSCRIBED e UNSUBSCRIBED.

O valor da dimensão é preciso no momento em que a atividade do usuário ocorre. Por exemplo, suponha que um usuário não se inscreveu em um canal e assiste a um dos vídeos desse canal, em seguida se inscreve no canal e assiste a outro vídeo, tudo no mesmo dia. O relatório do canal indica que uma visualização tem um valor subscribedStatus de SUBSCRIBED e uma visualização tem um valor subscribedStatus de UNSUBSCRIBED.
YouTubeProduct (em inglês)
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 de dimensão:
Valores
CORE A atividade do usuário que não ocorreu em um dos apps específicos do YouTube (YouTube Gaming, YouTube Kids ou YouTube Music). Exceção: atividades do usuário realizadas no YouTube Music antes de 1o de março de 2021 estão incluídas no 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 1o de março de 2021 ou após essa data. Os dados anteriores a 1o de março de 2021 estão incluídos no CORE. Os dados em tempo real não são registrados.
UNKNOWN A atividade do usuário ocorreu antes de 18 de julho de 2015.

Origens de tráfego

insightTrafficSourceType (em inglês)
Os dados do relatório são agregados com base no tipo de referenciador, que descreve como os usuários chegaram ao vídeo. Os valores possíveis para essa dimensão são:
  • ADVERTISING – O espectador foi direcionado ao vídeo por um anúncio. Se você filtrar com base nesta origem de tráfego, o campo insightTrafficSourceDetail identificará o tipo de publicidade.
  • ANNOTATION – Os espectadores chegaram ao vídeo clicando em uma anotação em outro vídeo.
  • CAMPAIGN_CARD – Visualizações originadas de vídeos reivindicados e enviados pelo usuário que o proprietário do conteúdo usou para promover o conteúdo exibido. Esta origem de tráfego tem suporte apenas para relatórios do proprietário do conteúdo.
  • END_SCREEN – As visualizações foram direcionadas da tela final de outro vídeo.
  • EXT_URL – As exibições de vídeo foram direcionadas de um link em outro site. Se você filtrar com base nesta origem de tráfego, o campo insightTrafficSourceDetail identificará a página da Web. Essa origem de tráfego inclui referências dos resultados da pesquisa do Google.
  • HASHTAGS: visualizações originadas de páginas de hashtag VOD ou de páginas dinâmicas de hashtag do Shorts.
  • LIVE_REDIRECT: as exibições de vídeo foram direcionadas a partir de Redirecionados em tempo real.
  • NO_LINK_EMBEDDED – O vídeo foi incorporado em outro site quando ele foi visualizado.
  • NO_LINK_OTHER: o YouTube não identificou um referenciador para o tráfego. Esta categoria engloba o tráfego direto a um vídeo, o tráfego de aplicativos móveis.
  • NOTIFICATION – As exibições de vídeo foram direcionadas de um e-mail ou notificação do YouTube.
  • PLAYLIST – As exibições ocorreram enquanto o vídeo estava sendo reproduzido em uma playlist. Observe que essa origem do tráfego é diferente de YT_PLAYLIST_PAGE, o que indica que as visualizações vieram da página que lista todos os vídeos da playlist.
  • PRODUCT_PAGE: as exibições de vídeo foram direcionadas de uma página de produto.
  • PROMOTED – As exibições de vídeo foram direcionadas de uma promoção não paga do YouTube, como a página "Vídeos do momento".
  • RELATED_VIDEO – As exibições de vídeo foram direcionadas de uma listagem de vídeos relacionados em outra página de exibição de vídeo. Se você filtrar com base nesta origem de tráfego, o campo insightTrafficSourceDetail especificará o ID do vídeo.
  • SHORTS – O espectador foi indicado ao deslizar verticalmente o vídeo anterior na experiência de visualização do Shorts.
  • SOUND_PAGE: visualizações originadas de páginas dinâmicas de áudio dos Shorts.
  • SUBSCRIBER – As exibições de vídeo 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 campo insightTrafficSourceDetail especificará os itens de feed da página inicial ou outra página de onde as visualizações foram direcionadas.
  • YT_CHANNEL – As exibições de vídeo ocorreram em uma página do canal. Se você filtrar com base nesta origem de tráfego, o campo insightTrafficSourceDetail especificará o ID do canal para esse canal.
  • YT_OTHER_PAGE – As exibições de vídeo foram direcionadas de um link que não era um resultado de pesquisa ou um link de vídeo relacionado que apareceu em uma página do YouTube. Se você filtrar com base nesta origem de tráfego, o campo insightTrafficSourceDetail identificará a página.
  • YT_PLAYLIST_PAGE – As exibições de vídeo se originaram de uma página que lista todos os vídeos de uma playlist. Observe que essa origem do tráfego é diferente de PLAYLIST, o que indica que as visualizações ocorreram enquanto o vídeo estava sendo reproduzido como parte de uma playlist.
  • YT_SEARCH – As exibições de vídeo foram direcionadas dos resultados da pesquisa do YouTube. Se você filtrar com base nesta origem de tráfego, o campo insightTrafficSourceDetail especificará o termo de pesquisa.
insightTrafficSourceDetail (em inglês)
Os dados do relatório são agregados com base nos referenciadores que geraram o maior número de visualizações para um vídeo especificado e um tipo de origem de tráfego especificado. A lista abaixo identifica as origens de tráfego para as quais esse relatório está disponível. Para cada origem de tráfego, a lista identifica as informações que a dimensão insightTrafficSourceDetail fornece.
  • ADVERTISING – O tipo de publicidade que levou às visualizações. Os valores possíveis são os seguintes:
    • Anúncio de engajamento "clique para ver"
    • Anúncio de engajamento
    • Anúncios da rede de pesquisa do Google
    • Anúncio em vídeo na página inicial
    • In-stream pulável reservado
    • TrueView na pesquisa e em Display
    • TrueView in-stream
    • Publicidade no YouTube sem classificação
    • Video Wall
  • 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 no relatório.
  • 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 deu origem ao tráfego.
  • RELATED_VIDEO – O vídeo relacionado que levou os espectadores ao vídeo abordado no relatório.
  • SOUND_PAGE – O vídeo que levou às visualizações.
  • SUBSCRIBER – O item do feed da página inicial ou o recurso de inscrição do YouTube que direcionou os espectadores ao vídeo abordado no relatório. Os valores válidos são:
    • activity – Visualizações de itens nos feeds de inscrição da página inicial provenientes da atividade não social e de não envio do canal, incluindo gostei, favoritos, publicações de boletins e adições à playlist.
    • blogged – Visualizações de itens nos feeds de inscrição da página inicial provenientes de links dos principais blogs.
    • 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 Podcasts.
    • sdig: visualizações originadas de e-mails de atualização de assinaturas.
    • uploaded: visualizações dos itens uploaded nos feeds de inscrição da página inicial.
    • / – Outras visualizações da página inicial do YouTube.
    • /my_subscriptions – Visualizações provenientes das páginas Minhas inscrições dos usuários no YouTube.
  • YT_CHANNEL – A página do canal em que os espectadores assistiram ao vídeo.
  • YT_OTHER_PAGE – A página do YouTube a partir da qual os espectadores foram direcionados ao vídeo.
  • YT_SEARCH – O termo de pesquisa que levou os espectadores ao vídeo.

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
      • Contagens de visualização 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
      • 10 mais – Termos de pesquisa do Google que geram mais tráfego para um vídeo
      • Contagens de visualização da playlist e tempo de exibição de diferentes origens de tráfego em um país
      • Contagens diárias de visualizações da playlist e tempo de exibição de diferentes origens de 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
      • Contagens de visualização 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
      • 10 mais – Termos de pesquisa do Google que geram mais tráfego para um vídeo
      • Contagens de visualização da playlist e tempo de exibição de diferentes origens de tráfego em um país
      • Contagens diárias de visualizações da playlist e tempo de exibição de diferentes origens de tráfego

Dispositivos

deviceType
Essa dimensão identifica o formato físico do dispositivo em que a visualização ocorreu. A lista abaixo identifica os tipos de dispositivo para os quais a API retorna dados. Você também pode usar a dimensão deviceType como filtro para restringir um relatório do sistema operacional para conter apenas os dados de um tipo específico de dispositivo.
  • DESKTOP
  • GAME_CONSOLE
  • MOBILE
  • TABLET
  • TV
  • UNKNOWN_PLATFORM
sistema operacional
Essa dimensão identifica o sistema de software do dispositivo em que a visualização ocorreu. A lista abaixo 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 que contenha somente 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 do tipo de dispositivo para visualizações de playlist no sistema operacional Android
      • Métricas diárias do sistema operacional para visualizações de playlists em dispositivos móveis

  • 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 do tipo de dispositivo para visualizações de playlist no sistema operacional Android
      • Métricas diárias do sistema operacional para visualizações de playlists em dispositivos móveis

Informações demográficas

As dimensões demográficas ajudam você a entender a faixa etária e o gênero do seu público. A Central de Ajuda do YouTube contém informações adicionais sobre os dados demográficos em relatórios YouTube Analytics.

ageGroup (dimensão principal)
Essa dimensão identifica a faixa etária 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-
This is a core dimension and is subject to the Deprecation Policy.
gender (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 e user_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

    • Informações demográficas
      • Informações demográficas dos espectadores na Califórnia (idade e gênero)
      • Informações demográficas do espectador da playlist na Califórnia (idade e gênero)

  • Exemplos de proprietários de conteúdo

    • Informações demográficas
      • Informações demográficas dos espectadores na Califórnia (idade e gênero)
      • Informações demográficas do espectador da playlist na Califórnia (idade e gênero)

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 valores de dimensão válidos:
Serviço de compartilhamento Valor da API
Ameba AMEBA
E-mail do Android ANDROID_EMAIL
Messenger do Android 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
gorjeta GOO
Google+ GOOGLEPLUS
Ir para SMS GO_SMS
GrupoMe GROUPME
Hangouts HANGOUTS
hi5 HI5
Mensagem de texto HTC HTC_MMS
Caixa de entrada do Google INBOX
Caixa de diálogo da atividade do sistema iOS IOS_SYSTEM_ACTIVITY_DIALOG
História do KAKAO 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
Mensagens da Motorola MOTOROLA_MESSAGING
MySpace MYSPACE
Naver NAVER
Compartilhar por proximidade NEARBY_SHARE
NUjij NUJIJ
Odnoklassniki (Оноклассники) ODNOKLASSNIKI
Outro OTHER
Pinterest PINTEREST
Rakuten (楽天EXPAND場) RAKUTEN
reddit REDDIT
Skype SKYPE
Skyrock SKYBLOG
Conversas com Sony SONY_CONVERSATIONS
StumbleUpon STUMBLEUPON
Telegram TELEGRAM
Mensagem de texto TEXT_MESSAGE
Tuenti TUENTI
tumblr. TUMBLR
Twitter TWITTER
Desconhecida UNKNOWN
Mensagens da Verizon VERIZON_MMS
Viber VIBER
VKontakte (ВКонтакте) VKONTAKTE
WeChat WECHAT
Weibo WEIBO
WhatsApp WHATS_APP
Wykop WYKOP
Vincular o ID do Yahoo! Japão YAHOO
Games no YouTube 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 (em inglês)
Esta dimensão especifica a proporção entre o tempo decorrido do vídeo e a duração do vídeo. As dimensões e métricas de retenção são usadas para medir a retenção de público ao longo do tempo, e elapsedVideoTimeRatio é a medida de tempo. Por exemplo, um valor de 0.4 indica que os dados do relatório correspondentes mostram dados de retenção após 40% do vídeo ter decorrido.

A API retorna 100 pontos de dados para cada vídeo com valores de proporção entre 0.01 e 1.0. O momento em que os dados são medidos durante as reproduções do 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 segundo. 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 final exclusivo do intervalo.
audienceType (somente filtro)
O valor de dimensão identifica o tipo de tráfego associado aos dados do relatório. Os valores aceitos são ORGANIC, AD_INSTREAM e AD_INDISPLAY. Consulte a Central de Ajuda do YouTube para ver explicações sobre esses tipos de origem de tráfego.

Os dados do filtro audienceType estão disponíveis desde 25 de setembro de 2013. A API não retorna dados de consultas que usam o filtro para tentar recuperar dados de datas anteriores. As consultas que não usam o filtro funcionam em qualquer data posterior a 1o de julho de 2008.

Exemplos

Os seguintes exemplos de solicitação usam dimensões de retenção de público:

  • Exemplos de canais

  • Exemplos de proprietários de conteúdo

Performance do anúncio

adType
A dimensão adType é usada nos relatórios de desempenho de anúncios e agrega as métricas solicitadas com base nos tipos de anúncios que foram exibidos durante as reproduções de vídeo. A lista a seguir explica possíveis valores de dimensão. 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, colocados em um leilão, de até seis segundos. Eles precisam ser assistidos antes da visualização do vídeo.

  • auctionDisplay – Um anúncio gráfico ou rich media que aparece como uma sobreposição na parte inferior do player de vídeo, como um bloco de anúncios de 300 x 250 na página de exibição do vídeo ou como uma combinação de ambos. 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 exibidos antes, durante ou depois do vídeo principal.

  • auctionTrueviewInslate – O espectador escolhe um dos vários anúncios em vídeo a partir 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 que foi comprado no leilão do Google AdWords, mas que não foi classificado como um dos outros tipos de anúncio.

  • reservedBumperInstream – Anúncios em vídeo não puláveis, vendidos de forma reservada, de até seis segundos. Eles precisam ser assistidos antes da visualização do vídeo.

  • reservedClickToPlay: um anúncio em vídeo em 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 gráfico ou rich media que aparece como uma sobreposição na parte inferior do player de vídeo, como um bloco de anúncios de 300 x 250 na página de exibição do vídeo ou como uma combinação de ambos. 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 aparecem na página inicial.

  • reservedUnknown – Um anúncio vendido de forma reservada, que não pode ser classificado em um dos outros tipos de anúncio.

  • unknown – Não foi possível classificar este tipo de anúncio.

Exemplos

Os seguintes exemplos de relatório recuperam métricas de desempenho do anúncio ou receita:

  • Exemplos de canais

    • Receita/anúncios
      • Métricas do canal e receita do canal
      • Métricas diárias da receita e do desempenho de anúncios
      • Métricas de desempenho de anúncios e receita específicas do país
      • 10 mais – Vídeos com a receita mais alta
      • Métricas de desempenho de anúncios para diferentes tipos de anúncios

  • Exemplos de proprietários de conteúdo

    • Receita/anúncios
      • Métricas de receita e de desempenho de anúncios para o conteúdo reivindicado
      • Métricas diárias da receita e do desempenho de anúncios
      • Métricas de desempenho de anúncios e receita específicas do país
      • 10 mais – Vídeos com a receita mais alta
      • Métricas de desempenho de anúncios para diferentes tipos de anúncios

Playlists

isCurated (somente filtro)
Este filtro indica que a solicitação está recuperando dados sobre exibições de vídeos que ocorreram no contexto de uma playlist. Esse filtro é obrigatório para todos os relatórios de playlist, e o valor dele precisa ser definido como 1.

Exemplos

Todos os exemplos de solicitações que recuperam relatórios de playlist usam o filtro isCurated.

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.

Importante:as solicitações de API para recuperar relatórios do proprietário do conteúdo precisam filtrar os dados usando uma das seguintes dimensões:
  • video
  • channel
  • Uma combinação compatível das dimensões claimedStatus e uploaderType, conforme definido abaixo.
reivindicadoStatus (usado apenas em relatórios de proprietários de conteúdo)
Essa dimensão permite indicar que uma resposta da API deve conter apenas métricas para o conteúdo reivindicado. O único valor válido para esta dimensão é claimed. Se o parâmetro filters restringir a consulta a claimedStatus==claimed, a API só vai recuperar dados do conteúdo reivindicado. A tabela na definição da dimensão uploaderType fornece mais detalhes sobre como usar essa dimensão.
uploadType (dimensão principal) (usado somente em relatórios do proprietário do conteúdo)
Essa dimensão permite indicar se uma resposta da API deve conter métricas de conteúdo enviado pelo proprietário especificado e/ou por terceiros, como vídeos enviados pelo usuário. Os valores válidos são self e thirdParty. Essa é uma dimensão principal e está sujeita à política de descontinuação.

A tabela abaixo mostra as combinações aceitas nas dimensões claimedStatus e uploaderType, que são usadas no parâmetro filters:

Valor claimedStatus Valor 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 De terceiros Recupera dados para o conteúdo reivindicado enviado por um terceiro.

Exemplos

Muitas das solicitações de API de exemplo para relatórios do proprietário do conteúdo usam uma combinação compatível das dimensões claimedStatus e uploaderType para filtrar os dados.