Page Summary

outlined_flag

• AddedGetReportingIdentitySettings method to retrieve identity settings for a property.

• Removed legacy Universal Analytics methods from the Admin API v1alpha.

• Introduced methods for managing subproperty sync configurations, reporting data annotations, BigQuery links, and event edit rules.

• Deprecated thesharingWithGoogleAnySalesEnabled parameter and certain attribution models.

• Added support for user data retention settings, data access reports (including a new dimension and availability for all properties), SKAdNetwork conversion value schema configuration, and managing key events (replacing ConversionEvent).

For official Google Analytics API announcements, please subscribe toGoogle Analytics API Notify Group.

2025-08-20 AddedGetReportingIdentitySettings method

Added theGetReportingIdentitySettingsmethod to the Admin API v1alpha, which lets you retrieve theReportingIdentitySettingsfor a property.

2025-08-20 Removed legacy Universal Analytics methods

The following legacy Universal Analytics (UA) methods have been removed from theAdmin API v1alpha:SetAutomatedGa4ConfigurationOptOut,FetchAutomatedGa4ConfigurationOptOut,CreateConnectedSiteTag,DeleteConnectedSiteTag,ListConnectedSiteTags, andFetchConnectedGa4Property.

2025-06-12 Added subproperty sync configuration management methods

AddedGetSubpropertySyncConfig,ListSubpropertySyncConfig,andUpdateSubpropertySyncConfigmethods for managingSubpropertySyncConfigresources with the Admin API v1alpha.

2025-04-16 Added Reporting Data Annotation management methods

AddedCreateReportingDataAnnotation,GetReportingDataAnnotation,ListReportingDataAnnotations,UpdateReportingDataAnnotationandDeleteReportingDataAnnotationmethods for managingReportingDataAnnotationresources with the Admin API v1alpha.

Annotations allow usersto add notes directly to Google Analytics reports, making it easier to recordevents, explain changes in data, or highlight key observations for yourself andyour team.

2025-03-07 Deprecating thesharingWithGoogleAnySalesEnabled parameter

ThesharingWithGoogleAnySalesEnabled parameter of thegetDataSharingSettingsmethod is now deprecated and will always returnfalse. The field will beremoved from the Google Analytics Admin API v1beta in June, 2025.

2025-01-20 Added user data retention toDataRetentionSettings

Added theuserDataRetention field toDataRetentionSettings in theAdmin API v1alpha and v1beta. Use this field to retrieve or modify retentionsettings for user data.

2024-09-09 Access Reports survey form

The documentation for therunAccessReportmethod has been updated to include a link to theGoogle Analytics Access Reports feedbackform. We value your input and encourage you to share your thoughts on thisAPI to help us improve it further.

2024-08-01 Added BigQuery link management

AddedCreateBigQueryLink,UpdateBigQueryLink, andDeleteBigQueryLinkmethods for managingBigQueryLink resources withthe Admin API v1alpha.

Added thedataset_location field to theBigQueryLink resource.

Added BigQuery link changes to change history under the newBIGQUERY_LINKvalue inChangeHistoryResourceType.

2024-08-01 Breaking change to thecreateSubproperty method

Renamed thecreateSubproperty custom method toprovisionSubpropertyin the Admin API v1alpha to align withcustom methodguidelines.

2024-08-01 Added event edit rule management

GetEventEditRule,CreateEventEditRule,DeleteEventEditRule,ListEventEditRules,UpdateEventEditRules,ReorderEventEditRules,methods added to the Admin API v1alpha.

AnEventEditRule defines conditions that will trigger the creation of anentirely new event based upon matched criteria of a source event. In addition,anEventEditRule can define modifications of the parameters from the sourceevent.

2024-08-01 Miscellaneous changes

Addedcreate_time to theAudience resource.

Addedprimary to theChannelGroup resource toindicate if the channel group is the default channel group for reports. Only onechannel group can haveprimary set totrue at any given time. Settingprimary totrue for a channel group automatically setsprimary tofalsefor the previous primary channel group.

Addedgmp_organization to theAccountresource, which contains the URI for a Google Marketing Platform organizationresource if the account is connected to a GMP organization.

2024-05-06 Added key events management methods

Resources and methods forkeyevents are now available.

Modify your API integration to useKeyEvent instead ofConversionEvent.ConversionEvent is deprecated.

2023-12-15 Data access reports are now available for all Google Analytics properties.

Certain fields of theData access reports featureare now available for all Google Analytics properties, both Standardand Google Analytics 360 customers.

See theschema documentation for more information.

2023-12-15 TheaccessDateHour dimension added to the Data access report schema.

TheaccessDateHour dimension added to theData access report schema. It contains the date hourof the GA user that accessed GA reporting data.

2023-10-05 Properties with first-click, linear, time-decay and position-based attribution models default to cross-channel DDA.

Starting in mid-October 2023, thefirst-click,linear,time-decayandposition-basedattribution models will be unavailable to use with theUpdateAttributionSettingsmethod for all properties.

If your property is currently configured to use one of these models,it will be changed tocross-channel data-driven attribution.You will still have theoptions to use Cross-channel last click or Ads-preferred lastclick instead.

2023-09-01 Added SKAdNetwork conversion value schema configuration methods.

GetSKAdNetworkConversionValueSchema,CreateSKAdNetworkConversionValueSchema,DeleteSKAdNetworkConversionValueSchema,UpdateSKAdNetworkConversionValueSchema,ListSKAdNetworkConversionValueSchemasmethods added to the Admin API v1alpha.

This functionality allows managing theSKAdNetwork conversion value schemaconfigurationfor an iOS stream.

2023-09-01 AddedUpdateConversionEvent method.

UpdateConversionEventmethod added to the Admin API v1beta.

2023-09-01BigQueryLink.enterprise_export_enabled field renamed tofresh_daily_export_enabled.

Theenterprise_export_enabled field of theBigQueryLink resource renamed tofresh_daily_export_enabled.

2023-07-14 Breaking changes toproperties.updateAttributionSettings,properties.getAttributionSettings methods.

Starting July 24th, 2023, breaking changes will be made to the Admin API v1alpha which will affect the functionality ofproperties.getAttributionSettings,properties.updateAttributionSettingsmethods.

Members of theReportingAttributionModelenum will be renamed as follows:

Members of theAdsWebConversionDataExportScopeenum will be renamed as follows:

2023-07-10 Added theads_web_conversion_data_export_scope field to theAttributionSettings type

Added theads_web_conversion_data_export_scope field to theAttributionSettings type which can be modified using theUpdateAttributionSettingsmethod.

2023-06-05 Deprecation of first-click, linear, time-decay and position-based attribution models.

Starting June 2023, theUpdateAttributionSettingsmethod cannot be used to configure GA4 properties withfirst-click,linear,time-decayandposition-basedattribution models. Starting in September 2023, these models will becomeunavailable for all properties.

Refer to theGoogle Analytics product announcementfor more information.

2023-05-31 Added AdSense links management methods.

GetAdSenseLink,CreateAdSenseLink,DeleteAdSenseLink,ListAdSenseLinksmethods added to the Admin API v1alpha.

This functionality allows managingAdSense to Analytics linksfor a GA4 property.

2023-05-31 Added a method to lookup a connected GA4 property.

TheFetchConnectedGa4Propertymethod added to the Admin API v1alpha

This functionality allows to obtain information about aGA4 property linked your Universal Analytics propertyduring the GA4 migration process.

2023-05-31 Added method to manage event creation rules.

TheCreateEventCreateRule,UpdateEventCreateRule,DeleteEventCreateRule,ListEventCreateRules,GetEventCreateRule methods added to the Admin API v1alpha.

This functionality allows to manageevent creation ruleswhich can trigger the creation of an entirely new event based upon matchedcriteria of a source event.

2023-05-31 Added methods to manage custom channel groups.

AddedGetChannelGroup,ListChannelGroups,CreateChannelGroup,UpdateChannelGroup,DeleteChannelGroupmethods to the Admin API v1alpha.

This functionality allows to managecustom channel groupsfor your website's traffic sources.

Once created, custom channel groups can be queried using theGoogle Analytics Data API v1.

2023-03-31 Added Enhanced Measurement Settings management methods.

Theproperties.dataStreams.updateEnhancedMeasurementSettings,properties.dataStreams.getEnhancedMeasurementSettings methods added to the Admin API v1alpha.

This functionality allows managingEnhanced Measurement Settings for a Web Data Stream of a GA4 property.

2023-03-31 Added Connected Site Tag management methods.

Theproperties.createConnectedSiteTag,properties.deleteConnectedSiteTag,properties.listConnectedSiteTags methods added to the Admin API v1alpha.

This functionality allows managingConnected Site Tags and is useful for forwarding traffic from a Universal Analytics property to a Google Analytics 4 property.

2023-03-31 Added account and property-levelrunAccessReport methods to Admin API v1beta.

Theproperties.runAccessReportandaccounts.runAccessReportmethods added to thev1beta version of the Admin API. Methods return acustomizedreport of data access records.

2023-02-24 Added Expanded Data Sets management methods.

TheExpandedDataSetresource has been added to thev1alpha version of the API, along with the correspondingproperties.expandedDataSets.create,properties.expandedDataSets.delete,properties.expandedDataSets.patch,properties.expandedDataSets.list,properties.expandedDataSets.getoperations. This functionality can be used for managingExpanded Data Sets in Google Analytics 360.

2023-02-24 Access Bindings are replacing User Links for user permissions management.

TheAccessBindingresource has been added to thev1alpha version of the API, along with thefollowing operations:

• 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

This functionality allows managing user permissions for a GA4 account orproperty and should be used instead ofUser Links.

User Links functionality will be removedfrom the Admin API v1 alpha on 6/1/23

2023-02-24 Deprecation of the user permissions audit methods.

The following methods are deprecated and will be removed from the Admin API v1alpha on 6/1/23:

• accounts.userLinks.audit
• properties.userLinks.audit

2023-02-24 Added Audience management methods.

TheAudienceresource has been added to thev1alpha version of the API, along with the correspondingproperties.audience.create,properties.audience.archive,properties.audience.patch,properties.audience.list,properties.audience.getoperations.

This functionality allows managingaudiences for a GA4 property.

2023-02-15 Added automated GA4 setup process opt-out methods.

properties.setAutomatedGa4ConfigurationOptOut,properties.fetchAutomatedGa4ConfigurationOptOut operations have been added to thev1alpha version of the API.

This functionality allows managing theopt out status for the automated GA4setup processfor a UA property.

2023-02-15 Added BigQuery links management methods.

TheBigQueryLinkresource has been added to thev1alpha version of the API, along with thecorrespondingproperties.bigQueryLinks.get,properties.bigQueryLinks.listoperations.

This functionality allows retrieving information aboutlinks between a GA4 Property and a BigQuery project.

2023-02-15 Added Search Ads 360 links management methods.

TheSearchAds360Linkresource has been added to thev1alpha version of the API, along with the correspondingproperties.searchAds360Links.create,properties.searchAds360Links.delete,properties.searchAds360Links.patch,properties.searchAds360Links.list,properties.searchAds360Links.getoperations.

This functionality allows managing links between a GA4 property anda Search Ads 360 entity.

2023-02-15 Breaking changes.

• LESS_THAN_OR_EQUAL,GREATER_THAN_OR_EQUAL values removed from theNumericFilter.Operationenum.

• PARTIAL_REGEXP value removed from theStringFilter.MatchTypeenum.

2023-02-15 Miscellaneous changes.

• tokensPerProjectPerHour field added to theAccessQuotatype.
• EXPANDED_DATA_SET,CHANNEL_GROUP values added to theChangeHistoryResourceTypeenum.
• searchAds360Link,expandedDataSet,bigqueryLink values added toChangeHistoryResource.

2022-08-11runAccessReport method added to Admin API v1alpha.

Theproperties.runAccessReportmethod added to thev1alpha version of the Admin API. It returns acustomized report of data access records. The report provides records of eachtime a user reads Google Analytics reporting data. Data Access Reports areavailable to Administrators of Google Analytics 360 properties.

2022-07-11 Admin API v1beta version released.

Thev1beta versionof the Google Analytics Admin API has been released.

Both Alpha and Beta channels of the API continue to be supported for the AdminAPI. Beta channel contains a subset of the features available in Alpha whichare considered stable and not expected to undergo a significant change in thefuture. New features will be added to Beta once they mature.

2021-10-12 EnhancedMeasurementSettings methods removed from the API.

• properties.webDataStreams.getEnhancedMeasurementSettings,properties.webDataStreams.updateEnhancedMeasurementSettings methods areremoved from the API, butEnhanced Measurementsettings will again be modifiable via API soon.
• ThedirectRoles field of theUserLinkresource no longer supportspredefinedRoles/manage-users role.The newpredefinedRoles/admin role should be used instead, which isequivalent to the combination of the oldpredefinedRoles/edit andpredefinedRoles/manage-users roles. This change affects the behavior ofaccounts.userLinks,properties.userLinksmethods and is in line with theAccess and data-restriction managementchanges introduced in the Google Analytics.

2021-06-05 Features added.

The following features are added to the API:

• accounts.searchChangeHistoryEventsmethod was added to the API. This method searches through all changes to anaccount or its children given the specified set of filters. Common causeswould be updates made in the Google Analytics UI, changes from customersupport, or automatic Google Analytics system changes.
• Measurement protocol secrets management methods added underproperties.webDataStreams.measurementProtocolSecrets:
  • createCreates a measurement protocol secret.
  • deleteDeletes target measurement protocol secret.
  • getLookup for a single measurement protocol secret.
  • listReturns child measurement protocol secrets under the specified parent Property.
  • patchUpdates a measurement protocol secret.
• Conversion events management methods added underproperties.conversionEvents:
  • createCreates a conversion event with the specified attributes.
  • deleteDeletes a conversion event in a property.
  • getRetrieve a single conversion event.
  • listReturns a list of conversion events in the specified parent property.
• Custom dimensions management methods added underproperties.customDimensions:
  • archiveArchives a custom dimension on a property.
  • createCreates a custom dimension.
  • getLookup for a single custom dimension.
  • listLists custom dimensions on a property.
  • patchUpdates a custom dimension on a property.
• Custom metrics management methods added underproperties.customMetrics:
  • archiveArchives a custom metric on a property.
  • createreates a custom metric.
  • getLookup for a single custom metric.
  • listLists custom metrics on a property.
  • patchUpdates a custom metric on a property.
• Addedproperties.getGoogleSignalsSettings,properties.updateGoogleSignalsSettingsmethods that allow to control theGoogle Signalssetting for a Google Analytics 4 property.
• delete_time,expire_timeoutput only fields added to thePropertytype.

2021-06-05 Breaking changes.

The following breaking changes were introduced:

• properties.iosAppDataStreams.create,properties.androidAppDataStreams.createmethods were removed from the API. Please use Firebase to create applicationstreams in a Google Analytics 4 property.
• properties.deletemethod now returns the deleted property data asPropertytype instead of returning an empty response.
• time_zonefield of thePropertytype is now required.
• deleted field removed from thePropertytype.
• email_addressfield of theUserLinktype is now immutable.
• namefield of theUserLinktype is now output only.

2021-01-28 Pagination support added forListFirebaseLinks operation.

2021-01-28 Breaking changes.

Breaking changes: -update_mask field is required for all Update operations.

• country_code field renamed toregion_code inAccount.

• url_query_parameter field renamed touri_query_parameter inEnhancedMeasurementSettings.

• parent field removed fromGoogleAdsLink.

2020-10-20 Added support for account summaries.

Added support foraccount summaries method.

2020-10-13 App + Web properties renamed to Google Analytics 4 (GA4).

2020-08-15 Management App + Web API renamed to Admin API.

Google Analytics Management App + Web API has been renamed tothe Google Analytics Admin API. As a result, the API endpoint has changed toanalyticsadmin.googleapis.com. Existing code written against the previous versionof the API endpoint url and client libraries needs to be updated accordingly.