Google Analytics Admin API Overview

AI-generated Key Takeaways

• The Google Analytics Admin API provides programmatic access to Google Analytics configuration data, enabling management of accounts, properties, data streams, and user permissions.

• This API offers features in Alpha and Beta, with Alpha features subject to potential breaking changes and Beta features expected to be stable.

• Developers can use this API to provision accounts, manage data sharing settings, search change history, link to other platforms (Firebase, Google Ads, etc.), and generate data access reports.

• Comprehensive methods are available for managing various aspects of Google Analytics properties, including custom dimensions, metrics, events, and audiences.

• Some features, such as Google Signals settings and SKAdNetwork conversion value schema management, are currently in Alpha and may have limited support.

Summary: This document provides a high level overview of the Google Analytics 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 the Google Analytics API Notify Group.

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

• 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. See the 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

Subproperties management (Alpha)

• properties.provisionSubproperty

User data collection acknowledgement

• 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

SKAdNetwork conversion value schema management (Alpha)

• properties.dataStreams.sKAdNetworkConversionValueSchema.get
• properties.dataStreams.sKAdNetworkConversionValueSchema.create
• properties.dataStreams.sKAdNetworkConversionValueSchema.delete
• properties.dataStreams.sKAdNetworkConversionValueSchema.update
• properties.dataStreams.sKAdNetworkConversionValueSchema.list

Key events management

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

Conversion events management

Deprecated: Use the KeyEvent resource and methods instead.

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

Event create rules management (Alpha)

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

Event edit rules management (Alpha)

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

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 Google Analytics 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 Google Analytics property.

BigQuery account linking (Alpha)

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

Learn more about setting up BigQuery export for a Google Analytics 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

• properties.runAccessReport

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 Google Analytics setup process opt-out (Alpha)

• properties.setAutomatedGa4ConfigurationOptOut
• properties.fetchAutomatedGa4ConfigurationOptOut

Learn more about managing the opt out status for the automated Google Analytics setup process for a UA property.