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 links between a GA4 property and Search Ads 360 (Alpha).
- Manage links between a GA4 property and BigQuery project (Alpha).
- Manage user permissions for an account hierarchy and GA4 properties (Alpha).
- Generate data access reports (Alpha).
- Manage audiences (Alpha).
- Manage expanded data sets (Alpha).
- Manage automated GA4 setup process opt-out settings (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 acknowledgement
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
Display & Video 360 advertiser account linking (Alpha)
properties.displayVideo360AdvertiserLinks.create
properties.displayVideo360AdvertiserLinks.get
properties.displayVideo360AdvertiserLinks.list
properties.displayVideo360AdvertiserLinks.delete
properties.displayVideo360AdvertiserLinks.patch
Search Ads 360 account linking (Alpha)
properties.searchAds360Links.create
properties.searchAds360Links.delete
properties.searchAds360Links.patch
properties.searchAds360Links.list
properties.searchAds360Links.get
Learn more about setting up Analytics Search Ads 360 integration for a GA4 property.
BigQuery account linking (Alpha)
Learn more about setting up BigQuery export for a GA4 property.
User permissions management (Alpha)
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
Data access reports (Alpha)
See the Data Access Reports guide for more information about this feature.
Audience management (Alpha)
properties.audiences.create
properties.audiences.archive
properties.audiences.patch
properties.audiences.list
properties.audiences.get
Learn more about audiences in Google Analytics.
Expanded Data Sets management (Alpha)
properties.expandedDataSets.create
properties.expandedDataSets.delete
properties.expandedDataSets.patch
properties.expandedDataSets.list
properties.expandedDataSets.get
Learn more about Expanded Data Sets in Google Analytics 360.
Automated GA4 setup process opt-out (Alpha)
Learn more about managing the opt out status for the automated GA4 setup process for a UA property.