For official Google Analytics API announcements, please subscribe to Google Analytics API Notify Group.
2024-09-09 Access Reports survey form
The documentation for the
runAccessReport
method has been updated to include a link to the
Google Analytics Access Reports feedback
form. We value your input and encourage you to share your thoughts on this
API to help us improve it further.
2024-08-01 Added BigQuery link management
Added CreateBigQueryLink
, UpdateBigQueryLink
, and DeleteBigQueryLink
methods for managing
BigQueryLink
resources with
the Admin API v1alpha.
Added the dataset_location
field to the BigQueryLink
resource.
Added BigQuery link changes to change history under the new BIGQUERY_LINK
value in
ChangeHistoryResourceType
.
2024-08-01 Breaking change to the createSubproperty
method
Renamed the createSubproperty
custom method to
provisionSubproperty
in the Admin API v1alpha to align with custom method
guidelines.
2024-08-01 Added event edit rule management
GetEventEditRule
,
CreateEventEditRule
,
DeleteEventEditRule
,
ListEventEditRules
,
UpdateEventEditRules
,
ReorderEventEditRules
,
methods added to the Admin API v1alpha.
An EventEditRule
defines conditions that will trigger the creation of an
entirely new event based upon matched criteria of a source event. In addition,
an EventEditRule
can define modifications of the parameters from the source
event.
2024-08-01 Miscellaneous changes
Added create_time
to the
Audience
resource.
Added primary
to the
ChannelGroup
resource to
indicate if the channel group is the default channel group for reports. Only one
channel group can have primary
set to true
at any given time. Setting
primary
to true
for a channel group automatically sets primary
to false
for the previous primary channel group.
Added gmp_organization
to the Account
resource, which contains the URI for a Google Marketing Platform organization
resource if the account is connected to a GMP organization.
2024-05-06 Added key events management methods
Resources and methods for key events are now available.
Modify your API integration to use
KeyEvent
instead of
ConversionEvent
.
ConversionEvent
is deprecated.
2023-12-15 Data access reports are now available for all Google Analytics properties.
Certain fields of the Data access reports feature are now available for all Google Analytics properties, both Standard and Google Analytics 360 customers.
See the schema documentation for more information.
2023-12-15 The accessDateHour
dimension added to the Data access report schema.
The accessDateHour
dimension added to the
Data access report schema. It contains the date hour
of 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, the first-click, linear, time-decay and position-based attribution models will be unavailable to use with the UpdateAttributionSettings method for all properties.
If your property is currently configured to use one of these models, it will be changed to cross-channel data-driven attribution. You will still have the options to use Cross-channel last click or Ads-preferred last click instead.
2023-09-01 Added SKAdNetwork conversion value schema configuration methods.
GetSKAdNetworkConversionValueSchema
,
CreateSKAdNetworkConversionValueSchema
,
DeleteSKAdNetworkConversionValueSchema
,
UpdateSKAdNetworkConversionValueSchema
,
ListSKAdNetworkConversionValueSchemas
methods added to the Admin API v1alpha.
This functionality allows managing the SKAdNetwork conversion value schema configuration for an iOS stream.
2023-09-01 Added UpdateConversionEvent
method.
UpdateConversionEvent
method added to the Admin API v1beta.
2023-09-01 BigQueryLink.enterprise_export_enabled
field renamed to fresh_daily_export_enabled
.
The enterprise_export_enabled
field of the BigQueryLink
resource renamed to
fresh_daily_export_enabled
.
2023-07-14 Breaking changes to properties.updateAttributionSettings
, properties.getAttributionSettings
methods.
Starting July 24th, 2023, breaking changes will be made to the Admin API v1 alpha which will affect the functionality of properties.getAttributionSettings, properties.updateAttributionSettings methods.
Members of the ReportingAttributionModel
enum will be renamed as follows:
Old name | New name |
---|---|
CROSS_CHANNEL_DATA_DRIVEN |
PAID_AND_ORGANIC_CHANNELS_DATA_DRIVEN |
CROSS_CHANNEL_LAST_CLICK |
PAID_AND_ORGANIC_CHANNELS_LAST_CLICK |
CROSS_CHANNEL_FIRST_CLICK |
PAID_AND_ORGANIC_CHANNELS_FIRST_CLICK |
CROSS_CHANNEL_LINEAR |
PAID_AND_ORGANIC_CHANNELS_LINEAR |
CROSS_CHANNEL_POSITION_BASED |
PAID_AND_ORGANIC_CHANNELS_POSITION_BASED |
CROSS_CHANNEL_TIME_DECAY |
PAID_AND_ORGANIC_CHANNELS_TIME_DECAY |
ADS_PREFERRED_LAST_CLICK |
GOOGLE_PAID_CHANNELS_LAST_CLICK |
Members of the AdsWebConversionDataExportScope
enum will be renamed as follows:
Old name | New name |
---|---|
CROSS_CHANNEL |
PAID_AND_ORGANIC_CHANNELS |
ADS_PREFERRED |
GOOGLE_PAID_CHANNELS |
2023-07-10 Added the ads_web_conversion_data_export_scope
field to the AttributionSettings
type
Added the ads_web_conversion_data_export_scope
field to the
AttributionSettings
type which can be modified using the
UpdateAttributionSettings
method.
2023-06-05 Deprecation of first-click, linear, time-decay and position-based attribution models.
Starting June 2023, the UpdateAttributionSettings method cannot be used to configure GA4 properties with first-click, linear, time-decay and position-based attribution models. Starting in September 2023, these models will become unavailable for all properties.
Refer to the Google Analytics product announcement for more information.
2023-05-31 Added AdSense links management methods.
GetAdSenseLink
,
CreateAdSenseLink
,
DeleteAdSenseLink
,
ListAdSenseLinks
methods added to the Admin API v1alpha.
This functionality allows managing AdSense to Analytics links for a GA4 property.
2023-05-31 Added a method to lookup a connected GA4 property.
The FetchConnectedGa4Property
method added to the Admin API v1alpha
This functionality allows to obtain information about a GA4 property linked your Universal Analytics property during the GA4 migration process.
2023-05-31 Added method to manage event creation rules.
The CreateEventCreateRule
,
UpdateEventCreateRule
,
DeleteEventCreateRule
,
ListEventCreateRules
,
GetEventCreateRule
methods added to the Admin API v1alpha.
This functionality allows to manage event creation rules which can trigger the creation of an entirely new event based upon matched criteria of a source event.
2023-05-31 Added methods to manage custom channel groups.
Added GetChannelGroup
,
ListChannelGroups
,
CreateChannelGroup
,
UpdateChannelGroup
,
DeleteChannelGroup
methods to the Admin API v1alpha.
This functionality allows to manage custom channel groups for your website's traffic sources.
Once created, custom channel groups can be queried using the Google Analytics Data API v1.
2023-03-31 Added Enhanced Measurement Settings management methods.
The properties.dataStreams.updateEnhancedMeasurementSettings
, properties.dataStreams.getEnhancedMeasurementSettings
methods added to the Admin API v1alpha.
This functionality allows managing Enhanced Measurement Settings for a Web Data Stream of a GA4 property.
2023-03-31 Added Connected Site Tag management methods.
The properties.createConnectedSiteTag
, properties.deleteConnectedSiteTag
, properties.listConnectedSiteTags
methods added to the Admin API v1alpha.
This functionality allows managing Connected 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-level runAccessReport
methods to Admin API v1beta.
The properties.runAccessReport
and accounts.runAccessReport
methods added to the v1beta version of the Admin API. Methods return a
customized report of data access records.
2023-02-24 Added Expanded Data Sets management methods.
The ExpandedDataSet
resource has been added to the v1alpha version of the API, along with the corresponding properties.expandedDataSets.create
,
properties.expandedDataSets.delete
,
properties.expandedDataSets.patch
,
properties.expandedDataSets.list
,
properties.expandedDataSets.get
operations. This functionality can be used for managing Expanded Data Sets in Google Analytics 360.
2023-02-24 Access Bindings are replacing User Links for user permissions management.
The AccessBinding
resource has been added to the v1alpha version of the API, along with the
following 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 or property and should be used instead of User Links.
User Links functionality will be removed from 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 v1 alpha on 6/1/23:
2023-02-24 Added Audience management methods.
The Audience
resource has been added to the v1alpha version of the API, along with the corresponding properties.audience.create
,
properties.audience.archive
,
properties.audience.patch
,
properties.audience.list
,
properties.audience.get
operations.
This functionality allows managing audiences for a GA4 property.
2023-02-15 Added automated GA4 setup process opt-out methods.
properties.setAutomatedGa4ConfigurationOptOut
,
properties.fetchAutomatedGa4ConfigurationOptOut
operations have been added to the v1alpha version of the API.
This functionality allows managing the opt out status for the automated GA4 setup process for a UA property.
2023-02-15 Added BigQuery links management methods.
The BigQueryLink
resource has been added to the v1alpha version of the API, along with the
corresponding properties.bigQueryLinks.get
,
properties.bigQueryLinks.list
operations.
This functionality allows retrieving information about links between a GA4 Property and a BigQuery project.
2023-02-15 Added Search Ads 360 links management methods.
The SearchAds360Link
resource has been added to the v1alpha version of the API, along with the corresponding properties.searchAds360Links.create
,
properties.searchAds360Links.delete
,
properties.searchAds360Links.patch
,
properties.searchAds360Links.list
,
properties.searchAds360Links.get
operations.
This functionality allows managing links between a GA4 property and a Search Ads 360 entity.
2023-02-15 Breaking changes.
LESS_THAN_OR_EQUAL
,GREATER_THAN_OR_EQUAL
values removed from theNumericFilter.Operation
enum.PARTIAL_REGEXP
value removed from theStringFilter.MatchType
enum.
2023-02-15 Miscellaneous changes.
tokensPerProjectPerHour
field added to theAccessQuota
type.EXPANDED_DATA_SET
,CHANNEL_GROUP
values added to theChangeHistoryResourceType
enum.searchAds360Link
,expandedDataSet
,bigqueryLink
values added toChangeHistoryResource
.
2022-08-11 runAccessReport
method added to Admin API v1alpha.
The properties.runAccessReport
method added to the v1alpha version of the Admin API. It returns a
customized report of data access records. The report provides records of each
time a user reads Google Analytics reporting data. Data Access Reports are
available to Administrators of Google Analytics 360 properties.
2022-07-11 Admin API v1beta version released.
The v1beta version of the Google Analytics Admin API has been released.
Both Alpha and Beta channels of the API continue to be supported for the Admin API. 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.
2021-10-12 EnhancedMeasurementSettings methods removed from the API.
properties.webDataStreams.getEnhancedMeasurementSettings
,properties.webDataStreams.updateEnhancedMeasurementSettings
methods are removed from the API, but Enhanced Measurement settings will again be modifiable via API soon.- The
directRoles
field of theUserLink
resource no longer supportspredefinedRoles/manage-users
role. The newpredefinedRoles/admin
role should be used instead, which is equivalent to the combination of the oldpredefinedRoles/edit
andpredefinedRoles/manage-users
roles. This change affects the behavior ofaccounts.userLinks
,properties.userLinks
methods and is in line with the Access and data-restriction management changes introduced in the Google Analytics.
2021-06-05 Features added.
The following features are added to the API:
accounts.searchChangeHistoryEvents
method was added to the API. This method searches through all changes to an account or its children given the specified set of filters. Common causes would be updates made in the Google Analytics UI, changes from customer support, or automatic Google Analytics system changes.- Measurement protocol secrets management methods added under
properties.webDataStreams.measurementProtocolSecrets
: - Conversion events management methods added under
properties.conversionEvents
: - Custom dimensions management methods added under
properties.customDimensions
: - Custom metrics management methods added under
properties.customMetrics
: - Added
properties.getGoogleSignalsSettings
,properties.updateGoogleSignalsSettings
methods that allow to control the Google Signals setting for a Google Analytics 4 property. delete_time
,expire_time
output only fields added to theProperty
type.
2021-06-05 Breaking changes.
The following breaking changes were introduced:
properties.iosAppDataStreams.create
,properties.androidAppDataStreams.create
methods were removed from the API. Please use Firebase to create application streams in a Google Analytics 4 property.properties.delete
method now returns the deleted property data asProperty
type instead of returning an empty response.time_zone
field of theProperty
type is now required.deleted
field removed from theProperty
type.email_address
field of theUserLink
type is now immutable.name
field of theUserLink
type is now output only.
2021-01-28 Pagination support added for ListFirebaseLinks
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 for account 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 to the Google Analytics Admin API. As a result, the API endpoint has changed to analyticsadmin.googleapis.com. Existing code written against the previous version of the API endpoint url and client libraries needs to be updated accordingly.