Resumo: este documento apresenta uma visão geral da versão 1.0 da API Google Analytics Admin.
Introdução
A API Admin do Google Analytics permite acesso programático aos dados de configuração do Google Analytics e é compatível apenas com propriedades do Google Analytics. Saiba mais sobre as propriedades do Google Analytics.
Você pode usar a API Admin do Google Analytics para:
- Provisionar novas contas.
- Gerenciar contas.
- Gerenciar as configurações de compartilhamento de dados pessoais.
- Exibir resumos da conta.
- Pesquisar eventos do histórico de mudanças.
- Gerenciar propriedades.
- Gerenciar subpropriedades.
- Confirmar a coleta de dados do usuário.
- Gerenciar a configuração de retenção de dados de uma propriedade.
- Gerenciar a configuração de indicadores do Google para uma propriedade (Alfa).
- Gerenciar streams.
- Gerenciar chaves secretas do Measurement Protocol.
- Gerenciar o esquema de valor da conversão da SKAdNetwork (Alfa).
- Gerar um snippet de tag do Google para fluxos de dados da Web (Alfa).
- Gerenciar eventos principais.
- Gerenciar eventos de conversão (descontinuado).
- Gerenciar regras de criação de eventos (Alfa)
- Gerenciar regras de edição de eventos (Alfa)
- Gerenciar dimensões personalizadas.
- Gerenciar métricas personalizadas.
- Gerenciar vinculações entre propriedades do Google Analytics e projetos do Firebase.
- Gerenciar vinculações entre propriedades do Google Analytics e contas do Google Ads.
- Gerenciar propostas de vinculação entre uma propriedade do Google Analytics e um anunciante do Display &Video 360 (Alfa).
- Gerenciar vinculações entre uma propriedade do Google Analytics e um anunciante do Display &Video 360 (Alfa).
- Gerenciar vinculações entre uma propriedade do Google Analytics e o Search Ads 360 (Alfa).
- Gerenciar vinculações entre uma propriedade do Google Analytics e um projeto do BigQuery (Alfa).
- Gerenciar permissões de usuário para uma hierarquia de contas e propriedades do Google Analytics (Alfa).
- Gerar relatórios de acesso aos dados.
- Gerenciar públicos-alvo (Alfa).
- Gerenciar conjuntos de dados expandidos (Alfa).
- Gerenciar as configurações de desativação do processo de configuração automatizada do Google Analytics (Alfa).
Métodos disponíveis
Confira os métodos disponíveis.
Provisionamento de conta
Esse método retorna o campo accountTicketId que precisa ser incluído no URL dos Termos de Serviço (TOS, na sigla em inglês):
https://analytics.google.com/analytics/web/?provisioningSignup=false#/termsofservice/ACCOUNT_TICKET_ID
Quando um usuário acessa o URL dos TOS e aceita os Termos de Serviço, a criação de uma conta do Google Analytics é concluída. Consulte o exemplo de provisionamento de conta.
Gerenciamento de contas
Gerenciamento das configurações de compartilhamento de dados pessoais
Exibir resumos da conta
Pesquisar eventos do histórico de mudanças
Gerenciamento de propriedades
Gerenciamento de subpropriedades (Alfa)
Confirmação de coleta de dados do usuário
Gerenciamento da configuração de retenção de dados
Gerenciamento da configuração de indicadores do Google (Alfa)
Gerenciamento de fluxos de dados
properties.dataStreams.createproperties.dataStreams.getproperties.dataStreams.listproperties.dataStreams.patchproperties.dataStreams.delete
Gerenciamento de chaves secretas do Measurement Protocol
properties.dataStreams.measurementProtocolSecrets.createproperties.dataStreams.measurementProtocolSecrets.getproperties.dataStreams.measurementProtocolSecrets.patchproperties.dataStreams.measurementProtocolSecrets.listproperties.dataStreams.measurementProtocolSecrets.delete
Gerenciamento do esquema de valor da conversão da SKAdNetwork (Alfa)
properties.dataStreams.sKAdNetworkConversionValueSchema.getproperties.dataStreams.sKAdNetworkConversionValueSchema.createproperties.dataStreams.sKAdNetworkConversionValueSchema.deleteproperties.dataStreams.sKAdNetworkConversionValueSchema.updateproperties.dataStreams.sKAdNetworkConversionValueSchema.list
Gerenciamento de eventos principais
properties.keyEvents.createproperties.keyEvents.getproperties.keyEvents.listproperties.keyEvents.deleteproperties.keyEvents.patch
Gerenciamento de eventos de conversão
properties.conversionEvents.createproperties.conversionEvents.getproperties.conversionEvents.listproperties.conversionEvents.deleteproperties.conversionEvents.patch
Gerenciamento de regras de criação de eventos (Alfa)
properties.dataStreams.eventCreateRules.createproperties.dataStreams.eventCreateRules.getproperties.dataStreams.eventCreateRules.listproperties.dataStreams.eventCreateRules.deleteproperties.dataStreams.eventCreateRules.patch
Gerenciamento de regras de edição de eventos (Alfa)
properties.dataStreams.eventEditRules.createproperties.dataStreams.eventEditRules.getproperties.dataStreams.eventEditRules.listproperties.dataStreams.eventEditRules.deleteproperties.dataStreams.eventEditRules.patchproperties.dataStreams.eventEditRules.reorder
Gerenciamento de dimensões personalizadas
properties.customDimensions.createproperties.customDimensions.getproperties.customDimensions.listproperties.customDimensions.patchproperties.customDimensions.archive
Gerenciamento de métricas personalizadas
properties.customMetrics.createproperties.customMetrics.getproperties.customMetrics.listproperties.customMetrics.patchproperties.customMetrics.archive
Vinculação de projetos do Firebase
Vinculação de contas do Google Ads
properties.googleAdsLinks.createproperties.googleAdsLinks.listproperties.googleAdsLinks.patchproperties.googleAdsLinks.delete
Geração de tags do Google (Alfa)
Propostas de vinculação entre uma propriedade do Google Analytics e um anunciante do Display &Video 360 (Alfa)
properties.displayVideo360AdvertiserLinkProposals.createproperties.displayVideo360AdvertiserLinkProposals.approveproperties.displayVideo360AdvertiserLinkProposals.cancelproperties.displayVideo360AdvertiserLinkProposals.listproperties.displayVideo360AdvertiserLinkProposals.getproperties.displayVideo360AdvertiserLinkProposals.delete
Vinculação de contas de anunciantes do Display &Video 360 (Alfa)
properties.displayVideo360AdvertiserLinks.createproperties.displayVideo360AdvertiserLinks.getproperties.displayVideo360AdvertiserLinks.listproperties.displayVideo360AdvertiserLinks.deleteproperties.displayVideo360AdvertiserLinks.patch
Vinculação de contas do Search Ads 360 (Alfa)
properties.searchAds360Links.createproperties.searchAds360Links.deleteproperties.searchAds360Links.patchproperties.searchAds360Links.listproperties.searchAds360Links.get
Vinculação de contas do BigQuery (Alfa)
properties.bigQueryLinks.createproperties.bigQueryLinks.deleteproperties.bigQueryLinks.getproperties.bigQueryLinks.listproperties.bigQueryLinks.patch
Saiba como configurar a exportação do BigQuery para uma propriedade do Google Analytics.
Gerenciamento de permissões de usuário (Alfa)
accounts.accessBindings.createaccounts.accessBindings.deleteaccounts.accessBindings.patchaccounts.accessBindings.listaccounts.accessBindings.getaccounts.accessBindings.batchCreateaccounts.accessBindings.batchDeleteaccounts.accessBindings.batchUpdateaccounts.accessBindings.batchGetproperties.accessBindings.createproperties.accessBindings.deleteproperties.accessBindings.patchproperties.accessBindings.listproperties.accessBindings.getproperties.accessBindings.batchCreateproperties.accessBindings.batchDeleteproperties.accessBindings.batchUpdateproperties.accessBindings.batchGet
Relatórios de acesso aos dados
Consulte o guia de relatórios de acesso aos dados para mais informações sobre esse recurso.
Gerenciamento de públicos-alvo (Alfa)
properties.audiences.createproperties.audiences.archiveproperties.audiences.patchproperties.audiences.listproperties.audiences.get
Saiba mais sobre públicos-alvo no Google Analytics.
Gerenciamento de conjuntos de dados expandidos (Alfa)
properties.expandedDataSets.createproperties.expandedDataSets.deleteproperties.expandedDataSets.patchproperties.expandedDataSets.listproperties.expandedDataSets.get
Saiba mais sobre conjuntos de dados expandidos no Google Analytics 360.
Desativação do processo de configuração automatizada do Google Analytics (Alfa)
Saiba como gerenciar o status de desativação do processo de configuração automatizada do Google Analytics para uma propriedade da UA.