Summary: This document provides a high level overview of the Google Analytics Admin API Version 1.0.
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.
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).
- Generate data access reports (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
Data sharing settings management
List account summaries
Search change history events
Properties management
User data collection acknowledment
Data retention setting management
Google Signals setting management (Alpha)
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
Google Ads account linking
- properties.googleAdsLinks.create
- properties.googleAdsLinks.list
- properties.googleAdsLinks.patch
- properties.googleAdsLinks.delete
Google tag generation (Alpha)
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
User permissions audit (Alpha)
Data access reports (Alpha)
- properties.runAccessReport See the Data Access Reports guide for more information about this feature.