All 55 methods of the Analytics Admin API, rendered at build time from the committed Discovery index the grr binary embeds — the same data grr api describe reads at runtime. Flags are kebab-cased parameter names: userId is --user-id.
Returns summaries of all accounts accessible by the caller.
Parameter
Type
Required
Repeated
Location
Description
Enum values
pageSize
integer
—
—
query
Optional. The maximum number of AccountSummary resources to return. The service may return fewer than this value, even if there are additional pages. If unspeci
—
pageToken
string
—
—
query
Optional. A page token, received from a previous ListAccountSummaries call. Provide this to retrieve the subsequent page. When paginating, all other parameter
Marks target Account as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.
Parameter
Type
Required
Repeated
Location
Description
Enum values
name
string
yes
—
path
Required. The name of the Account to soft-delete. Format: accounts/{account} Example: "accounts/100"
Returns all accounts accessible by the caller. Note that these accounts might not currently have GA properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found. Note: The easiest way to retrieve a list of all properties you have access to is by using ListAccountSummaries.
Parameter
Type
Required
Repeated
Location
Description
Enum values
pageSize
integer
—
—
query
Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 5
—
pageToken
string
—
—
query
Optional. A page token, received from a previous ListAccounts call. Provide this to retrieve the subsequent page. When paginating, all other parameters provid
—
showDeleted
boolean
—
—
query
Whether to include soft-deleted (ie: "trashed") Accounts in the results. Accounts can be inspected to determine whether they are deleted or not.
Identifier. Resource name of this account. Format: accounts/{account} Example: "accounts/100"
—
updateMask
string
—
—
query
Required. The list of fields to be updated. Field names must be in snake case (for example, "field_to_update"). Omitted fields will not be updated. To replace t
Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Explorations, GA Data API, and other products like Firebase & Admob that can retrieve data from Google Analyti
Parameter
Type
Required
Repeated
Location
Description
Enum values
entity
string
yes
—
path
The Data Access Report supports requesting at the property level or account level. If requested at the account level, Data Access Reports include all access for
Searches through all changes to an account or its children given the specified set of filters. Only returns the subset of changes supported by the API. The UI may return additional changes.
Parameter
Type
Required
Repeated
Location
Description
Enum values
account
string
yes
—
path
Required. The account resource for which to return change history resources. Format: accounts/{account} Example: accounts/100
Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or through this API) before MeasurementProtocolSecret resources may be created.
Parameter
Type
Required
Repeated
Location
Description
Enum values
property
string
yes
—
path
Required. The property for which to acknowledge user data collection.
Marks target Property as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.
Parameter
Type
Required
Repeated
Location
Description
Enum values
name
string
yes
—
path
Required. The name of the Property to soft-delete. Format: properties/{property_id} Example: "properties/1000"
Returns child Properties under the specified parent Account. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found.
Parameter
Type
Required
Repeated
Location
Description
Enum values
filter
string
—
—
query
Required. An expression for filtering the results of the request. Fields eligible for filtering are: parent:(The resource name of the parent account/property)
—
pageSize
integer
—
—
query
Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 5
—
pageToken
string
—
—
query
Optional. A page token, received from a previous ListProperties call. Provide this to retrieve the subsequent page. When paginating, all other parameters prov
—
showDeleted
boolean
—
—
query
Whether to include soft-deleted (ie: "trashed") Properties in the results. Properties can be inspected to determine whether they are deleted or not.
Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
—
updateMask
string
—
—
query
Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the enti
Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Explorations, GA Data API, and other products like Firebase & Admob that can retrieve data from Google Analyti
Parameter
Type
Required
Repeated
Location
Description
Enum values
entity
string
yes
—
path
The Data Access Report supports requesting at the property level or account level. If requested at the account level, Data Access Reports include all access for
Updates the singleton data retention settings for this property.
Parameter
Type
Required
Repeated
Location
Description
Enum values
name
string
yes
—
path
Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
—
updateMask
string
—
—
query
Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the enti
Deprecated: Use DeleteKeyEvent instead. Deletes a conversion event in a property.
Parameter
Type
Required
Repeated
Location
Description
Enum values
name
string
yes
—
path
Required. The resource name of the conversion event to delete. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conver
Deprecated: Use GetKeyEvent instead. Retrieve a single conversion event.
Parameter
Type
Required
Repeated
Location
Description
Enum values
name
string
yes
—
path
Required. The resource name of the conversion event to retrieve. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conv
Deprecated: Use ListKeyEvents instead. Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.
Parameter
Type
Required
Repeated
Location
Description
Enum values
pageSize
integer
—
—
query
Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coe
—
pageToken
string
—
—
query
Optional. A page token, received from a previous ListConversionEvents call. Provide this to retrieve the subsequent page. When paginating, all other parameter
—
parent
string
yes
—
path
Required. The resource name of the parent property. Example: 'properties/123'
Deprecated: Use UpdateKeyEvent instead. Updates a conversion event with the specified attributes.
Parameter
Type
Required
Repeated
Location
Description
Enum values
name
string
yes
—
path
Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}
—
updateMask
string
—
—
query
Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the enti
Creates a CustomDimension. Warning: It's not permissible to use this method to collect data on individual users. In particular, sending user IDs in custom dimensions violates the Google Analytics Terms of Service.
Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coer
—
pageToken
string
—
—
query
Optional. A page token, received from a previous ListCustomDimensions call. Provide this to retrieve the subsequent page. When paginating, all other parameter
Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}
—
updateMask
string
—
—
query
Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fiel
The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the
—
pageToken
string
—
—
query
A page token, received from a previous ListCustomMetrics call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to
Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}
—
updateMask
string
—
—
query
Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fiel
The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the
—
pageToken
string
—
—
query
A page token, received from a previous ListDataStreams call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to
Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000"
—
updateMask
string
—
—
query
Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fiel
Required. The name of the MeasurementProtocolSecret to delete. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementPro
Required. The name of the measurement protocol secret to lookup. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementP
Returns child MeasurementProtocolSecrets under the specified parent Property.
Parameter
Type
Required
Repeated
Location
Description
Enum values
pageSize
integer
—
—
query
Optional. The maximum number of resources to return. If unspecified, at most 10 resources will be returned. The maximum value is 10. Higher values will be coerc
—
pageToken
string
—
—
query
Optional. A page token, received from a previous ListMeasurementProtocolSecrets call. Provide this to retrieve the subsequent page. When paginating, all other
—
parent
string
yes
—
path
Required. The resource name of the parent stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets
Identifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementPr
—
updateMask
string
—
—
query
Required. The list of fields to be updated. Omitted fields will not be updated.
Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.
Parameter
Type
Required
Repeated
Location
Description
Enum values
pageSize
integer
—
—
query
Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 5
—
pageToken
string
—
—
query
Optional. A page token, received from a previous ListFirebaseLinks call. Provide this to retrieve the subsequent page. When paginating, all other parameters p
Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coer
—
pageToken
string
—
—
query
Optional. A page token, received from a previous ListGoogleAdsLinks call. Provide this to retrieve the subsequent page. When paginating, all other parameters
Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.
—
updateMask
string
—
—
query
Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the enti
Returns a list of Key Events in the specified parent property. Returns an empty list if no Key Events are found.
Parameter
Type
Required
Repeated
Location
Description
Enum values
pageSize
integer
—
—
query
Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coe
—
pageToken
string
—
—
query
Optional. A page token, received from a previous ListKeyEvents call. Provide this to retrieve the subsequent page. When paginating, all other parameters provi
—
parent
string
yes
—
path
Required. The resource name of the parent property. Example: 'properties/123'
Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}
—
updateMask
string
—
—
query
Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the enti
