Este documento define as dimensões compatíveis com a API YouTube Reporting. Esta API recupera relatórios em massa que contêm dados do YouTube Analytics sobre um canal ou proprietário do conteúdo.
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 em massa aceita uma lista predefinida de dimensões e, nos relatórios, cada linha de dados tem uma combinação exclusiva de valores de dimensão. Dessa forma, a combinação de valores de dimensão de cada linha funciona como a chave primária dessa linha. Não é preciso especificar nem ter a opção de especificar quais dimensões serão incluídas no relatório.
Dimensões principais
A API YouTube Reporting está sujeita à política de descontinuação definida nos 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. Todas elas também são dimensões principais na API YouTube Analytics.
Confira a lista de APIs do YouTube sujeitas à política de descontinuação para mais informações.
Dimensões
As seções a seguir definem as dimensões usadas nos relatórios em massa da API YouTube Reporting. Salvo indicação em contrário, essas dimensões são usadas nos relatórios de canal e do proprietário do conteúdo.
Recursos
Estas dimensões correspondem aos recursos que os canais e proprietários de conteúdo gerenciam no YouTube:
- video_id (dimensão principal)
- É o ID de um vídeo do YouTube. Na API YouTube Data, é o valor de um
video
. propriedadeid
do recurso. This is a core dimension and is subject to the Deprecation Policy. - playlist_id
- O ID de uma playlist do YouTube. Na API YouTube Data, esse é o valor da propriedade
id
de um recursoplaylist
. - channel_id (dimensão principal)
- O ID de um canal do YouTube. Na API YouTube Data, esse é o valor da propriedade
id
de um recursochannel
. This is a core dimension and is subject to the Deprecation Policy. - asset_id (usado somente em relatórios do proprietário do conteúdo)
- O ID de um recurso gerenciado no sistema Content ID do YouTube. Um ativo é a representação de sua propriedade intelectual nesse sistema. No site do YouTube, você pode localizar os IDs de recursos no Gerenciador de conteúdo do YouTube. Também é possível recuperá-los usando a API YouTube Content ID.
Á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.
- country_code (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 do paísZZ
é 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_code
- 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) ouUS-TX
(Texas). O código da provínciaUS-ZZ
é usado para informar métricas sobre as quais o YouTube não identificou o estado associado aos EUA.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.
Períodos
- date (dimensão principal)
- Essa dimensão identifica a data associada às métricas em cada linha do relatório. Em massa
a data se refere ao período que começa à meia-noite (horário do Pacífico) e termina às
23h59 (horário do Pacífico) do dia, mês e ano especificados. Dependendo da época do ano,
O horário do Pacífico é UTC-7 ou UTC-8.
As datas normalmente representam um período de 24 horas, mas 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 datas em que os relógios são ajustados para trás representam um período de 25 horas. This is a core dimension and is subject to the Deprecation Policy.
Locais de reprodução
Essas dimensões fornecem insights sobre a página ou o aplicativo em que a atividade do usuário ocorreu.
- playback_location_type
-
Essa dimensão identifica o tipo de página ou aplicativo em que ocorreu a atividade do usuário. A tabela a seguir lista os valores de dimensão:
Valores 0
Os dados se referem a atividades que ocorreram na página de exibição do YouTube do vídeo ou em um aplicativo oficial do YouTube, como o app YouTube para Android. 1
Os dados são referentes a atividades que ocorreram em outro site ou app em que o vídeo foi incorporado usando uma incorporação de <iframe>
ou<object>
.2
Os dados são referentes às atividades que ocorreram na página de um canal do YouTube. 5
Os dados pertencem a métricas que não podem ser classificadas em um dos outros tipos de local listados. 7
Os dados pertencem a visualizações que ocorreram na página ou na tela inicial do YouTube, no feed de inscrições do usuário ou em outro recurso de navegação do YouTube. 8
Os dados se referem a visualizações que ocorreram diretamente na página de resultados da pesquisa do YouTube. 10
Os dados se referem às visualizações no feed do YouTube Shorts. - playback_location_detail
- Esta dimensão especifica o URL ou aplicativo em que a reprodução ocorreu. Essa dimensão só é compatível com visualizações que ocorreram em players incorporados, o que significa que o valor da dimensão é preenchido apenas nas linhas em que o valor é
1
. Em outras linhas, o valor dessa dimensão está vazio.
Detalhes da reprodução
- live_or_on_demand
- 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. onDemand
Os dados da linha descrevem a atividade do usuário que não ocorreu durante uma transmissão ao vivo. - subscribed_status
- 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
eunsubscribed
.
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 valorsubscribed_status
desubscribed
e uma visualização tem um valorsubscribed_status
deunsubscribed
.
Origens de tráfego
- traffic_source_type
- Essa dimensão identifica o tipo de referenciador associado às métricas de atividade do usuário. O tipo de referenciador descreve a maneira como os usuários chegaram ao vídeo ou canal associado à linha de dados do relatório. A tabela a seguir lista os valores de dimensão:
Valores 0
Direto ou desconhecido
Este valor abrange o tráfego direto para uma página, bem como páginas cujo referenciador é desconhecido. Em relatórios de consulta, esse tipo de origem de tráfego é identificado comoNO_LINK_OTHER
ouUNKNOWN_MOBILE_OR_DIRECT
.1
Publicidade no YouTube
O espectador foi direcionado ao vídeo por um anúncio. Em um relatório de origem do tráfego, se o valor dessa dimensão for1
, a dimensão traffic_source_detail vai identificar o tipo de publicidade que foi mostrada ao espectador. Em relatórios de consulta, esse tipo de origem de tráfego é identificado comoADVERTISING
. Os valores possíveis são:Valores ctp_engagement_ad
Anúncio de engajamento clique para ver engagement_ad
Anúncio de engajamento googlemediaads
Anúncios de pesquisa do Google insearch_display
TrueView na pesquisa e em Display instream
TrueView in-stream instream-select
In-stream pulável reservado unknown
Publicidade no YouTube sem classificação video_wall
Mural de vídeos yva
Anúncio em vídeo na página inicial 3
Recursos de navegação
O espectador foi direcionado de uma página do YouTube que leva a vídeos ou canais. Em um relatório de origem do tráfego, se o valor dessa dimensão for3
, a dimensão traffic_source_detail vai identificar o recurso que encaminhou o tráfego. Em relatórios de consulta, esse tipo de origem de tráfego é identificado comoSUBSCRIBER
. Os valores possíveis são:Valores explore
Crianças: explore learning
Crianças: aprendendo music
Feed de música my-history
Histórico de exibição my-subscriptions
Minhas inscrições my-uploads
Meus uploads podcasts
Página de destino de podcasts shows
Crianças: programas watch-later
Assistir mais tarde what-to-watch
O que assistir 4
Canais do YouTube
Os espectadores foram direcionados de uma página do canal do YouTube. Em um relatório de origem do tráfego, se o valor dessa dimensão for4
, a dimensão traffic_source_detail especificará o ID desse canal. Em relatórios de consulta, esse tipo de origem de tráfego é identificado comoYT_CHANNEL
.5
Pesquisa do YouTube
Os espectadores foram direcionados dos resultados da pesquisa do YouTube. Em um relatório de origem do tráfego, se o valor dessa dimensão for5
, a dimensão traffic_source_detail especificará o termo de pesquisa associado. Em relatórios de consulta, esse tipo de origem de tráfego é identificado comoYT_SEARCH
.7
Vídeos sugeridos
Os espectadores foram direcionados de uma listagem de vídeos relacionados em outra página de exibição de vídeo. Em um relatório de origem do tráfego, se o valor dessa dimensão for7
, a dimensão traffic_source_detail vai identificar o ID desse vídeo. Em relatórios de consulta, esse tipo de origem de tráfego é identificado comoRELATED_VIDEO
ouYT_RELATED
.8
Outros recursos do YouTube
Os espectadores foram direcionados de uma página do YouTube que não se enquadra em um dos outros tipos de origem de tráfego listados. Em um relatório de origem de tráfego, se o valor dessa dimensão for8
, a dimensão traffic_source_detail vai identificar o URL da página. Em relatórios de consulta, esse tipo de origem de tráfego é identificado comoYT_OTHER_PAGE
. Os valores possíveis são:Valores g-crec
Canais recomendados offline
Off-line promotion
Promoção de parceiros unknown
Desconhecido widget
Widget da tela inicial do Android youtu.be
youtu.be ytremote
YouTube Remoto 9
Externo
Os leitores foram direcionados de um link em outro site. Essa origem de tráfego inclui referências dos resultados da Pesquisa Google. Em um relatório de origem do tráfego, se o valor dessa dimensão for9
, a dimensão traffic_source_detail vai identificar a página da Web externa. Em relatórios de consulta, esse tipo de origem de tráfego é identificado comoEXT_URL
.11
Cards e anotações de vídeo
Os espectadores eram direcionados quando clicavam em uma anotação ou em um card de outro vídeo. Em relatórios de consulta, esse tipo de origem de tráfego é identificado comoANNOTATION
.14
Playlists
As visualizações ocorreram enquanto o vídeo era reproduzido como parte de uma playlist. Em relatórios de consulta, essa origem de tráfego é identificada comoPLAYLIST
.
Essa origem de tráfego é diferente do tipo de origem18
, que indica que as visualizações se originaram da página que lista todos os vídeos na playlist.17
Notificações
Os espectadores foram direcionados por um e-mail ou notificação do YouTube. Em relatórios de consulta, esse tipo de origem de tráfego é identificado comoNOTIFICATION
. Os valores possíveis são:Valores inbox
push
sdig
Visualizações originadas de notificações que fizeram parte do resumo por e-mail dos inscritos uploaded_other
Visualizações originadas de notificações não push, como notificações por e-mail ou na caixa de entrada. enviado aos inscritos quando um vídeo é enviado uploaded_push
Visualizações originadas de notificações push enviadas aos inscritos quando um vídeo foi enviado 18
Páginas de playlists
Visualizações originadas de uma página que lista todos os vídeos de uma playlist. Em relatórios de consulta, essa origem de tráfego é identificada comoYT_PLAYLIST_PAGE
.
Essa origem de tráfego é diferente do tipo de origem14
, que indica que as visualizações ocorreram enquanto o vídeo era reproduzido como parte de uma playlist.19
Programação com base em conteúdo reivindicado
Visualizações se originaram de vídeos reivindicados enviados por usuários e usados pelo proprietário do conteúdo para promover o conteúdo assistido. Em relatórios de consulta, essa origem de tráfego é identificada comoCAMPAIGN_CARD
. Esta origem de tráfego só é compatível com relatórios do proprietário do conteúdo.20
Tela final de vídeo interativo
As visualizações se originaram da tela final de outro vídeo. Em relatórios de consulta, esse tipo de origem de tráfego é identificado comoEND_SCREEN
.23
Histórias
O espectador foi indicado deslizando verticalmente do vídeo anterior na experiência de visualização das Histórias.24
Shorts
O espectador foi indicado deslizando verticalmente do vídeo anterior na experiência de visualização de Shorts.25
Páginas de produtos
Os vídeos em uma página de produto atraíram os espectadores para outro canal.26
Páginas de hashtags
As visualizações vieram das páginas de hashtag de VOD ou de páginas temáticas de hashtag dos Shorts.27
Páginas da música
Visualizações originadas das páginas temáticas de áudio dos Shorts.28
Redirecionar em tempo real
As visualizações originadas no recurso Redirecionar em tempo real.30
Vídeo remixado
As visualizações vieram de um link de vídeo remixado no player dos Shorts.31
Feed vertical de conteúdo ao vivo
Visualizações provenientes do feed de live vertical.32
Vídeo relacionado
Visualizações originadas de um link de vídeo relacionado no player dos Shorts. - traffic_source_detail
- Essa dimensão oferece mais detalhes sobre a origem do tráfego do valor da dimensão traffic_source_type da linha. Esse valor de dimensão é preenchido para os seguintes valores de dimensão traffic_source_type:
1
– O valor da dimensão identifica o tipo de publicidade que foi exibida ao espectador. Consulte a definição traffic_source_type para ver uma lista de valores possíveis.3
– O valor da dimensão identifica o recurso do YouTube que gerou o tráfego de referência. Consulte a definição traffic_source_type para ver uma lista de valores possíveis.4
– O valor da dimensão especifica o ID do canal a partir do qual o espectador foi indicado.5
: o valor da dimensão especifica o termo de pesquisa que levou ao tráfego de referência.7
– O valor da dimensão identifica o vídeo a partir do qual o espectador foi indicado.8
– O valor da dimensão identifica o tipo de página do YouTube que gerou o tráfego de referência. Consulte a definição traffic_source_type para ver uma lista de valores possíveis.9
– O valor da dimensão identifica a página externa da qual o tráfego foi encaminhado.17
– O valor da dimensão identifica o tipo de notificação que levou ao tráfego indicado. Consulte a definição traffic_source_type para ver uma lista de valores possíveis.19
– O valor da dimensão identifica o vídeo a partir do qual o espectador foi indicado.20
– O valor da dimensão identifica o vídeo a partir do qual o espectador foi indicado.25
: o valor da dimensão identifica o ID do produto, que é um ID do Mapa de informações do Google.26
– O valor da dimensão identifica a hashtag que gerou o tráfego de referência.27
– O valor da dimensão identifica o vídeo a partir do qual o espectador foi indicado.28
– O valor da dimensão especifica o ID do canal que indicou o espectador pelo Redirecionamento em tempo real.30
– O valor da dimensão especifica o vídeo a partir do qual o espectador foi indicado.
Dispositivos
- device_type
- Essa dimensão identifica o formato físico do dispositivo em que a visualização ocorreu.
A tabela a seguir lista os valores de dimensão válidos:
Valores 100
Desconhecido 101
Computador 102
TV 103
Console de jogos 104
Dispositivo móvel 105
Tablet - operating_system
- Essa dimensão identifica o sistema de software do dispositivo em que a visualização ocorreu.
A tabela a seguir lista os valores de dimensão válidos:
Valores 1
Outro 2
Windows 3
Windows Mobile 4
Android 5
iOS 6
Symbian 7
Blackberry 9
Macintosh 10
Playstation 11
Bada 12
WebOS 13
Linux 14
Hiptop 15
MeeGo 16
Wii 17
Xbox 18
PlayStation Vita 19
Smart TV 20
Nintendo 3DS 21
Chromecast 22
Tizen 23
Firefox 24
RealMedia 25
KaiOS 26
Roku 27
Nintendo Switch 28
Apple tvOS 29
Disparar SO 30
ChromeOS 31
Vidaa
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.
- age_group (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:
AGE_13_17
AGE_18_24
AGE_25_34
AGE_35_44
AGE_45_54
AGE_55_64
AGE_65_
- 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
eGENDER_OTHER
. This is a core dimension and is subject to the Deprecation Policy.
Engajamento e compartilhamento de conteúdo
- sharing_service (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:
Valores 0
Desconhecido 1
Digg 4
reddit 5
StumbleUpon 6
mixi 7
Yahoo! Japan 8
gosma 9
Ameba 10
Facebook 11
Myspace 12
NUjij 18
Tuenti 20
Menéame 21
Wykop 22
Skyrock 25
Fotka 28
hi5 31
Twitter 32
Cyworld 34
Blogger 36
VKontakte (Контакте) 37
Rakuten (楽天の場) 38
LiveJournal 39
Odnoklassniki (Одноклассники) 40
tumblr. 42
LinkedIn 43
Google+ 44
Weibo 45
Pinterest 46
E-mail 47
Facebook Messenger 49
WhatsApp 50
Hangouts 51
Gmail 52
Kakao (kakao talk) 53
Outro 55
Copiar para a área de transferência 59
Incorporar 60
Mensagem de texto 61
Mensagens do Android 62
Mensagens da Verizon 63
Mensagem de texto da HTC 64
Conversas da Sony 65
Enviar SMS 66
E-mail da LGE 67
Linha 68
Viber 69
Kik 70
Skype 71
BlackBerry Messenger 72
WeChat 73
História da KAKAO 74
Dropbox 75
Telegram 76
Páginas do Facebook 77
GroupMe 78
E-mail do Android 79
Mensagens da Motorola 80
Compartilhar por proximidade 81
Naver 82
Caixa de diálogo da atividade do sistema iOS 83
Caixa de entrada do Google 84
Android Messenger 85
YouTube Music 86
YouTube Gaming 87
YouTube Kids 88
YouTube TV
Consulte os documentos de ajuda para mais informações.
Anotações
- annotation_type
- Esta dimensão identifica a maneira como a anotação é exibida durante o vídeo. A tabela a seguir lista os possíveis valores de dimensão:
Valores 0
Desconhecido 1
Observação 3
Destaque 4
Título 8
Balão de diálogo 9
Rótulo 10
Marca-d'água de branding 11
Vídeo em destaque 12
Playlist em destaque 30
o que fazer agora - annotation_id
- O ID que o YouTube usa para identificar uma anotação de forma exclusiva.
Cards
- card_type
- Essa dimensão identifica o tipo de card que foi exibido ao usuário. A tabela a seguir lista os possíveis valores de dimensão:
Valores 0
Desconhecido 60
Link 61
Arrecadação de fundos 62
Vídeo 63
Playlist 65
Financiamento por fãs 66
Produtos 68
Site associado 69
Canal - card_id
- O ID que o YouTube usa para identificar um cartão de forma exclusiva.
Telas finais
- end_screen_element_type
- Esta dimensão identifica o tipo de elemento da tela final que foi exibido ao usuário. A tabela abaixo lista os tipos de elementos da tela final e os valores deles:
Valores 501
Vídeo: o elemento promove outro vídeo do YouTube. 502
Playlist: o elemento promove a playlist do YouTube. 503
Site: o elemento vincula ao site associado. 504
Canal: o elemento vincula a outro canal. 505
Inscrever-se: o elemento incentiva as inscrições no seu canal. 506
Associado 507
Financiamento coletivo: o elemento vincula a um site de financiamento coletivo aprovado. 508
Produtos: o elemento vincula a um site de produtos aprovado. 509
Envio recente - O elemento vincula ao vídeo enviado mais recentemente pelo seu canal. 510
O melhor para o espectador - end_screen_element_id
- O ID que o YouTube usa para identificar de forma exclusiva um elemento da tela final.
Legendas
- subtitle_language
- Essa dimensão identifica o idioma das legendas usadas por mais tempo durante a visualização. As visualizações para as quais as legendas descritivas estavam desativadas na maior parte não são contabilizadas. Consulte a documentação dos relatórios de canal ou do proprietário do conteúdo para mais informações sobre relatórios que contêm essa dimensão.
- subtitle_language_autotranslated
- Essa dimensão identifica o idioma das legendas traduzidas automaticamente que foi usado por mais tempo durante a visualização. As visualizações para as quais as legendas descritivas estavam desativadas na maior parte não são contabilizadas. Consulte a documentação dos relatórios de canal ou do proprietário do conteúdo para mais informações sobre relatórios que contêm essa dimensão.
Desempenho do anúncio
- ad_type
- A dimensão
ad_type
é 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 tabela a seguir lista possíveis valores de dimensão. Acesse a Central de Ajuda do YouTube para mais informações sobre os formatos de publicidade do YouTube.
Valor Descrição Valor em relatórios de consulta 1
Anúncios em vídeo puláveis (leilão) auctionTrueviewInstream
2
Anúncios de display (leilão) auctionDisplay
3
Anúncios em vídeo não puláveis (leilão) auctionInstream
5
Anúncios de display (reservados) reservedDisplay
6
Anúncios em vídeo não puláveis (reservado) reservedInstream
13
Desconhecido unknown
15
Anúncios em vídeo puláveis (reservados) reservedInstreamSelect
19
Anúncios bumper (leilão) auctionBumperInstream
20
Anúncios bumper (reservados) reservedBumperInstream
Observação:os relatórios de consulta podem ser retornados para alguns outros tipos de anúncios usados anteriormente no YouTube.
Dimensões do proprietário do conteúdo
As dimensões a seguir são usadas somente nos relatórios do proprietário do conteúdo.
- reivindicado_status (usado somente em relatórios do proprietário do conteúdo)
- Essa dimensão indica que uma linha de dados contém apenas métricas para o conteúdo reivindicado. O único valor válido para esta dimensão é
claimed
. A tabela na definição da dimensãouploader_type
oferece mais detalhes sobre como usar essa dimensão.
- Upload_type (dimensão principal) (usado somente em relatórios do proprietário do conteúdo)
- Esta dimensão indica se uma linha de dados contém métricas para conteúdo enviado pelo proprietário do conteúdo especificado e/ou por terceiros, como vídeos enviados pelo usuário. Os valores válidos são
self
ethirdParty
. Esta é uma dimensão principal e está sujeita à política de descontinuação.
A tabela abaixo mostra as combinações compatíveis com as dimensõesclaimed_status
euploader_type
:
Valor claimed_status
Valor uploader_type
Descrição [Não definido] self A linha contém dados do YouTube Analytics para conteúdo reivindicado e não reivindicado enviado pelo proprietário do conteúdo. reivindicados self A linha contém dados do conteúdo reivindicado enviado pelo proprietário do conteúdo. reivindicados thirdParty A linha contém dados do conteúdo reivindicado enviado por um terceiro.