Resumo: este documento apresenta uma visão geral de alto nível da API Admin do Google Analytics versão 1.0.
Os canais alfa e beta da API continuam a ter suporte. O canal Beta contém um subconjunto dos recursos disponíveis na versão Alfa que são considerados estáveis e não devem passar por mudanças significativas no futuro. Novos recursos vão ser adicionados à versão Beta assim que forem aprimorados.
Introdução
A API Admin do Google Analytics permite acesso programático aos dados de configuração do Google Analytics 4 (GA4) e é compatível apenas 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
- Pesquise eventos do histórico de alterações.
- Gerenciar propriedades.
- Confirme 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 transmissões.
- Gerenciar chaves secretas do Measurement Protocol.
- Gerenciar o esquema de valor da conversão da SKAdNetwork (Alfa).
- Gere um snippet de tag do Google para fluxos de dados da Web (Alfa).
- Gerencie eventos de conversão.
- Gerenciar dimensões personalizadas.
- Gerenciar métricas personalizadas.
- Gerenciar vinculações entre propriedades do GA4 e projetos do Firebase.
- Gerencie vinculações entre propriedades do GA4 e contas do Google Ads.
- Gerencie 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).
- Gerencie 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 do usuário em uma hierarquia de contas e propriedades do GA4 (Alfa).
- Gerar relatórios de acesso a dados (Alfa).
- Gerenciar públicos-alvo (Alfa).
- Gerenciar conjuntos de dados abertos (Alfa).
- Gerenciar as configurações de desativação do processo de configuração automatizada do GA4 (Alfa).
Métodos disponíveis
Provisionamento de conta
accounts.provisionAccountTicketEsse 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 um usuário acessa o URL dos TOS e aceita os Termos de Serviço, a criação da conta do Google Analytics é concluída (exemplo 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 do usuário
Gerenciamento das configurações de retenção de dados
Gerenciamento de configurações dos 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 de esquemas 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 de conversão
properties.conversionEvents.createproperties.conversionEvents.getproperties.conversionEvents.listproperties.conversionEvents.deleteproperties.conversionEvents.update
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 GA4 e um anunciante do Display & Video 360 (Alfa)
properties.displayVideo360AdvertiserLinkProposals.createproperties.displayVideo360AdvertiserLinkProposals.approveproperties.displayVideo360AdvertiserLinkProposals.cancelproperties.displayVideo360AdvertiserLinkProposals.listproperties.displayVideo360AdvertiserLinkProposals.getproperties.displayVideo360AdvertiserLinkProposals.delete
Vinculação de conta de anunciante 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
Saiba como configurar a integração do Google Analytics no Search Ads 360 com uma propriedade do GA4.
Vinculação de contas 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.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 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.createproperties.audiences.archiveproperties.audiences.patchproperties.audiences.listproperties.audiences.get
Saiba mais sobre públicos-alvo no Google Analytics.
Gerenciamento expandido dos conjuntos de dados (Alfa)
properties.expandedDataSets.createproperties.expandedDataSets.deleteproperties.expandedDataSets.patchproperties.expandedDataSets.listproperties.expandedDataSets.get
Saiba mais sobre os conjuntos de dados abertos no Google Analytics 360.
Desativação do processo automatizado de configuração do GA4 (Alfa)
Saiba como gerenciar o status de desativação da configuração automatizada do GA4 para uma propriedade do UA.