Google Analytics Admin API Overview
Page Summary
The Google Analytics Admin API Version 1.0 provides programmatic access to Google Analytics configuration data, compatible only with Google Analytics properties.
Features in this API are available in Alpha and Beta channels, with Alpha features being early previews that may have breaking changes and Beta features not expecting breaking changes.
The API allows for various management tasks including account and property management, data sharing settings, custom dimensions and metrics, and linking with other Google services like Google Ads and Firebase.
The API also includes Alpha features for managing subproperties, Google Signals settings, SKAdNetwork conversion value schema, Google tag generation, event create and edit rules, linking with DV360 and Search Ads 360, BigQuery linking, user permissions, audience management, expanded data sets, and automated GA4 setup opt-out.
A method is available to provision new accounts by generating an account ticket ID to be included in a Terms of Service URL for user acceptance.
Summary: This document provides a high level overview of the GoogleAnalytics Admin API Version 1.0.
This API provides features in Alpha and Beta channels. Alpha and Beta products may have limited support, and changes to these products may not be compatible with other Alpha and Beta versions.
Alpha: Features are in an early preview stage. While we try to notify you of upcoming changes, expect to encounter breaking changes before the API is publicly released.
Beta: No breaking changes are expected in this channel.
For official Google Analytics API announcements, subscribe to theGoogle Analytics API Notify Group.
Introduction
The Google Analytics Admin API allows for programmatic access to the Google Analyticsconfiguration data and is only compatible with Google Analytics properties.Learn more about Google Analyticsproperties.
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 aDisplay & Video360 advertiser (Alpha).
- Manage links between a Google Analytics property and a Display & Video 360advertiser (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 Analyticsproperties (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 theaccountTicketId field that should be included in theTerms 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 aGoogle Analytics account will be complete. See theAccount provisioningsample.
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
Deprecated: Use theKeyEvent resource and methodsinstead.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 360integration for a GoogleAnalytics property.
BigQuery account linking (Alpha)
properties.bigQueryLinks.createproperties.bigQueryLinks.deleteproperties.bigQueryLinks.getproperties.bigQueryLinks.listproperties.bigQueryLinks.patch
Learn more about setting up BigQuery exportfor 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 theData Access Reports guide for more information about thisfeature.
Audience management (Alpha)
properties.audiences.createproperties.audiences.archiveproperties.audiences.patchproperties.audiences.listproperties.audiences.get
Learn more about audiencesin Google Analytics.
Expanded Data Sets management (Alpha)
properties.expandedDataSets.createproperties.expandedDataSets.deleteproperties.expandedDataSets.patchproperties.expandedDataSets.listproperties.expandedDataSets.get
Learn more about Expanded Data Setsin Google Analytics 360.
Automated Google Analytics setup process opt-out (Alpha)
Learn more about managing the opt out statusfor the automated Google Analytics setup process for a UA property.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-20 UTC.