Resumo: fornece uma visão geral da API Google Analytics Admin versão 1.0.
Os canais Alfa e Beta da API continuam sendo compatíveis. O canal Beta contém um subconjunto dos recursos disponíveis na versão Alfa, que são considerados estáveis e não passarão por uma alteração significativa no futuro. Novos recursos serão adicionados à versão Beta quando forem consolidados.
Introdução
A API Admin do Google Analytics permite acesso programático aos dados de configuração do Google Analytics 4 (GA4) e só é compatível com propriedades do GA4. Saiba mais sobre as propriedades do GA4.
Você pode usar a API Admin do Google Analytics para:
- Provisionar novas contas.
- Gerenciar contas.
- Gerenciar as configurações de compartilhamento de dados.
- Listar resumos da conta.
- Pesquisar eventos do histórico de alterações.
- Gerenciar propriedades.
- Reconheça a coleta de dados do usuário.
- Gerenciar a configuração de retenção de dados de uma propriedade.
- Gerenciar a configuração dos Indicadores do Google para uma propriedade (Alfa).
- Gerenciar streams.
- Gerencie secrets do Measurement Protocol.
- Gere um snippet de tag do Google para fluxos de dados da Web (Alfa).
- Gerenciar eventos de conversão.
- Gerenciar dimensões personalizadas.
- Gerenciar métricas personalizadas.
- Gerenciar vinculações entre propriedades do GA4 e projetos do Firebase.
- Gerenciar vinculações entre propriedades do GA4 e contas do Google Ads
- Gerenciar propostas de vinculação entre uma propriedade do GA4 e um anunciante do Display & Video 360 (Alfa).
- Gerenciar vinculações entre uma propriedade do GA4 e um anunciante do Display & Video 360 (Alfa).
- Gerenciar vinculações entre uma propriedade do GA4 e o Search Ads 360 (Alfa).
- Gerenciar vinculações entre uma propriedade do GA4 e um projeto do BigQuery (Alfa).
- Gerenciar permissões de usuário para uma hierarquia de contas e propriedades do GA4 (Alfa).
- Gere relatórios de acesso a dados (Alfa).
- Gerenciar públicos-alvo (Alfa).
- Gerenciar conjuntos de dados expandidos (Alfa).
- Gerencie as configurações automáticas de desativação do processo de configuração do GA4 (Alfa).
Métodos disponíveis
Provisionamento de conta
accounts.provisionAccountTicket
Esse método retorna o campo
accountTicketId
que precisa ser incluído no URL dos Termos de Serviço (TOS):https://analytics.google.com/analytics/web/?provisioningSignup=false#/termsofservice/ACCOUNT_TICKET_ID
. Depois que o usuário acessar o URL dos TOS e aceitar os Termos de Serviço, a criação de uma conta do Google Analytics será concluída (amostra de provisionamento de conta).
Gerenciamento de contas
Gerenciamento de configurações de compartilhamento de dados
Exibir resumos da conta
Pesquisar eventos do histórico de alterações
Gerenciamento de propriedades
Confirmação da coleta de dados dos usuários
Gerenciamento da configuração de retenção de dados
Gerenciamento de configurações dos Indicadores do Google (Alfa)
Gerenciamento de fluxos de dados
properties.dataStreams.create
properties.dataStreams.get
properties.dataStreams.list
properties.dataStreams.patch
properties.dataStreams.delete
Gerenciamento de secrets do Protocolo de avaliação
properties.dataStreams.measurementProtocolSecrets.create
properties.dataStreams.measurementProtocolSecrets.get
properties.dataStreams.measurementProtocolSecrets.patch
properties.dataStreams.measurementProtocolSecrets.list
properties.dataStreams.measurementProtocolSecrets.delete
Gerenciamento de eventos de conversão
properties.conversionEvents.create
properties.conversionEvents.get
properties.conversionEvents.list
properties.conversionEvents.delete
Gerenciamento de dimensões personalizadas
properties.customDimensions.create
properties.customDimensions.get
properties.customDimensions.list
properties.customDimensions.patch
properties.customDimensions.archive
Gerenciamento de métricas personalizadas
properties.customMetrics.create
properties.customMetrics.get
properties.customMetrics.list
properties.customMetrics.patch
properties.customMetrics.archive
Vinculação do projeto do Firebase
Vinculação de contas do Google Ads
properties.googleAdsLinks.create
properties.googleAdsLinks.list
properties.googleAdsLinks.patch
properties.googleAdsLinks.delete
Geração de tags do Google (Alfa)
Propostas para uma vinculação entre uma propriedade do GA4 e um anunciante do Display & Video 360 (Alfa)
properties.displayVideo360AdvertiserLinkProposals.create
properties.displayVideo360AdvertiserLinkProposals.approve
properties.displayVideo360AdvertiserLinkProposals.cancel
properties.displayVideo360AdvertiserLinkProposals.list
properties.displayVideo360AdvertiserLinkProposals.get
properties.displayVideo360AdvertiserLinkProposals.delete
Vinculação de conta de anunciante do Display & Video 360 (Alfa)
properties.displayVideo360AdvertiserLinks.create
properties.displayVideo360AdvertiserLinks.get
properties.displayVideo360AdvertiserLinks.list
properties.displayVideo360AdvertiserLinks.delete
properties.displayVideo360AdvertiserLinks.patch
Vinculação de conta do Search Ads 360 (Alfa)
properties.searchAds360Links.create
properties.searchAds360Links.delete
properties.searchAds360Links.patch
properties.searchAds360Links.list
properties.searchAds360Links.get
Saiba mais sobre como configurar a integração do Google Analytics Search Ads 360 a uma propriedade do GA4.
Vinculação de conta do BigQuery (Alfa)
Saiba mais sobre como configurar o BigQuery Export para uma propriedade do GA4.
Gerenciamento de permissões do usuário (Alfa)
accounts.accessBindings.create
accounts.accessBindings.delete
accounts.accessBindings.patch
accounts.accessBindings.list
accounts.accessBindings.get
accounts.accessBindings.batchCreate
accounts.accessBindings.batchDelete
accounts.accessBindings.batchUpdate
accounts.accessBindings.batchGet
properties.accessBindings.create
properties.accessBindings.delete
properties.accessBindings.patch
properties.accessBindings.list
properties.accessBindings.get
properties.accessBindings.batchCreate
properties.accessBindings.batchDelete
properties.accessBindings.batchUpdate
properties.accessBindings.batchGet
Relatórios de acesso a dados (Alfa)
Consulte o guia de relatórios de acesso a dados para mais informações sobre esse recurso.
Gerenciamento de públicos-alvo (Alfa)
properties.audiences.create
properties.audiences.archive
properties.audiences.patch
properties.audiences.list
properties.audiences.get
Saiba mais sobre públicos-alvo no Google Analytics.
Gerenciamento expandido de conjuntos de dados (Alfa)
properties.expandedDataSets.create
properties.expandedDataSets.delete
properties.expandedDataSets.patch
properties.expandedDataSets.list
properties.expandedDataSets.get
Saiba mais sobre os conjuntos de dados expandidos no Google Analytics 360.
Desativação automática do processo de configuração do GA4 (Alfa)
Saiba mais sobre como gerenciar o status de desativação do processo de configuração automatizada do GA4 para uma propriedade do UA.