Este documento define as dimensões compatíveis com a API YouTube Reporting. Essa API recupera relatórios em massa com dados do YouTube Analytics para um proprietário de conteúdo ou canal.
As dimensões são critérios comuns usados para agregar dados, como a data em que a atividade do usuário ocorreu ou o país em que os usuários estavam localizados.
Cada relatório em massa aceita uma lista predefinida de dimensões. Em qualquer relatório, cada linha de dados tem uma combinação exclusiva de valores de dimensão. Assim, a combinação de valores de dimensão de cada linha funciona como a chave primária dela. Não é necessário especificar nem é possível especificar quais dimensões são incluídas no relatório.
Dimensões principais
Embora a API YouTube Reporting esteja sujeita à Política de descontinuação definida nos Termos de Serviço, as dimensões e métricas não principais não estão sujeitas à política. Nas definições desta página, qualquer dimensão que seja principal é identificada explicitamente como tal.
A lista a seguir identifica as dimensões principais da API. Todas elas também são dimensões principais na API YouTube Analytics.
Para mais informações, consulte a lista de APIs do YouTube sujeitas à política de descontinuação.
Dimensões
As seções a seguir definem as dimensões usadas nos relatórios em massa da API Reporting do YouTube. A menos que indicado de outra forma, essas dimensões são usadas nos relatórios de canal e de proprietário de conteúdo.
Recursos
Essas 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 Data do YouTube, esse é o valor da propriedade
idde um recursovideo. This is a core dimension and is subject to the Deprecation Policy. - playlist_id
- O ID de uma playlist do YouTube. Na API Data do YouTube, esse é o valor da propriedade
idde um recursoplaylist. - channel_id (dimensão principal)
- O ID de um canal do YouTube. Na API Data do YouTube, esse é o valor da propriedade
idde um recursochannel. This is a core dimension and is subject to the Deprecation Policy. - asset_id (usado apenas em relatórios do proprietário do conteúdo)
- O ID de um recurso gerenciado no sistema do Content ID do YouTube. Um recurso é a representação da propriedade intelectual nesse sistema. No site do YouTube, você pode localizar os IDs de recursos no Gerenciador de conteúdo. Também é possível extraí-los usando a API Content ID do YouTube.
Áreas geográficas
Essas dimensões identificam uma região geográfica associada à atividade do usuário, à performance do anúncio ou às métricas de receita estimada.
- country_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 de paísZZé usado para informar métricas em que o YouTube não conseguiu identificar o país associado. This is a core dimension and is subject to the Deprecation Policy. - province_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 Columbia, como
US-MI(Michigan) ouUS-TX(Texas). O código da provínciaUS-ZZé usado para informar métricas em que o YouTube não conseguiu identificar o estado dos EUA associado.Observação:essa dimensão não oferece suporte a valores ISO 3166-2 que identificam áreas periféricas dos EUA, já que esses territórios também têm seus próprios códigos de país ISO 3166-1. Ele também não oferece suporte a subdivisões de países diferentes dos Estados Unidos.
Períodos
- data (dimensão principal)
- Essa dimensão identifica a data associada às métricas em cada linha do relatório. Nos relatórios em massa, a data se refere ao período que começa às 12h Horário do Pacífico e termina às 23h59 do mesmo dia, mês e ano. Dependendo da época do ano,
o horário do Pacífico é UTC-7 ou UTC-8.
Embora as datas normalmente representem um período de 24 horas, 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. 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 a atividade do usuário ocorreu. A tabela a seguir lista os valores de dimensão:
Valores 0Os dados se referem à atividade que ocorreu na página de exibição do vídeo no YouTube ou em um aplicativo oficial do YouTube, como o app para Android. 1Os dados se referem a atividades que ocorreram em outro site ou aplicativo em que o vídeo foi incorporado usando um <iframe>ou<object>.2Os dados se referem a atividades que ocorreram na página de um canal do YouTube. 5Os dados se referem a métricas que não podem ser classificadas em um dos outros tipos de local listados. 7Os dados se referem a visualizações que aconteceram na página inicial ou na tela inicial do YouTube, no feed de inscrições do usuário ou em outro recurso de navegação do YouTube. 8Os dados se referem às visualizações que aconteceram diretamente na página de resultados da pesquisa do YouTube. 10Os dados se referem às visualizações que aconteceram no feed dos Shorts. - playback_location_detail
- Essa 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 só é preenchido em linhas em que o valor da dimensão é
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 a visualizações de uma transmissão ao vivo. Os dados dessa dimensão estão disponíveis para datas a partir de 1º de abril de 2014.
A tabela a seguir lista os valores da dimensão:
Valores liveOs dados da linha descrevem a atividade do usuário que ocorreu durante uma transmissão ao vivo. onDemandOs dados da linha descrevem a atividade do usuário que não ocorreu durante uma transmissão ao vivo. - subscribed_status
- Essa dimensão indica se as métricas de atividade do usuário na linha de dados estão associadas a espectadores inscritos no canal do vídeo ou da playlist.
Os valores possíveis são
subscribedeunsubscribed.
O valor da dimensão é preciso a partir do momento em que a atividade do usuário ocorre. Por exemplo, suponha que um usuário não tenha se inscrito em um canal e assista um dos vídeos dele, depois se inscreva e assista outro vídeo, tudo no mesmo dia. O relatório do canal indica que uma visualização tem um valor desubscribed_statusdesubscribede outra desubscribed_statusdeunsubscribed.
Origens de tráfego
- traffic_source_type
- Essa dimensão identifica o tipo de referente associado às métricas de atividade do usuário. O tipo de referência descreve a maneira como os usuários acessaram o vídeo ou canal associado à linha de dados no relatório. A tabela a seguir lista os valores de dimensão:
Valores 0Direta ou desconhecida
Esse valor inclui o tráfego direto para uma página, bem como as páginas em que o referrer é desconhecido. Nos relatórios de consulta, esse tipo de origem de tráfego é identificado comoNO_LINK_OTHERouUNKNOWN_MOBILE_OR_DIRECT.1Publicidade do YouTube
O espectador foi direcionado ao vídeo por um anúncio. Em um relatório de origem de tráfego, se o valor dessa dimensão for1, a dimensão traffic_source_detail vai identificar o tipo de anúncio que foi mostrado ao usuário. Nos relatórios de consulta, esse tipo de origem de tráfego é identificado comoADVERTISING. Os valores possíveis são:Valores ctp_engagement_adAnúncio de engajamento clique para ver engagement_adAnúncio de engajamento googlemediaadsAnúncios da Pesquisa Google insearch_displayTrueView in-search e in-display instreamTrueView in-stream instream-selectIn-stream pulável reservado unknownPublicidade no YouTube sem classificação video_wallMural de vídeos yvaAnúncio em vídeo na página inicial 3Recursos de navegação
O espectador foi redirecionado de uma página do YouTube que leva a vídeos ou canais. Em um relatório de origem de tráfego, se o valor dessa dimensão for3, a dimensão traffic_source_detail vai identificar o recurso que indicou o tráfego. Nos relatórios de consulta, esse tipo de origem de tráfego é identificado comoSUBSCRIBER. Os valores possíveis são:Valores exploreCrianças: explorar learningCrianças: aprendizado musicFeed de música my-historyHistórico de exibição my-subscriptionsMinhas inscrições my-uploadsMeus uploads podcastsPágina de destino do podcast showsCrianças: programas watch-laterAssistir mais tarde what-to-watchO que assistir 4Canais do YouTube
Os espectadores foram redirecionados de uma página de canal do YouTube. Em um relatório de origem de tráfego, se o valor dessa dimensão for4, a dimensão traffic_source_detail vai especificar o ID do canal. Nos relatórios de consulta, esse tipo de origem de tráfego é identificado comoYT_CHANNEL.5Pesquisa do YouTube
Os espectadores foram encaminhados dos resultados da pesquisa do YouTube. Em um relatório de origem de tráfego, se o valor dessa dimensão for5, a dimensão traffic_source_detail vai especificar o termo de pesquisa associado. Nos relatórios de consulta, esse tipo de origem de tráfego é identificado comoYT_SEARCH.7Vídeos sugeridos
Os espectadores foram direcionados de uma lista de vídeos relacionados em outra página de exibição de vídeos. 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 do vídeo. Nos relatórios de consulta, esse tipo de origem de tráfego é identificado comoRELATED_VIDEOouYT_RELATED.8Outros recursos do YouTube
Os espectadores foram redirecionados de uma página do YouTube que não se enquadra em nenhum dos outros tipos de origem de tráfego listados. Em um relatório de origem do tráfego, se o valor dessa dimensão for8, a dimensão traffic_source_detail vai identificar o URL da página. Nos relatórios de consulta, esse tipo de origem de tráfego é identificado comoYT_OTHER_PAGE. Os valores possíveis são:Valores g-crecCanais recomendados offlineOff-line promotionPromoção de parceiros unknownDesconhecido widgetWidget da tela inicial do Android youtu.beyoutu.be ytremoteYouTube Remoto 9Externo
Os espectadores foram redirecionados por 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. Nos relatórios de consulta, esse tipo de origem de tráfego é identificado comoEXT_URL.11Anotações e cards de vídeo
Os espectadores foram redirecionados ao clicar em uma anotação ou um card em outro vídeo. Nos relatórios de consulta, esse tipo de origem de tráfego é identificado comoANNOTATION.14Playlists
As visualizações ocorreram enquanto o vídeo era reproduzido como parte de uma playlist. Nos relatórios de consulta, esse tipo de origem do tráfego é identificado comoPLAYLIST.
Essa origem do tráfego é diferente do tipo18, que indica que as visualizações foram originadas da página que lista todos os vídeos da playlist.17Notificações
Os espectadores foram direcionados por um e-mail ou notificação do YouTube. Nos relatórios de consulta, esse tipo de origem de tráfego é identificado comoNOTIFICATION. Os valores possíveis são:Valores inboxpushsdigVisualizações originadas de notificações que faziam parte do resumo do inscrito uploaded_otherVisualizações originadas de notificações não push, como e-mails ou notificações da caixa de entrada, enviadas aos inscritos quando um vídeo foi enviado uploaded_pushVisualizações originadas de notificações push enviadas aos inscritos quando um vídeo foi enviado 18Páginas de playlist
Visualizações originadas de uma página que lista todos os vídeos de uma playlist. Nos relatórios de consulta, esse tipo de origem de tráfego é identificado comoYT_PLAYLIST_PAGE.
Esse tipo de origem de tráfego é diferente do tipo14, que indica que as visualizações ocorreram enquanto o vídeo era reproduzido como parte de uma playlist.19Programação de conteúdo reivindicado
Visualizações originadas de vídeos reivindicados enviados por usuários que o proprietário do conteúdo usou para promover o conteúdo visualizado. Nos relatórios de consulta, essa origem de tráfego é identificada comoCAMPAIGN_CARD. Essa origem de tráfego só tem suporte para relatórios de proprietários de conteúdo.20Tela final interativa do vídeo
Visualizações originadas da tela final de outro vídeo. Nos relatórios de consulta, esse tipo de origem de tráfego é identificado comoEND_SCREEN.23Histórias
O espectador foi encaminhado deslizando verticalmente do vídeo anterior na experiência de visualização das Histórias.24Shorts
O espectador foi redirecionado deslizando verticalmente do vídeo anterior na experiência de visualização dos Shorts.25Páginas de produtos
Os vídeos em uma página de produto levaram os espectadores a outro canal.26Páginas de hashtag
: visualizações originadas de páginas de hashtag de VOD ou de Shorts.27Páginas de música
Visualizações originadas das páginas temáticas de áudio dos Shorts.28Redirecionamento em tempo real
Visualizações originadas de Redirecionamentos em tempo real.29Podcasts
Visualizações originadas da página YouTube Podcasts.30Vídeo remixado
Visualizações originadas de um link de vídeo remixado no player dos Shorts.31Feed vertical ao vivo
Visualizações originadas do feed vertical ao vivo.32Vídeo relacionado
Visualizações originadas de um link de vídeo relacionado no player dos Shorts. - traffic_source_detail
- Essa dimensão fornece mais detalhes sobre a origem do tráfego que o valor da dimensão traffic_source_type da linha. Esse valor é preenchido para os seguintes valores de dimensão traffic_source_type:
1: o valor da dimensão identifica o tipo de anúncio que foi mostrado ao usuário. Consulte a definição de traffic_source_type para conferir uma lista de valores possíveis.3: o valor da dimensão identifica o recurso do YouTube que gerou o tráfego referido. Consulte a definição de traffic_source_type para conferir uma lista de valores possíveis.4: o valor da dimensão especifica o ID do canal de onde o espectador foi encaminhado.5: o valor da dimensão especifica o termo de pesquisa que levou ao tráfego referido.7: o valor da dimensão identifica o vídeo de origem da referência.8: o valor da dimensão identifica o tipo de página do YouTube que levou ao tráfego referido. Consulte a definição de traffic_source_type para conferir uma lista de valores possíveis.9: o valor da dimensão identifica a página externa de onde o tráfego foi encaminhado.17: o valor da dimensão identifica o tipo de notificação que levou ao tráfego referido. Consulte a definição de traffic_source_type para conferir uma lista de valores possíveis.19: o valor da dimensão identifica o vídeo de origem da referência.20: o valor da dimensão identifica o vídeo de origem da referência.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 levou ao tráfego referido.27: o valor da dimensão identifica o vídeo de origem da referência.28: o valor da dimensão especifica o ID do canal de onde o espectador foi redirecionado por Redirecionamentos em tempo real.30: o valor da dimensão especifica o vídeo de origem da referência do espectador.
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 100Desconhecido 101Computador 102TV 103Console de jogos 104Dispositivo móvel 105Tablet - 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 1Outro 2Windows 3Windows Mobile 4Android 5iOS 6Symbian 7Blackberry 9Macintosh 10Playstation 11Bada 12WebOS 13Linux 14Hiptop 15MeeGo 16Wii 17Xbox 18PlayStation Vita 19Smart TV 20Nintendo 3DS 21Chromecast 22Tizen 23Firefox 24RealMedia 25KaiOS 26Roku 27Nintendo Switch 28Apple tvOS 29Fire OS 30ChromeOS 31Vidaa
Informações demográficas
As dimensões demográficas ajudam a entender a faixa etária e a distribuição de gênero do seu público. A Central de Ajuda do YouTube tem mais informações sobre dados demográficos nos relatórios YouTube Analytics.
- age_group (dimensão principal)
- Essa dimensão identifica o grupo de idade dos usuários conectados associados aos dados do relatório. A API usa as seguintes faixas etárias:
AGE_13_17AGE_18_24AGE_25_34AGE_35_44AGE_45_54AGE_55_64AGE_65_
- gênero (dimensão principal)
- Essa dimensão identifica o gênero dos usuários conectados associados aos dados do relatório.
Os valores válidos são
FEMALE,MALEeGENDER_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.
A tabela a seguir lista os valores de dimensão válidos:
Valores 0Desconhecido 1Digg 4reddit 5StumbleUpon 6mixi 7Yahoo! Japan 8goo 9Ameba 10Facebook 11Myspace 12NUjij 18Tuenti 20menéame 21Wykop 22Skyrock 25Fotka 28hi5 31Twitter 32Cyworld 34Blogger 36VKontakte (ВКонтакте) 37Rakuten (楽天市場) 38LiveJournal 39Odnoklassniki (Одноклассники) 40Tumblr. 42LinkedIn 43Google+ 44Weibo 45Pinterest 46E-mail 47Facebook Messenger 49WhatsApp 50Hangouts 51Gmail 52Kakao (Kakao Talk) 53Outro 55Copiar para a área de transferência 59Incorporar 60Mensagem de texto 61Mensagens do Android 62Mensagens da Verizon 63Mensagem de texto da HTC 64Sony Conversations 65Go SMS 66E-mail da LGE 67Linha 68Viber 69Kik 70Skype 71BlackBerry Messenger 72WeChat 73KAKAO Story 74Dropbox 75Telegram 76Páginas do Facebook 77GroupMe 78Android Email 79Motorola Messaging 80Compartilhar por proximidade 81Naver 82Caixa de diálogo de atividade do sistema iOS 83Caixa de entrada do Google 84Android Messenger 85YouTube Music 86YouTube Gaming 87YouTube Kids 88YouTube TV
Consulte os documentos de ajuda para mais informações.
Anotações
- annotation_type
- Essa dimensão identifica a maneira como a anotação aparece durante o vídeo. A tabela a seguir lista os possíveis valores de dimensão:
A Central de Ajuda do YouTube tem mais detalhes sobre os diferentes tipos de anotações e o processo de adicionar anotações aos seus vídeos.Valores 0Desconhecido 1Observação 3Destaque 4Título 8Balão de diálogo 9Rótulo 10Marca-d'água de branding 11Vídeo em destaque 12Playlist em destaque 30o que fazer agora - annotation_id
- O ID que o YouTube usa para identificar exclusivamente uma anotação.
Cartões
- card_type
- Essa dimensão identifica o tipo de card que foi mostrado ao usuário. A tabela a seguir lista os possíveis valores de dimensão:
A Central de Ajuda do YouTube tem mais detalhes sobre os diferentes tipos de cards e o processo de adicionar cards aos seus vídeos.Valores 0Desconhecido 60Link 61Arrecadação de fundos 62Vídeo 63Playlist 65Financiamento por fãs 66Produtos 68Site associado 69Canal - card_id
- O ID que o YouTube usa para identificar um card de forma exclusiva.
Telas finais
- end_screen_element_type
- Essa dimensão identifica o tipo de elemento da tela final que foi mostrado ao usuário. A tabela a seguir lista os tipos de elementos da tela final e os valores deles:
Valores 501Vídeo: o elemento promove outro vídeo do YouTube. 502Playlist: o elemento promove a playlist do YouTube. 503Site: o elemento é vinculado ao site associado. 504Canal: o elemento é vinculado a outro canal. 505Inscrever-se: o elemento incentiva as inscrições no seu canal. 506Associado 507Crowdfunding: o elemento tem um link para um site de financiamento coletivo aprovado. 508Produtos: o elemento vincula a um site de produtos aprovado. 509Envio recente: o elemento é vinculado ao vídeo mais recente enviado no seu canal. 510O melhor para o espectador - end_screen_element_id
- O ID que o YouTube usa para identificar exclusivamente um elemento da tela final.
Legendas
- subtitle_language
- Essa dimensão identifica o idioma da legenda usada por mais tempo durante a visualização. As visualizações em que as legendas descritivas foram desativadas não são contabilizadas. Consulte a documentação dos relatórios de canal ou de proprietários de conteúdo para mais informações sobre os relatórios que contêm essa dimensão.
- subtitle_language_autotranslated
- Essa dimensão identifica o idioma das legendas traduzidas automaticamente usado por mais tempo durante a visualização. As visualizações em que as legendas descritivas foram desativadas não são contabilizadas. Consulte a documentação dos relatórios de canal ou de proprietários de conteúdo para mais informações sobre os 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 veiculados durante a reprodução de vídeo. A tabela a seguir lista os valores de dimensão possíveis. Consulte a Central de Ajuda do YouTube para mais informações sobre os formatos de publicidade do YouTube.
Valor Descrição Valor nos relatórios de consulta 1Anúncios em vídeo puláveis (leilão) auctionTrueviewInstream2Anúncios de display (leilão) auctionDisplay3Anúncios em vídeo não puláveis (leilão) auctionInstream5Anúncios de display (reservado) reservedDisplay6Anúncios em vídeo não puláveis (reservado) reservedInstream13Desconhecido unknown15Anúncios em vídeo puláveis (reservado) reservedInstreamSelect19Anúncios bumper (leilão) auctionBumperInstream20Anúncios bumper (reservado) reservedBumperInstreamObservação:os relatórios de consulta podem retornar alguns outros tipos de anúncios que foram usados anteriormente no YouTube.
Dimensões do proprietário do conteúdo
As dimensões a seguir são usadas apenas nos relatórios de proprietários de conteúdo.
- claimed_status (usado apenas em relatórios do proprietário do conteúdo)
- Essa dimensão indica que uma linha de dados contém apenas métricas para conteúdo reivindicado. O único valor válido para essa dimensão é
claimed. A tabela na definição da dimensãouploader_typefornece mais detalhes sobre como usar essa dimensão.
- uploader_type (dimensão principal) (usado apenas em relatórios de proprietários de conteúdo)
- Essa dimensão indica se uma linha de dados contém métricas de conteúdo enviado pelo proprietário especificado e/ou conteúdo enviado por terceiros, como vídeos enviados por usuários. Os valores válidos são
selfethirdParty. Essa é uma dimensão principal e está sujeita à política de descontinuação.
A tabela abaixo mostra as combinações compatíveis para as dimensõesclaimed_statuseuploader_type:
Valor de claimed_statusValor de uploader_typeDescriçã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. reivindicados self A linha contém dados do conteúdo reivindicado enviado pelo proprietário. reivindicados thirdParty A linha contém dados de conteúdo reivindicado enviado por terceiros.