Google Analytics Admin API Overview

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:

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

Measurement Protocol secrets management

Conversion events management

Custom dimensions management

Custom metrics management

Firebase project linking

Google tag generation (Alpha)

User permissions management (Alpha)

User permissions audit (Alpha)