Dimensions

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 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 horário, você escolhe o período para o qual 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 sua solicitação, use o parâmetro dimensions para especificar as dimensões que o YouTube usará para calcular os valores de métrica nos relatórios.

Dimensões principais

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

A lista a seguir identifica as dimensões principais da API.

Confira a lista de APIs do YouTube sujeitas à política de descontinuação para mais informações.

Filtros

Todos os relatórios de consulta oferecem suporte a filtros. Os filtros identificam valores de dimensão que precisam estar presentes no conjunto de dados recuperado. Assim, elas limitam uma resposta da 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 somente os dados de um país específico.

Em uma solicitação para recuperar um relatório de consulta, o parâmetro de solicitação opcional filters especifica os valores de dimensão para os quais você quer filtrar dados. Por exemplo, para recuperar métricas de atividade do usuário para a 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 do relatório 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. Salvo indicação em contrário, essas dimensões são usadas nos relatórios de canal e do 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 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 fazer isso, defina o valor de parâmetro filters como uma lista separada por vírgulas dos IDs de vídeo, playlist ou canal em que 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 YouTube Data, é o valor de um video. propriedade id do recurso. This is a core dimension and is subject to the Deprecation Policy.
playlist
O ID de uma playlist do YouTube. Na API YouTube Data, esse é o valor da propriedade id de um recurso playlist.
channel (dimensão principal) (usado somente em relatórios do proprietário do conteúdo)
O ID de um canal do YouTube. Na API YouTube Data, esse é 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 esses relatórios normalmente agregam dados para vários canais.
grupo (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 filtro group, a resposta da API contém dados para todos os vídeos, playlists ou canais desse grupo.

Exemplos

Os seguintes exemplos de solicitação usam filtros ou dimensões de entidade de relatórios:

  • Exemplos de canal

    • Estatísticas básicas
      • 10 mais – Vídeos mais assistidos para um canal
      • 10 mais – Taxas de cliques de anotação para os vídeos mais visualizados de um canal
      • Estatísticas de uma playlist específica
      • 10 mais – Playlists mais assistidas para um canal
    • Área geográfica
      • 10 mais – Vídeos mais visualizados em um país específico
      • 10 mais – Vídeos mais visualizados 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 cliques de anotação para os vídeos mais visualizados de um canal
      • 10 mais – Playlists mais assistidas para um proprietário de conteúdo
    • Área geográfica
      • 10 mais - Vídeos mais assistidos na Europa para um proprietário do conteúdo
      • 10 mais – Playlists mais iniciadas nos Estados Unidos

Áreas geográficas

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

país (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) ou FR (França). O código do país ZZ é usado para informar métricas nas quais 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 informar métricas sobre as quais o YouTube não identificou o estado associado aos EUA. Quando uma solicitação de API inclui province no valor de parâmetro dimensions, ela também precisa restringir os dados aos Estados Unidos, incluindo country==US no valor do parâmetro filters.

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

dma
O identificador de três dígitos que a Nielsen usa para identificar a Área designada do mercado (DMA) associados 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 1o de janeiro de 2022.
continent (somente filtro)
Um código regional estatístico da Organização das Nações Unidas (ONU). A API aceita 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 atributo filters para continent==REGION_CODE, especificando um valor REGION_CODE da tabela.
subContinent (somente filtro)
Um código regional estatístico da ONU que identifica uma sub-região geográfica. A Divisão de Estatística 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 como subContinent==REGION_CODE, especificando um valor REGION_CODE da lista das Nações Unidas.

Exemplos

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

  • Exemplos de canal

    • Estatísticas básicas: contagens de visualizações específicas de um país (e mais) para um canal
    • Área 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 por província para os estados dos EUA e 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 as contagens de visualizações diárias e o tempo de exibição em diferentes locais.
    • Origem do tráfego: contagens 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)
    • Vídeos mais acessados
      • 10 mais – Vídeos mais visualizados em um país específico
      • 10 mais – Vídeos mais visualizados na Europa

  • Exemplos de proprietários de conteúdo

    • Estatísticas básicas: contagens de visualizações específicas de um país (e mais) para todos os vídeos enviados automaticamente
    • Área 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 por província para os estados dos EUA e Washington D.C.
      • Métricas de tempo de exibição específicas do país para as playlists de um proprietário do conteúdo
      • 10 mais – Playlists mais iniciadas nos Estados Unidos
    • Local da reprodução: mostra as contagens de visualizações diárias e o tempo de exibição em diferentes locais.
    • Informações demográficas: informações demográficas dos espectadores na Califórnia (idade e gênero)
    • Vídeos mais acessados: 10 vídeos mais assistidos na Europa para um proprietário de conteúdo
    • Receita/desempenho do anúncio: métricas de receita e performance de anúncios 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 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 à 0h do horário do Pacífico (UTC-7 ou UTC-8) e termina às 23h59 do 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 é referente ao período que começa às 0h, horário do Pacífico (UTC-7 ou UTC-8) do primeiro dia do mês e 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 de visualização diária com base na maneira como os usuários chegam aos 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 de API usar a dimensão month, os parâmetros start-date e end-date precisarão 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 canal

    • Baseado no horário
      • 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 em um canal
    • Local da reprodução: mostra as contagens de visualizações diárias e o tempo de exibição em diferentes locais.
    • Origem do tráfego: exibe as contagens de visualizações diárias e o 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 horário
      • 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 da playlist de um proprietário do conteúdo
    • Local da reprodução: mostra as contagens de visualizações diárias e o tempo de exibição em diferentes locais.
    • Origem do tráfego: exibe as contagens de visualizações diárias e o 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 performance de anúncios.

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 do 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 esta dimensão são:

  • BROWSE – Os dados descrevem as visualizações que ocorreram na página ou 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 <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 do YouTube, incluindo dispositivos móveis.

    Desde 10 de setembro de 2013, as reproduções não são mais categorizadas como reproduções do MOBILE nos relatórios do YouTube Analytics. O valor pode permanecer nos relatórios porque 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 app em que ocorrerem.

  • SEARCH – Os dados descrevem as visualizações que ocorreram diretamente na página de resultados de pesquisa do YouTube.

  • WATCH – Os dados descrevem as visualizações que ocorreram na página de exibição do YouTube do vídeo ou em um aplicativo oficial do YouTube, como o aplicativo do 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 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 canal

    • Local da reprodução
      • Contagens de exibições e tempo de exibição de diferentes locais de reprodução
      • Contagens de visualizações 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ções de playlists e tempo de exibição de diferentes locais de reprodução
      • Contagens diárias de visualizações em playlists e tempo de exibição em 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ções 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ções de playlists e tempo de exibição de diferentes locais de reprodução
      • Contagens diárias de visualizações em playlists e tempo de exibição em diferentes locais de 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 iniciadas em 1o de janeiro de 2019.

A tabela a seguir lista os valores de dimensão:
Valores
LIVE_STREAM O conteúdo assistido era uma transmissão ao vivo do YouTube.
SHORTS O conteúdo assistido era um Short do YouTube.
STORY O conteúdo assistido era uma História do YouTube.
VIDEO_ON_DEMAND O conteúdo visualizado era um vídeo do YouTube que não se enquadra em um 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 às visualizações de uma transmissão ao vivo. Os dados dessa dimensão estão disponíveis para datas que começam em 1o 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.
subscribedStatus
Esta dimensão indica se as métricas de atividade do usuário na linha de dados estão associadas aos 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 é exato a partir do momento em que ocorre a atividade do usuário. Por exemplo, suponha que um usuário não tenha se inscrito em um canal e assista a um dos vídeos desse canal, depois se inscreva no canal e assista 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
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 aplicativos especiais do YouTube (YouTube Gaming, YouTube Kids ou YouTube Music). Exceção: atividades do usuário que ocorreram 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 a partir de 1o de março de 2021. 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
Os dados no 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 esta dimensão são:
  • ADVERTISING – O espectador foi direcionado ao vídeo por um anúncio. Se você filtrar com base nessa 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 enviados por um usuário que o proprietário do conteúdo usou para promover o conteúdo visualizado. Esta origem de tráfego só é compatível com 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 nessa origem de tráfego, o campo insightTrafficSourceDetail 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 hashtags de VOD ou de páginas temáticas de hashtags dos Shorts.
  • LIVE_REDIRECT: as exibições de vídeo foram direcionadas do recurso Redirecionar 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 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 de vídeo ocorreram enquanto o vídeo era reproduzido como parte de uma lista de reprodução. Isso inclui o tráfego que vem da página 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 os "Vídeos do momento" do YouTube página.
  • 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 desse vídeo.
  • SHORTS – O espectador foi indicado deslizando verticalmente do vídeo anterior na experiência de visualização de Shorts.
  • SOUND_PAGE – Visualizações originadas de páginas temáticas de áudio nos 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 nessa origem de tráfego, o campo insightTrafficSourceDetail especificará os itens do feed da página inicial ou outra página de origem das visualizações.
  • 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 desse canal.
  • YT_OTHER_PAGE – As exibições de vídeo foram direcionadas de um link diferente de 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 campo insightTrafficSourceDetail vai identificar a página.
  • YT_SEARCH – As exibições de vídeo foram direcionadas a partir dos resultados da pesquisa do YouTube. Se você filtrar com base nessa origem de tráfego, o campo insightTrafficSourceDetail especificará o termo de pesquisa.
  • VIDEO_REMIXES – As exibições de vídeos foram direcionadas do link do vídeo remixado no player dos Shorts. Se você filtrar com base nesta origem de tráfego, o campo insightTrafficSourceDetail especificará o vídeo de onde o espectador foi indicado.
insightTrafficSourceDetail
Os dados do relatório são agregados com base nos referenciadores que geraram o maior número de visualizações para um determinado vídeo e um determinado tipo de origem de tráfego. A lista a seguir identifica as origens do tráfego para as quais 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 publicidade que gerou as visualizações. Os valores possíveis são:
    • Anúncio de engajamento clique para ver
    • Anúncio de engajamento
    • Anúncios 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
    • Mural de vídeos
  • CAMPAIGN_CARD – O vídeo reivindicado que direcionou os espectadores ao vídeo identificado no relatório.
  • END_SCREEN – O vídeo que direcionou os espectadores ao vídeo identificado no relatório.
  • EXT_URL – O site que encaminhou os espectadores ao vídeo.
  • HASHTAGS: a hashtag que gerou as visualizações.
  • NOTIFICATION – O e-mail ou a notificação que deu origem ao tráfego.
  • RELATED_VIDEO – O vídeo relacionado que direcionou os espectadores ao vídeo abordado no relatório.
  • SOUND_PAGE – O vídeo que gerou as visualizações.
  • SUBSCRIBER – O item de 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 resultantes de atividades não sociais e que não são de upload nos canais, incluindo curtidas, 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 de Podcasts.
    • sdig – Visualizações originadas de e-mails de atualização de inscrições.
    • uploaded – Visualizações de itens uploaded nos feeds de inscrição da página inicial.
    • / – Outras visualizações originadas da página inicial do YouTube.
    • /my_subscriptions – Visualizações originadas de usuários páginas Minhas inscrições 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 para o vídeo.
  • YT_SEARCH – O termo de pesquisa que direcionou 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 canal

    • 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çõ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
      • 10 mais – Termos da Pesquisa Google que geram mais tráfego para um vídeo
      • as contagens de visualizações da playlist e o tempo de exibição de diferentes origens de tráfego em um país;
      • Contagens de visualizações diárias 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çõ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
      • 10 mais – Termos da Pesquisa Google que geram mais tráfego para um vídeo
      • as contagens de visualizações da playlist e o tempo de exibição de diferentes origens de tráfego em um país;
      • Contagens de visualizações diárias 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 a seguir identifica os tipos de dispositivos para os quais a API retorna dados. Você também pode usar a dimensão deviceType como filtro para restringir um relatório de sistema operacional para conter 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 para conter 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 canal

    • 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 a entender a faixa etária e a distribuição por gênero do seu público. A Central de Ajuda do YouTube contém informações adicionais sobre os dados demográficos nos relatórios do 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 canal

    • Informações demográficas
      • Informações demográficas dos espectadores na Califórnia (idade e gênero)
      • Informações demográficas dos espectadores 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 dos espectadores 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. e

A tabela a seguir lista os valores de dimensão válidos:
Serviço de compartilhamento Valor da API
Ameba AMEBA
E-mail do Android 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
gosma GOO
Google+ GOOGLEPLUS
Enviar 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 da atividade do sistema iOS IOS_SYSTEM_ACTIVITY_DIALOG
História da 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 (楽天の場) RAKUTEN
reddit REDDIT
Skype SKYPE
Skyrock SKYBLOG
Conversas da Sony 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 canal

    • 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 entre a parte decorrido do vídeo e a duração dele. 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 a dimensão elapsedVideoTimeRatio é a medição do tempo. Por exemplo, um valor de 0.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 de 0.01 a 1.0. Os momentos 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 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 e AD_INDISPLAY. Acesse a Central de Ajuda do YouTube para mais informaçõ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 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 posterior a 1o de julho de 2008.

Exemplos

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

transmissão ao vivo;

livestreamPosition
Esta dimensão especifica um minuto específico durante um stream de vídeo ao vivo. Métricas de relatório indicam quantos usuários estavam assistindo à transmissão ao vivo naquele momento.

Cancelamentos de assinaturas

membershipsCancellationSurveyReason
O número de pesquisas feitas por usuários do YouTube que cancelaram os Clubes dos canais 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 afirmou que os benefícios de assinatura prometidos 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 está mais interessado nos Clubes dos canais.
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 pretendia participar por tempo limitado.
OTHER O usuário tinha outro motivo para o cancelamento.

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 exibidos durante as reproduções do vídeo. A lista a seguir explica possíveis valores de dimensão. Acesse a Central de Ajuda do YouTube para mais informações sobre os formatos de publicidade no YouTube.

  • auctionBumperInstream – Anúncios em vídeo não puláveis, posicionados por leilão, de até 6 segundos que precisam ser assistidos antes da exibição do vídeo.

  • auctionDisplay – Um anúncio gráfico ou rich media que aparece como 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 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 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 por reserva, com até seis segundos de duração que precisam ser assistidos antes da exibiçã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 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 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 aparece na página inicial e pode incluir elementos gráficos e de vídeo.

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

  • unknown – O YouTube não conseguiu classificar este tipo de anúncio.

Exemplos

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

  • Exemplos de canal

    • Receita/anúncios
      • Receita do canal e métricas de performance de anúncios
      • Métricas diárias de receita e desempenho de anúncios
      • Métricas de receita e performance de anúncios específicas do país
      • 10 mais – Vídeos com a maior receita
      • 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 de receita e desempenho de anúncios
      • Métricas de receita e performance de anúncios específicas do país
      • 10 mais – Vídeos com a maior receita
      • 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ídeo que ocorreram na contexto de uma playlist.

Exemplos

Todas as solicitações de exemplo que recuperam relatórios de playlists 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 aceita das dimensões claimedStatus e uploaderType, conforme definido abaixo.
reivindicadoStatus (usado somente 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 esta dimensão é claimed. Se o parâmetro filters restringir a consulta a claimedStatus==claimed, a API vai recuperar apenas os dados do conteúdo reivindicado. A tabela na definição da dimensão uploaderType oferece mais detalhes sobre como usar essa dimensão.
UploadType (dimensão principal) (usado somente em relatórios do proprietário do conteúdo)
Esta dimensão permite indicar se uma resposta da API deve conter métricas para o conteúdo enviado pelo proprietário do conteúdo especificado e/ou enviado 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 compatíveis com as 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 thirdParty Recupera dados para o conteúdo reivindicado enviado por um terceiro.

Exemplos

Muitos dos exemplos de solicitações de API 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.