Google Analytics Admin API Overview

Summary: This document provides a high level overview of the Google Analytics Admin API Version 1.0.

Warning: This is an early preview version of the API and is subject to change. While we will try to notify you of upcoming changes, you should expect to encounter breaking changes before the APIs are publicly released.

Both Alpha and Beta channels of the API continue to be supported. Beta channel contains a subset of the features available in Alpha which are considered stable and not expected to undergo a significant change in the future. New features will be added to Beta once they mature.

For official Google Analytics API announcements, please subscribe to Google Analytics API Notify Group. To report an issue with the API, use the Google Analytics API Tester Feedback Form.

Introduction

The Google Analytics Admin API allows for programmatic access to the Google Analytics 4 (GA4) configuration data and is only compatible with GA4 properties. Learn more about GA4 properties.

You can use the Google Analytics Admin API to:

• Provision new accounts.
• Manage accounts.
• Manage data sharing settings.
• List account summaries.
• Search change history events.
• Manage properties.
• Acknowledge user data collection.
• Manage data retention setting for a property.
• Manage Google Signals setting for a property (Alpha).
• Manage streams.
• Manage Measurement Protocol secrets.
• Generate a Google tag snippet for Web data streams (Alpha).
• Manage conversion events.
• Manage custom dimensions.
• Manage custom metrics.
• Manage links between GA4 properties and Firebase projects.
• Manage links between GA4 properties and Google Ads accounts.
• Manage proposals for a link between a GA4 property and a Display & Video 360 advertiser (Alpha).
• Manage links between a GA4 property and a Display & Video 360 advertiser (Alpha).
• Manage user permissions for an account hierarchy and GA4 properties (Alpha).
• Audit user permissions including implicit ones that come from effective permissions granted by groups or organization admin roles (Alpha).

Available methods

Account provisioning

• accounts.provisionAccountTicket

  This method returns the accountTicketId field that should be included in the Terms of Service (TOS) URL: https://analytics.google.com/analytics/web/?provisioningSignup=false#/termsofservice/ACCOUNT_TICKET_ID. Once a user visits the TOS URL and accepts the Terms of Service, creation of a Google Analytics account will be complete (Account provisioning sample).

Accounts management

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

Data sharing settings management

• accounts.getDataSharingSettings

List account summaries

• accountSummaries.list

Search change history events

• accounts.searchChangeHistoryEvents

Properties management

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

User data collection acknowledment

• properties.acknowledgeUserDataCollection

Data retention setting management

• properties.getDataRetentionSettings
• properties.updateDataRetentionSettings

Google Signals setting management (Alpha)

• properties.getGoogleSignalsSettings
• properties.updateGoogleSignalsSettings

Data streams management

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

Measurement Protocol secrets management

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

Conversion events management

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

Custom dimensions management

• properties.customDimensions.create
• properties.customDimensions.get
• properties.customDimensions.list
• properties.customDimensions.patch
• properties.customDimensions.archive

Custom metrics management

• properties.customMetrics.create
• properties.customMetrics.get
• properties.customMetrics.list
• properties.customMetrics.patch
• properties.customMetrics.archive

Firebase project linking

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

Google Ads account linking

• properties.googleAdsLinks.create
• properties.googleAdsLinks.list
• properties.googleAdsLinks.patch
• properties.googleAdsLinks.delete

Google tag generation (Alpha)

• properties.webDataStreams.getGlobalSiteTag

Proposals for a link between a GA4 property and a Display & Video 360 advertiser (Alpha)

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

Links between a GA4 property and a Display & Video 360 advertiser (Alpha).

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

User permissions management (Alpha)

• accounts.userLinks.create
• accounts.userLinks.get
• accounts.userLinks.list
• accounts.userLinks.patch
• accounts.userLinks.delete
• accounts.userLinks.batchCreate
• accounts.userLinks.batchGet
• accounts.userLinks.batchUpdate

• accounts.userLinks.batchDelete

• properties.userLinks.create

• properties.userLinks.get

• properties.userLinks.list

• properties.userLinks.delete

• properties.userLinks.patch

• properties.userLinks.batchCreate

• properties.userLinks.batchGet

• properties.userLinks.batchUpdate

• properties.userLinks.batchDelete

User permissions audit (Alpha)

• accounts.userLinks.audit
• properties.userLinks.audit