Visão geral da API Admin do Google Analytics

Resumo: este documento contém uma visão geral de alto nível 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 precisam passar por uma mudança significativa no futuro. Novos recursos serão adicionados à versão Beta quando forem aprimorados.

Introdução

A API Admin do Google Analytics permite o acesso programático aos dados de configuração do Google Analytics 4 (GA4) e é compatível apenas com as propriedades do GA4. Saiba mais sobre as propriedades do GA4.

Você pode usar a API Admin do Google Analytics para fazer o seguinte:

• Provisione 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).
• Gerencie streams.
• Gerencie as chaves secretas do Measurement Protocol.
• Gerar 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.
• Gerenciar propostas de vinculação entre uma propriedade do GA4 e um anunciante do Display & amp; Video 360 (Alfa).
• Gerenciar vinculações entre uma propriedade do GA4 e um anunciante do Display & amp; Video 360 (Alfa).
• Gerenciar permissões de usuários para uma hierarquia de contas e propriedades do GA4 (Alfa).
• Audite as permissões do usuário, incluindo as implícitas que venham de permissões efetivas concedidas por grupos ou funções de administrador da organização (Alfa).
• Gerar relatórios de acesso a dados (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 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 (Exemplo de provisionamento de conta).

Gerenciamento de contas

• accounts.delete
• accounts.get
• accounts.list (em inglês)
• 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

Administração de imóveis

• properties.get (link em inglês)
• properties.patch (link em inglês)
• properties.delete
• properties.list (em inglês)
• properties.create (em inglês)

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

• properties.acientUserDataCollection

Gerenciamento da configuração de retenção de dados

• properties.getDataRetentionSettings
• properties.updateDataRetentionSettings

Gerenciamento de configurações dos Indicadores do Google (Alfa)

• properties.getGoogleSignalsSettings
• properties.updateGoogleSignalsSettings

Gerenciamento de fluxos de dados

• properties.dataStreams.create.
• properties.dataStreams.get.
• properties.dataStreams.list (em inglês)
• properties.dataStreams.patch.
• properties.dataStreams.delete.

Gerenciamento de secrets do Measurement Protocol

• properties.dataStreams.measurementProtocoloSecrets.create (em inglês)
• properties.dataStreams.measurementProtocoloSecrets.get.
• properties.dataStreams.measurement ProtocolSecrets.patch (em inglês).
• properties.dataStreams.measurementProtocoloSecrets.list (em inglês)
• properties.dataStreams.measurement ProtocolSecrets.delete (em inglês).

Gerenciamento de eventos de conversão

• properties.conversionEvents.create (em inglês)
• properties.conversionEvents.get (em inglês)
• properties.conversionEvents.list (em inglês)
• properties.conversionEvents.delete (em inglês)

Gerenciamento de dimensões personalizadas

• properties.customDimension.create (em inglês)
• properties.customSizes.get
• properties.customDimension.list (em inglês)
• properties.customSizes.patch
• properties.customDimensões.arquivo

Gerenciamento de métricas personalizadas

• properties.customMetrics.create (link em inglês)
• properties.customMetrics.get (link em inglês)
• properties.customMetrics.list (em inglês)
• properties.customMetrics.patch (link em inglês)
• properties.customMetrics.arquivar

Vinculação de projetos do Firebase

• properties.firebaseLinks.create (em inglês)
• properties.firebaseLinks.list (link em inglês)
• properties.firebaseLinks.delete (link em inglês)

Vinculação de contas do Google Ads

• properties.googleAdsLinks.create (em inglês)
• properties.googleAdsLinks.list (em inglês)
• properties.googleAdsLinks.patch (link em inglês)
• properties.googleAdsLinks.delete

Geração de tags do Google (Alfa)

• properties.webDataStreams.getGlobalSiteTag (em inglês)

Propostas de vinculação entre uma propriedade do GA4 e um anunciante do Display & amp; Video 360 (Alfa)

• properties.displayVideo360AnuncianteLinkProposals.create
• properties.displayVideo360AnuncianteLinkProposals.approve
• properties.displayVideo360AnuncianteLinkProposals.cancel
• properties.displayVideo360AnuncianteLinkProposals.list
• properties.displayVideo360AnuncianteLinkProposals.get
• properties.displayVideo360AnuncianteLinkProposals.delete

Vinculações entre uma propriedade do GA4 e um anunciante do Display & amp; Video 360 (Alfa).

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

Gerenciamento de permissões do usuário (Alfa)

• accounts.userLinks.create (em inglês)
• accounts.userLinks.get
• accounts.userLinks.list
• accounts.userLinks.patch (link em inglês)
• accounts.userLinks.delete
• accounts.userLinks.batchCreate
• accounts.userLinks.batchGet
• accounts.userLinks.batchUpdate

• accounts.userLinks.batchDelete

• properties.userLinks.create (em inglês)

• properties.userLinks.get (link em inglês)

• properties.userLinks.list (link em inglês)

• properties.userLinks.delete (link em inglês)

• properties.userLinks.patch (link em inglês)

• properties.userLinks.batchCreate

• properties.userLinks.batchGet

• properties.userLinks.batchUpdate

• properties.userLinks.batchDelete

Auditoria de permissões do usuário (Alfa)

• accounts.userLinks.audit
• properties.userLinks.audit (em inglês)

Relatórios de acesso a dados (Alfa)

• properties.runAccessReport Consulte o guia de relatórios de acesso a dados para mais informações sobre esse recurso.