Summary: This document provides a high level overview of the Google Analytics Admin API Version 1.0.
Introduction
The Google Analytics Admin API allows for programmatic access to the Google Analytics configuration data and is only compatible with Google Analytics properties. Learn more about Google Analytics 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.
- Manage subproperties.
- 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.
- Manage SKAdNetwork conversion value schema (Alpha).
- Generate a Google tag snippet for Web data streams (Alpha).
- Manage key events.
- Manage conversion events (Deprecated).
- Manage event create rules (Alpha)
- Manage event edit rules (Alpha)
- Manage custom dimensions.
- Manage custom metrics.
- Manage links between Google Analytics properties and Firebase projects.
- Manage links between Google Analytics properties and Google Ads accounts.
- Manage proposals for a link between a Google Analytics property and a Display & Video 360 advertiser (Alpha).
- Manage links between a Google Analytics property and a Display & Video 360 advertiser (Alpha).
- Manage links between a Google Analytics property and Search Ads 360 (Alpha).
- Manage links between a Google Analytics property and BigQuery project (Alpha).
- Manage user permissions for an account hierarchy and Google Analytics properties (Alpha).
- Generate data access reports.
- Manage audiences (Alpha).
- Manage expanded data sets (Alpha).
- Manage automated Google Analytics setup process opt-out settings (Alpha).
Available methods
Here are the available methods.
Account provisioning
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. See the Account provisioning sample.
Accounts management
Data sharing settings management
List account summaries
Search change history events
Properties management
Subproperties management (Alpha)
User data collection acknowledgement
Data retention setting management
Google Signals setting management (Alpha)
Data streams management
properties.dataStreams.createproperties.dataStreams.getproperties.dataStreams.listproperties.dataStreams.patchproperties.dataStreams.delete
Measurement Protocol secrets management
properties.dataStreams.measurementProtocolSecrets.createproperties.dataStreams.measurementProtocolSecrets.getproperties.dataStreams.measurementProtocolSecrets.patchproperties.dataStreams.measurementProtocolSecrets.listproperties.dataStreams.measurementProtocolSecrets.delete
SKAdNetwork conversion value schema management (Alpha)
properties.dataStreams.sKAdNetworkConversionValueSchema.getproperties.dataStreams.sKAdNetworkConversionValueSchema.createproperties.dataStreams.sKAdNetworkConversionValueSchema.deleteproperties.dataStreams.sKAdNetworkConversionValueSchema.updateproperties.dataStreams.sKAdNetworkConversionValueSchema.list
Key events management
properties.keyEvents.createproperties.keyEvents.getproperties.keyEvents.listproperties.keyEvents.deleteproperties.keyEvents.patch
Conversion events management
properties.conversionEvents.createproperties.conversionEvents.getproperties.conversionEvents.listproperties.conversionEvents.deleteproperties.conversionEvents.patch
Event create rules management (Alpha)
properties.dataStreams.eventCreateRules.createproperties.dataStreams.eventCreateRules.getproperties.dataStreams.eventCreateRules.listproperties.dataStreams.eventCreateRules.deleteproperties.dataStreams.eventCreateRules.patch
Event edit rules management (Alpha)
properties.dataStreams.eventEditRules.createproperties.dataStreams.eventEditRules.getproperties.dataStreams.eventEditRules.listproperties.dataStreams.eventEditRules.deleteproperties.dataStreams.eventEditRules.patchproperties.dataStreams.eventEditRules.reorder
Custom dimensions management
properties.customDimensions.createproperties.customDimensions.getproperties.customDimensions.listproperties.customDimensions.patchproperties.customDimensions.archive
Custom metrics management
properties.customMetrics.createproperties.customMetrics.getproperties.customMetrics.listproperties.customMetrics.patchproperties.customMetrics.archive
Firebase project linking
Google Ads account linking
properties.googleAdsLinks.createproperties.googleAdsLinks.listproperties.googleAdsLinks.patchproperties.googleAdsLinks.delete
Google tag generation (Alpha)
Proposals for a link between a Google Analytics property and a Display & Video 360 advertiser (Alpha)
properties.displayVideo360AdvertiserLinkProposals.createproperties.displayVideo360AdvertiserLinkProposals.approveproperties.displayVideo360AdvertiserLinkProposals.cancelproperties.displayVideo360AdvertiserLinkProposals.listproperties.displayVideo360AdvertiserLinkProposals.getproperties.displayVideo360AdvertiserLinkProposals.delete
Display & Video 360 advertiser account linking (Alpha)
properties.displayVideo360AdvertiserLinks.createproperties.displayVideo360AdvertiserLinks.getproperties.displayVideo360AdvertiserLinks.listproperties.displayVideo360AdvertiserLinks.deleteproperties.displayVideo360AdvertiserLinks.patch
Search Ads 360 account linking (Alpha)
properties.searchAds360Links.createproperties.searchAds360Links.deleteproperties.searchAds360Links.patchproperties.searchAds360Links.listproperties.searchAds360Links.get
Learn more about setting up Analytics Search Ads 360 integration for a Google Analytics property.
BigQuery account linking (Alpha)
properties.bigQueryLinks.createproperties.bigQueryLinks.deleteproperties.bigQueryLinks.getproperties.bigQueryLinks.listproperties.bigQueryLinks.patch
Learn more about setting up BigQuery export for a Google Analytics property.
User permissions management (Alpha)
accounts.accessBindings.createaccounts.accessBindings.deleteaccounts.accessBindings.patchaccounts.accessBindings.listaccounts.accessBindings.getaccounts.accessBindings.batchCreateaccounts.accessBindings.batchDeleteaccounts.accessBindings.batchUpdateaccounts.accessBindings.batchGetproperties.accessBindings.createproperties.accessBindings.deleteproperties.accessBindings.patchproperties.accessBindings.listproperties.accessBindings.getproperties.accessBindings.batchCreateproperties.accessBindings.batchDeleteproperties.accessBindings.batchUpdateproperties.accessBindings.batchGet
Data access reports
See the Data Access Reports guide for more information about this feature.
Audience management (Alpha)
properties.audiences.createproperties.audiences.archiveproperties.audiences.patchproperties.audiences.listproperties.audiences.get
Learn more about audiences in Google Analytics.
Expanded Data Sets management (Alpha)
properties.expandedDataSets.createproperties.expandedDataSets.deleteproperties.expandedDataSets.patchproperties.expandedDataSets.listproperties.expandedDataSets.get
Learn more about Expanded Data Sets in Google Analytics 360.
Automated Google Analytics setup process opt-out (Alpha)
Learn more about managing the opt out status for the automated Google Analytics setup process for a UA property.