Registros de alterações da API de gerenciamento do Google Analytics

Atualizamos a API de gerenciamento do Google Analytics periodicamente para oferecer novos recursos e corrigir falhas descobertas nas versões anteriores. Na maioria dos casos, essas alterações ficam evidentes para os desenvolvedores de API. No entanto, às vezes, precisamos fazer alterações que exigem que os desenvolvedores modifiquem os aplicativos existentes.

Esta página documenta todas as alterações feitas na API de gerenciamento do Google Analytics que podem afetar seu aplicativo. Recomendamos que os desenvolvedores de API consultem regularmente esta lista para se manterem informados sobre novos comunicados. Você também pode se inscrever para receber as alterações por meio dos feeds listados na seção Inscrever-se abaixo.

Inscrever-se nos registros de alterações relacionados

Inclui todas as APIs de coleta, configuração e relatórios.

Inclui a API de gerenciamento e a API de aprovisionamento.

Configurações de retenção de dados do usuário na API Management

Agora é possível definir programaticamente as configurações de retenção de dados do usuário usando os novos campos "dataRetentionTtl" e "dataRetentionResetOnNewActivity" no recurso WebProperty.

Operações de gravação na API Management

As operações de gravação na API Management (por exemplo, "create", "update", "delete", "patch") para os recursos de propriedade da Web, vista (perfil) e meta não exigem mais autorização. O limite diário padrão para todas as operações desse tipo na API Management é de 50 gravações. Consulte a página Limites e cotas para mais informações.

Métricas personalizadas

Nesta versão, corrigimos o bug que causava uma falha na criação de métricas personalizadas do tipo TIME quando min_value não era definido. As solicitações sem min_value agora geram uma métrica personalizada com um min_value padrão igual a 0.

Nesta versão, adicionamos os públicos-alvo de remarketing à API Management.

Públicos-alvo de remarketing

A API Management permite realizar as ações create, get, list, update e patch em públicos-alvo de remarketing de uma propriedade do Google Analytics. Consulte o artigo Sobre os públicos-alvo de remarketing no Google Analytics da Central de Ajuda para entender como eles funcionam.

Relatórios sem dados de amostra

A API Unsampled Reports não tem mais um limite de 100 relatórios por dia. A API usa o mesmo sistema de token por propriedade e por dia que a interface da Web utiliza para criar um relatório sem dados de amostra.

Relatórios sem dados de amostra

Os relatórios sem dados de amostra que não são acessíveis ao usuário atual não terão mais um link de download na mensagem de resposta da API Management. Isso é condizente com o painel de IU, em que apenas os proprietários dos relatórios podem conferir o link de download do documento gerado.

Segmentos

Nesta versão, corrigimos um bug em que os segmentos com valores de moeda na definição apareciam incorretamente ao chamar o método da lista de segmentos.

Segmentos

Nesta versão, corrigimos um bug em que os usuários com segmentos privados fixados em várias vistas (perfis) recebiam uma resposta de erro 500 ao chamar o método da lista de segmentos.

Agrupar chamadas

Nesta versão, além do suporte geral a lotes, adicionamos compatibilidade especial à API User Permissions. As solicitações de permissões de usuário em lote terão melhorias significativas de performance e redução no uso de cota.

Vistas (perfis)

Com essa versão, a propriedade currency da vista (perfil) vai passar a usar USD se esse valor não for definido durante uma operação insert. Além disso, as operações get e list retornarão USD em vistas (perfis) que foram criadas anteriormente sem uma propriedade currency.

Filtros

Nesta versão, removemos os campos de filtro descontinuados IS_MOBILE e IS_TABLET, que serão substituídos por DEVICE_CATEGORY=mobile e DEVICE_CATEGORY=tablet. Solicitações de inserção, atualização e correção que usarem IS_MOBILE e IS_TABLET nos campos de filtro vão retornar um erro.

Filtros

Nesta versão, adicionamos suporte para uso de uma dimensão personalizada em um campo de filtro ao incluir uma propriedade fieldIndex em todas as seções de detalhes dele. Por exemplo, agora é possível definir a expressão com "field": "CUSTOM_DIMENSION" e "fieldIndex": "1" para que o filtro funcione na primeira dimensão personalizada.

Metas

Nesta versão, também corrigimos uma falha que aparecia ao criar uma meta com "comparisonValue": "0".

Nesta versão, adicionamos dois novos conjuntos à API Management: dimensões personalizadas e métricas personalizadas.

Dimensões e métricas personalizadas

Agora é possível criar, listar, receber, corrigir e atualizar dimensões e métricas personalizadas com a API Management.

A resposta do método list para todas as coletas agora inclui uma lista vazia para a propriedade items quando a coleta não contém recursos. Anteriormente, a propriedade items seria omitida. Consulte a Referência da API para ver detalhes sobre consultas e respostas dos dados de configuração do Google Analytics.

Nesta versão, adicionamos um novo escopo à API Google Analytics Management. analytics.manage.users.readonly – confira as permissões de usuários do Google Analytics.

Adicionamos um novo campo de filtros DEVICE_CATEGORY, e IS_MOBILE e IS_TABLET foram descontinuados. Use DEVICE_CATEGORY=mobile e DEVICE_CATEGORY=tablet.

As vistas (perfis) agora incluem uma propriedade enhancedECommerceTracking que indica se o e-commerce avançado está ativado (true) ou desativado (false).

Nesta versão, incluímos novos tipos de importação de dados e removemos o recurso dailyUpload.

Importação de dados

Consulte o guia para desenvolvedores sobre a importação de dados e saiba como usar a API Management se quiser importar dados para sua conta do Google Analytics.

Envios

  • O recurso upload agora aceita os seguintes tipos de upload:
    • Dados da campanha
    • Dados de conteúdo
    • Dados de custo
    • Dados do produto
    • Dados de reembolso
    • Dados do usuário
  • O recurso upload tem um novo método migrateDataImport para migrar as customDataSources dos dados de custo.

Descontinuação dos uploads diários

  • O recurso dailyUpload foi descontinuado. Consulte o guia de migração para detalhes sobre como usar a importação de dados.
  • O recurso dailyUpload vai continuar funcionando por mais seis meses. Depois disso, as customDataSources que ainda tiverem a propriedade uploadType definida como analytics#dailyUploads serão migradas automaticamente e só vão funcionar com o recurso upload.
  • Os usuários de dailyUpload têm que atualizar o código e migrar para o recurso de upload o quanto antes.

Nesta versão, adicionamos duas novas APIs de configuração.

Filtros

Relatórios sem dados de amostra: API Management

Adicionamos um novo recurso à API Management, chamado relatórios sem dados de amostra. Eles são relatórios do Google Analytics (GA) que foram gerados sem dados de amostra e,no momento, estão disponíveis apenas para usuários do GA Premium.

Segmentos: API Management v2.4 e v3.0

As seguintes mudanças foram feitas no conjunto de segmentos:

  • Os segmentos de usuário e de sequência agora são compatíveis com a API.
  • O conjunto de segmentos agora retorna todos os segmentos no nível da sessão e do usuário integrados e personalizados.
  • Agora a propriedade definition dos segmentos usará a sintaxe dos novos segmentos. Isso inclui as definições dos segmentos no nível da sessão, que vão mudar de definition: "" para definition: "sessions::condition::".
  • Uma nova propriedade type foi adicionada ao segmento para indicar se ele é CUSTOM (criado por um usuário na interface da Web) ou BUILT_IN (fornecido pelo Google Analytics).

Experimentos

As seguintes métricas do Google AdSense agora podem ser usadas como objetivos de otimização:

  • ga:adsenseAdsClicks – Número de cliques nos anúncios do Google AdSense no seu site.
  • ga:adsenseAdsViewed – Número de anúncios do Google AdSense visualizados. Vários anúncios podem ser exibidos em um bloco.
  • ga:adsenseRevenue – receita total dos anúncios do Google AdSense.

Novo conjunto de resumos de contas

As seguintes mudanças foram feitas nos segmentos padrão por conta da descontinuação das dimensões ga:isMobile e ga:isTablet:

  • O segmento gaid::-11 foi renomeado de Tráfego proveniente de dispositivos móveis para Tráfego de tablet e de dispositivos móveis. A definição dele foi alterada de ga:isMobile==Yes para ga:deviceCategory==mobile,ga:deviceCategory==tablet. ga:isMobile incluía o tráfego de tablets, e isso é refletido na nova definição. Se você quiser apenas o tráfego de smartphones, e não de tablets, mude para o novo segmento Tráfego proveniente de dispositivos móveis (gaid::-14).
  • A definição do segmento gaid::-13 foi alterada de ga:isTablet==Yes para ga:deviceCategory==tablet. Ela continua a representar o tráfego de tablets.
  • Adicionamos o segmento gaid::-14. O nome do segmento é Tráfego proveniente de dispositivos móveis, e a definição é ga:deviceCategory==mobile.

Correções de bugs:

  • Corrigimos as informações sobre fuso horário das vistas (perfis). Detalhes: antes dessa correção, em determinados casos, informações de fuso horário incorretas eram retornadas ao listar a vista (perfil) na API Management. Agora esses dados são consistentes com as definições na interface de administração do Google Analytics.

Nesta versão, adicionamos operações de gravação aos recursos de propriedade da Web, vista (perfil) e meta, além de um conjunto de três novos recursos que permitem o gerenciamento de permissões do usuário.

Configuração da conta e APIs relacionadas

  • Agora é possível criar, atualizar, corrigir e excluir vistas (perfis). Consulte a referência das vistas (perfis) para mais detalhes sobre os novos métodos.
  • Agora é possível criar, atualizar e corrigir propriedades da Web e metas. Leia a referência das propriedades da Web e a referência das metas para mais detalhes sobre os novos métodos.
  • Agora é possível solicitar uma única propriedade da Web, vista (perfil) ou meta com o método get.
  • No momento, esses recursos estão disponíveis como Visualização do desenvolvedor na versão Beta limitada. Se você quiser usá-los, solicite acesso.

Permissões de usuário na API Management

  • O novo recurso accountUserLinks permite que os usuários gerenciem as permissões da conta.
  • Com o novo recurso webpropertyUserLinks, os usuários podem gerenciar as permissões da propriedade.
  • O novo recurso profileUserLinks permite que os usuários gerenciem as permissões da vista (perfil).
  • Agora as permissões para um usuário autorizado estão disponíveis como parte dos recursos de conta, propriedade da Web e vista (perfil).
  • Adicionamos um novo escopo necessário para gerenciar as permissões de usuário. https://www.googleapis.com/auth/analytics.manage.users.
  • Consulte o guia para desenvolvedores sobre o assunto se quiser mais detalhes.

Além dos novos segmentos, lançaremos estas mudanças no conjunto de segmentos:

  • Todos os códigos de segmento serão alterados de strings inteiras positivas para strings alfanuméricas. Se você salvou os IDs de segmento do usuário, recomendamos atualizar para os novos códigos.
  • O conjunto de segmentos só vai retornar os segmentos no nível da visita. No momento, os novos segmentos de visitante, coorte e sequência não são compatíveis com a API.
  • O conjunto vai continuar retornando os segmentos padrão atuais com os mesmos IDs numéricos negativos, mas os novos segmentos padrão ainda não são aceitos.

Nesta versão, adicionamos duas novas propriedades ao recurso de propriedade da Web:

  • profileCount – Retorna a contagem do perfil de uma propriedade. Isso permite que você filtre propriedades sem perfil (ou seja, profileCount = 0).
  • industryVertical – retorna a categoria/segmento do setor selecionado para uma propriedade.

Correções de bugs:

  • A propriedade eCommerceTracking do recurso de perfil agora condiz com as configurações de e-commerce na seção "Administrador" da interface da Web. Retorna true quando o acompanhamento de e-commerce está ativado e false quando não está.
  • Adicionamos um novo endpoint à API Management v3 para acessar e modificar os experimentos.
  • O recurso de perfil agora inclui uma propriedade type que identifica se um perfil está configurado para um site ou app. Os valores possíveis são WEB ou APP.

Nesta versão, adicionamos respostas de erros úteis à API Management.

  • Adicionamos novos códigos de erro, motivos e descrições ao corpo das respostas de erro da API. Todos os códigos foram documentados para as versões 2.4 e 3.0 da API Management.

Nesta versão, adicionamos dados, alteramos a funcionalidade existente e corrigimos um bug.

Novos dados

  • O conjunto de segmentos avançados agora contém um campo segmentId que pode ser usado no parâmetro segment da API Data Export.

Mudou

  • O tipo de dados de max-results mudou para integer.

  • O valor padrão máximo de max-results foi alterado para 1.000.

Correções de bugs

  • Removemos as contas, as propriedades da Web e os perfis dos experimentos do Otimizador de site do Google dos conjuntos correspondentes.

Nesta versão, adicionamos duas novas versões da API com muitos recursos novos e removemos a antiga. As alterações afetam o modo de solicitar e manipular os dados da API.

Versão 3.0

  • Essa é a versão principal mais recente da nossa API, que não é compatível com as anteriores. Será preciso usar esta versão para todo o desenvolvimento futuro da API.

  • Novos dados

    • Representação completa das metas de eventos
    • ID da propriedade da Web interno que pode ser usado para criar links diretos para a interface do usuário do Google Analytics
    • Configurações de perfil para a página padrão e parâmetros de consulta de pesquisa no site
  • Mudanças

Versão 2.4

  • Este é um upgrade de versão secundária que é, na maioria das vezes, compatível com versões anteriores à 2.3.

  • Mudou

    • Adicionamos uma nova política de cota.
    • Incluímos a integração com o Console de APIs do Google para gerenciar o acesso à API e solicitar mais cotas.
    • Adicionamos suporte contínuo para os mecanismos de autorização existentes e o OAuth 2.0.
    • Incluímos um novo URL para fazer solicitações: https://www.googleapis.com/analytics/v2.4/management/….
    • Adicionamos o recurso de respostas somente em XML.
    • Removemos o suporte para a biblioteca de cliente JavaScript dos dados do Google.
    • A saída XML agora é consistente com a versão 2.3, então, as outras bibliotecas de cliente de dados do Google continuarão funcionando.

Suspensão de uso

  • Estamos anunciando a descontinuação da versão 2.3 legada da API Management. Ela vai continuar funcionando por dois meses. Depois disso, todas as solicitações feitas na v2.3 vão retornar uma resposta para a v2.4.

Esta é a versão Beta da API Google Analytics Management.

Novos feeds

Bibliotecas de cliente atualizadas

  • A API Management está sendo lançada na mesma biblioteca que a API Data Export do Google Analytics. As bibliotecas Java e JavaScript de dados do Google foram atualizadas. Cada feed pode ser acessado especificando o URI de feed apropriado para o método getManagementFeed() das bibliotecas.

Nova documentação

  • Criamos uma seção de documentação para desenvolvedores do Google Analytics que descreve como a nova API Management funciona.