Visão geral da API Admin do Google Analytics

Resumo: este documento fornece uma visão geral de alto nível da API Admin do Google Analytics versão 1.0.

No momento, essa API oferece recursos disponíveis nos canais Alfa e Beta.

Alfa

Os recursos no Canal Alfa estão no estágio inicial de pré-lançamento. Tentaremos notificar você sobre as próximas mudanças, mas talvez haja alterações interruptivas antes do lançamento público da API.

Beta

Não são esperadas alterações interruptivas neste canal. Os produtos em pré-GA podem ter suporte limitado, e é possível que as mudanças neles não sejam compatíveis com outras versões nesse estágio.

Para receber anúncios oficiais da API Google Analytics, inscreva-se no Grupo de notificações da API Google Analytics.

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 de uma propriedade (Alfa).
• Gerenciar streams.
• 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.
• Gerencie dimensões personalizadas.
• Gerenciar métricas personalizadas.
• Gerencie 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).
• Gerencie 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).
• Gerencie vinculações entre uma propriedade do GA4 e um projeto do BigQuery (Alfa).
• Gerenciar as permissões do usuário em uma hierarquia de contas e propriedades do GA4 (Alfa).
• Gere relatórios de acesso aos 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 do GA4 automatizada (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, na sigla em inglês): https://analytics.google.com/analytics/web/?provisioningSignup=false#/termsofservice/ACCOUNT_TICKET_ID. Depois que um 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 (exemplo de provisionamento de conta).

Gerenciamento de contas

• accounts.delete
• accounts.get
• accounts.list
• accounts.patch

Gerenciamento de configurações de compartilhamento de dados

• accounts.getDataSharingSettings

Exibir resumos da conta

• accountSummaries.list

Pesquisar eventos do histórico de alterações

• accounts.searchChangeHistoryEvents

Gerenciamento de propriedades

• properties.get
• properties.patch
• properties.delete
• properties.list
• properties.create

Confirmação da coleta de dados do usuário

• properties.acknowledgeUserDataCollection

Gerenciamento de configurações de retenção de dados

• properties.getDataRetentionSettings
• properties.updateDataRetentionSettings

Gerenciamento de configuração dos Indicadores do Google (Alfa)

• properties.getGoogleSignalsSettings
• properties.updateGoogleSignalsSettings

Gerenciamento de fluxos de dados

• properties.dataStreams.create
• properties.dataStreams.get
• properties.dataStreams.list
• properties.dataStreams.patch
• properties.dataStreams.delete

Gerenciamento de secrets do Measurement Protocol

• properties.dataStreams.measurementProtocolSecrets.create
• properties.dataStreams.measurementProtocolSecrets.get
• properties.dataStreams.measurementProtocolSecrets.patch
• properties.dataStreams.measurementProtocolSecrets.list
• properties.dataStreams.measurementProtocolSecrets.delete

Gerenciamento de esquemas de valor da conversão da SKAdNetwork (Alfa)

• properties.dataStreams.sKAdNetworkConversionValueSchema.get
• properties.dataStreams.sKAdNetworkConversionValueSchema.create
• properties.dataStreams.sKAdNetworkConversionValueSchema.delete
• properties.dataStreams.sKAdNetworkConversionValueSchema.update
• properties.dataStreams.sKAdNetworkConversionValueSchema.list

Gerenciamento de eventos de conversão

• properties.conversionEvents.create
• properties.conversionEvents.get
• properties.conversionEvents.list
• properties.conversionEvents.delete
• properties.conversionEvents.update

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 de projetos do Firebase

• properties.firebaseLinks.create
• properties.firebaseLinks.list
• properties.firebaseLinks.delete

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)

• properties.webDataStreams.getGlobalSiteTag

Propostas de 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 da conta do anunciante do Display & Video 360 (Alfa)

• properties.displayVideo360AdvertiserLinks.create
• properties.displayVideo360AdvertiserLinks.get
• properties.displayVideo360AdvertiserLinks.list
• properties.displayVideo360AdvertiserLinks.delete
• properties.displayVideo360AdvertiserLinks.patch

Vinculação de contas do Search Ads 360 (Alfa)

• properties.searchAds360Links.create
• properties.searchAds360Links.delete
• properties.searchAds360Links.patch
• properties.searchAds360Links.list
• properties.searchAds360Links.get

Saiba como configurar a integração do Analytics com o Search Ads 360 em uma propriedade do GA4.

Vinculação de contas do BigQuery (Alfa)

• properties.bigQueryLinks.get
• properties.bigQueryLinks.list

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)

• properties.runAccessReport

Consulte o guia 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 os públicos-alvo no Google Analytics.

Gerenciamento expandido dos conjuntos de dados (Alfa)

• properties.expandedDataSets.create
• properties.expandedDataSets.delete
• properties.expandedDataSets.patch
• properties.expandedDataSets.list
• properties.expandedDataSets.get

Saiba mais sobre conjuntos de dados abertos no Google Analytics 360.

Desativação do processo automatizado de configuração do GA4 (Alfa)

• properties.setAutomatedGa4ConfigurationOptOut
• properties.fetchAutomatedGa4ConfigurationOptOut

Saiba mais sobre como gerenciar o status de desativação do processo de configuração automatizada do GA4 para uma propriedade do UA.