api reference · v1beta

Every Analytics Admin method, from the index.

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.

55 methods · v1beta · revision 20260923

`analyticsadmin.accounts`

8 methods

`analyticsadmin.accounts.delete`

DELETE

grr analyticsadmin accounts delete v1beta/{+name}

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: Propertie

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"	—

https://www.googleapis.com/auth/analytics.edit least privilege

1 scope

https://www.googleapis.com/auth/analytics.edit

grr analyticsadmin accounts delete

grr analyticsadmin accounts delete --name <name>

`analyticsadmin.accounts.get`

GET

grr analyticsadmin accounts get v1beta/{+name}

Lookup for a single Account.

Parameter	Type	Required	Repeated	Location	Description	Enum values
`name`	string	yes	—	path	Required. The name of the account to lookup. Format: accounts/{account} Example: "accounts/100"	—

https://www.googleapis.com/auth/analytics.readonly least privilege

2 scopes

https://www.googleapis.com/auth/analytics.edit
https://www.googleapis.com/auth/analytics.readonly

grr analyticsadmin accounts get

grr analyticsadmin accounts get --name <name>

`analyticsadmin.accounts.getDataSharingSettings`

GET

grr analyticsadmin accounts getDataSharingSettings v1beta/{+name}

Get data sharing settings on an account. Data sharing settings are singletons.

Parameter	Type	Required	Repeated	Location	Description	Enum values
`name`	string	yes	—	path	Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: `accounts/1000/dataSharingSettings`	—

https://www.googleapis.com/auth/analytics.readonly least privilege

2 scopes

https://www.googleapis.com/auth/analytics.edit
https://www.googleapis.com/auth/analytics.readonly

grr analyticsadmin accounts getDataSharingSettings

grr analyticsadmin accounts getDataSharingSettings --name <name>

`analyticsadmin.accounts.list`

GET

grr analyticsadmin accounts list v1beta/accounts

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

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.	—

https://www.googleapis.com/auth/analytics.readonly least privilege

2 scopes

https://www.googleapis.com/auth/analytics.edit
https://www.googleapis.com/auth/analytics.readonly

grr analyticsadmin accounts list

grr analyticsadmin accounts list

`analyticsadmin.accounts.patch`

PATCH

grr analyticsadmin accounts patch v1beta/{+name}

Updates an account.

Parameter	Type	Required	Repeated	Location	Description	Enum values
`name`	string	yes	—	path	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	—

https://www.googleapis.com/auth/analytics.edit least privilege

1 scope

https://www.googleapis.com/auth/analytics.edit

grr analyticsadmin accounts patch

grr analyticsadmin accounts patch --name <name> --body-file ./body.json

`analyticsadmin.accounts.provisionAccountTicket`

POST

grr analyticsadmin accounts provisionAccountTicket v1beta/accounts:provisionAccountTicket

Requests a ticket for creating an account.

No parameters.

https://www.googleapis.com/auth/analytics.edit least privilege

1 scope

https://www.googleapis.com/auth/analytics.edit

grr analyticsadmin accounts provisionAccountTicket

grr analyticsadmin accounts provisionAccountTicket --body-file ./body.json

`analyticsadmin.accounts.runAccessReport`

POST

grr analyticsadmin accounts runAccessReport v1beta/{+entity}:runAccessReport

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 tha

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	—

https://www.googleapis.com/auth/analytics.readonly least privilege

2 scopes

https://www.googleapis.com/auth/analytics.edit
https://www.googleapis.com/auth/analytics.readonly

grr analyticsadmin accounts runAccessReport

grr analyticsadmin accounts runAccessReport --entity <entity> --body-file ./body.json

`analyticsadmin.accounts.searchChangeHistoryEvents`

POST

grr analyticsadmin accounts searchChangeHistoryEvents v1beta/{+account}:searchChangeHistoryEvents

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`	—

https://www.googleapis.com/auth/analytics.edit least privilege

1 scope

https://www.googleapis.com/auth/analytics.edit

grr analyticsadmin accounts searchChangeHistoryEvents

grr analyticsadmin accounts searchChangeHistoryEvents --account <account> --body-file ./body.json

`analyticsadmin.accountSummaries`

1 method

`analyticsadmin.accountSummaries.list`

GET

grr analyticsadmin accountSummaries list v1beta/accountSummaries

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	—

https://www.googleapis.com/auth/analytics.readonly least privilege

2 scopes

https://www.googleapis.com/auth/analytics.edit
https://www.googleapis.com/auth/analytics.readonly

grr analyticsadmin accountSummaries list

grr analyticsadmin accountSummaries list

`analyticsadmin.properties`

9 methods

`analyticsadmin.properties.acknowledgeUserDataCollection`

POST

grr analyticsadmin properties acknowledgeUserDataCollection v1beta/{+property}:acknowledgeUserDataCollection

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.	—

https://www.googleapis.com/auth/analytics.edit least privilege

1 scope

https://www.googleapis.com/auth/analytics.edit

grr analyticsadmin properties acknowledgeUserDataCollection

grr analyticsadmin properties acknowledgeUserDataCollection --property <property> --body-file ./body.json

`analyticsadmin.properties.create`

POST

grr analyticsadmin properties create v1beta/properties

Creates a Google Analytics property with the specified location and attributes.

No parameters.

https://www.googleapis.com/auth/analytics.edit least privilege

1 scope

https://www.googleapis.com/auth/analytics.edit

grr analyticsadmin properties create

grr analyticsadmin properties create --body-file ./body.json

`analyticsadmin.properties.delete`

DELETE

grr analyticsadmin properties delete v1beta/{+name}

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: Goo

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"	—

https://www.googleapis.com/auth/analytics.edit least privilege

1 scope

https://www.googleapis.com/auth/analytics.edit

grr analyticsadmin properties delete

grr analyticsadmin properties delete --name <name>

`analyticsadmin.properties.get`

GET

grr analyticsadmin properties get v1beta/{+name}

Lookup for a single GA Property.

Parameter	Type	Required	Repeated	Location	Description	Enum values
`name`	string	yes	—	path	Required. The name of the property to lookup. Format: properties/{property_id} Example: "properties/1000"	—

https://www.googleapis.com/auth/analytics.readonly least privilege

2 scopes

https://www.googleapis.com/auth/analytics.edit
https://www.googleapis.com/auth/analytics.readonly

grr analyticsadmin properties get

grr analyticsadmin properties get --name <name>

`analyticsadmin.properties.getDataRetentionSettings`

GET

grr analyticsadmin properties getDataRetentionSettings v1beta/{+name}

Returns the singleton data retention settings for this property.

Parameter	Type	Required	Repeated	Location	Description	Enum values
`name`	string	yes	—	path	Required. The name of the settings to lookup. Format: properties/{property}/dataRetentionSettings Example: "properties/1000/dataRetentionSettings"	—

https://www.googleapis.com/auth/analytics.readonly least privilege

2 scopes

https://www.googleapis.com/auth/analytics.edit
https://www.googleapis.com/auth/analytics.readonly

grr analyticsadmin properties getDataRetentionSettings

grr analyticsadmin properties getDataRetentionSettings --name <name>

`analyticsadmin.properties.list`

GET

grr analyticsadmin properties list v1beta/properties

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.	—

https://www.googleapis.com/auth/analytics.readonly least privilege

2 scopes

https://www.googleapis.com/auth/analytics.edit
https://www.googleapis.com/auth/analytics.readonly

grr analyticsadmin properties list

grr analyticsadmin properties list

`analyticsadmin.properties.patch`

PATCH

grr analyticsadmin properties patch v1beta/{+name}

Updates a property.

Parameter	Type	Required	Repeated	Location	Description	Enum values
`name`	string	yes	—	path	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	—

https://www.googleapis.com/auth/analytics.edit least privilege

1 scope

https://www.googleapis.com/auth/analytics.edit

grr analyticsadmin properties patch

grr analyticsadmin properties patch --name <name> --body-file ./body.json

`analyticsadmin.properties.runAccessReport`

POST

grr analyticsadmin properties runAccessReport v1beta/{+entity}:runAccessReport

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	—

https://www.googleapis.com/auth/analytics.readonly least privilege

2 scopes

https://www.googleapis.com/auth/analytics.edit
https://www.googleapis.com/auth/analytics.readonly

grr analyticsadmin properties runAccessReport

grr analyticsadmin properties runAccessReport --entity <entity> --body-file ./body.json

`analyticsadmin.properties.updateDataRetentionSettings`

PATCH

grr analyticsadmin properties updateDataRetentionSettings v1beta/{+name}

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	—

https://www.googleapis.com/auth/analytics.edit least privilege

1 scope

https://www.googleapis.com/auth/analytics.edit

grr analyticsadmin properties updateDataRetentionSettings

grr analyticsadmin properties updateDataRetentionSettings --name <name> --body-file ./body.json

`analyticsadmin.properties.conversionEvents`

5 methods

`analyticsadmin.properties.conversionEvents.create`

POST

grr analyticsadmin properties conversionEvents create v1beta/{+parent}/conversionEvents

Deprecated: Use `CreateKeyEvent` instead. Creates a conversion event with the specified attributes.

Parameter	Type	Required	Repeated	Location	Description	Enum values
`parent`	string	yes	—	path	Required. The resource name of the parent property where this conversion event will be created. Format: properties/123	—

https://www.googleapis.com/auth/analytics.edit least privilege

1 scope

https://www.googleapis.com/auth/analytics.edit

grr analyticsadmin properties conversionEvents create

grr analyticsadmin properties conversionEvents create --parent <parent> --body-file ./body.json

`analyticsadmin.properties.conversionEvents.delete`

DELETE

grr analyticsadmin properties conversionEvents delete v1beta/{+name}

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	—

https://www.googleapis.com/auth/analytics.edit least privilege

1 scope

https://www.googleapis.com/auth/analytics.edit

grr analyticsadmin properties conversionEvents delete

grr analyticsadmin properties conversionEvents delete --name <name>

`analyticsadmin.properties.conversionEvents.get`

GET

grr analyticsadmin properties conversionEvents get v1beta/{+name}

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	—

https://www.googleapis.com/auth/analytics.readonly least privilege

2 scopes

https://www.googleapis.com/auth/analytics.edit
https://www.googleapis.com/auth/analytics.readonly

grr analyticsadmin properties conversionEvents get

grr analyticsadmin properties conversionEvents get --name <name>

`analyticsadmin.properties.conversionEvents.list`

GET

grr analyticsadmin properties conversionEvents list v1beta/{+parent}/conversionEvents

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'	—

https://www.googleapis.com/auth/analytics.readonly least privilege

2 scopes

https://www.googleapis.com/auth/analytics.edit
https://www.googleapis.com/auth/analytics.readonly

grr analyticsadmin properties conversionEvents list

grr analyticsadmin properties conversionEvents list --parent <parent>

`analyticsadmin.properties.conversionEvents.patch`

PATCH

grr analyticsadmin properties conversionEvents patch v1beta/{+name}

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	—

https://www.googleapis.com/auth/analytics.edit least privilege

1 scope

https://www.googleapis.com/auth/analytics.edit

grr analyticsadmin properties conversionEvents patch

grr analyticsadmin properties conversionEvents patch --name <name> --body-file ./body.json

`analyticsadmin.properties.customDimensions`

5 methods

`analyticsadmin.properties.customDimensions.archive`

POST

grr analyticsadmin properties customDimensions archive v1beta/{+name}:archive

Archives a CustomDimension on a property.

Parameter	Type	Required	Repeated	Location	Description	Enum values
`name`	string	yes	—	path	Required. The name of the CustomDimension to archive. Example format: properties/1234/customDimensions/5678	—

https://www.googleapis.com/auth/analytics.edit least privilege

1 scope

https://www.googleapis.com/auth/analytics.edit

grr analyticsadmin properties customDimensions archive

grr analyticsadmin properties customDimensions archive --name <name> --body-file ./body.json

`analyticsadmin.properties.customDimensions.create`

POST

grr analyticsadmin properties customDimensions create v1beta/{+parent}/customDimensions

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.

Parameter	Type	Required	Repeated	Location	Description	Enum values
`parent`	string	yes	—	path	Required. Example format: properties/1234	—

https://www.googleapis.com/auth/analytics.edit least privilege

1 scope

https://www.googleapis.com/auth/analytics.edit

grr analyticsadmin properties customDimensions create

grr analyticsadmin properties customDimensions create --parent <parent> --body-file ./body.json

`analyticsadmin.properties.customDimensions.get`

GET

grr analyticsadmin properties customDimensions get v1beta/{+name}

Lookup for a single CustomDimension.

Parameter	Type	Required	Repeated	Location	Description	Enum values
`name`	string	yes	—	path	Required. The name of the CustomDimension to get. Example format: properties/1234/customDimensions/5678	—

https://www.googleapis.com/auth/analytics.readonly least privilege

2 scopes

https://www.googleapis.com/auth/analytics.edit
https://www.googleapis.com/auth/analytics.readonly

grr analyticsadmin properties customDimensions get

grr analyticsadmin properties customDimensions get --name <name>

`analyticsadmin.properties.customDimensions.list`

GET

grr analyticsadmin properties customDimensions list v1beta/{+parent}/customDimensions

Lists CustomDimensions on a property.

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 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	—
`parent`	string	yes	—	path	Required. Example format: properties/1234	—

https://www.googleapis.com/auth/analytics.readonly least privilege

2 scopes

https://www.googleapis.com/auth/analytics.edit
https://www.googleapis.com/auth/analytics.readonly

grr analyticsadmin properties customDimensions list

grr analyticsadmin properties customDimensions list --parent <parent>

`analyticsadmin.properties.customDimensions.patch`

PATCH

grr analyticsadmin properties customDimensions patch v1beta/{+name}

Updates a CustomDimension on a property.

Parameter	Type	Required	Repeated	Location	Description	Enum values
`name`	string	yes	—	path	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	—

https://www.googleapis.com/auth/analytics.edit least privilege

1 scope

https://www.googleapis.com/auth/analytics.edit

grr analyticsadmin properties customDimensions patch

grr analyticsadmin properties customDimensions patch --name <name> --body-file ./body.json

`analyticsadmin.properties.customMetrics`

5 methods

`analyticsadmin.properties.customMetrics.archive`

POST

grr analyticsadmin properties customMetrics archive v1beta/{+name}:archive

Archives a CustomMetric on a property.

Parameter	Type	Required	Repeated	Location	Description	Enum values
`name`	string	yes	—	path	Required. The name of the CustomMetric to archive. Example format: properties/1234/customMetrics/5678	—

https://www.googleapis.com/auth/analytics.edit least privilege

1 scope

https://www.googleapis.com/auth/analytics.edit

grr analyticsadmin properties customMetrics archive

grr analyticsadmin properties customMetrics archive --name <name> --body-file ./body.json

`analyticsadmin.properties.customMetrics.create`

POST

grr analyticsadmin properties customMetrics create v1beta/{+parent}/customMetrics

Creates a CustomMetric.

Parameter	Type	Required	Repeated	Location	Description	Enum values
`parent`	string	yes	—	path	Required. Example format: properties/1234	—

https://www.googleapis.com/auth/analytics.edit least privilege

1 scope

https://www.googleapis.com/auth/analytics.edit

grr analyticsadmin properties customMetrics create

grr analyticsadmin properties customMetrics create --parent <parent> --body-file ./body.json

`analyticsadmin.properties.customMetrics.get`

GET

grr analyticsadmin properties customMetrics get v1beta/{+name}

Lookup for a single CustomMetric.

Parameter	Type	Required	Repeated	Location	Description	Enum values
`name`	string	yes	—	path	Required. The name of the CustomMetric to get. Example format: properties/1234/customMetrics/5678	—

https://www.googleapis.com/auth/analytics.readonly least privilege

2 scopes

https://www.googleapis.com/auth/analytics.edit
https://www.googleapis.com/auth/analytics.readonly

grr analyticsadmin properties customMetrics get

grr analyticsadmin properties customMetrics get --name <name>

`analyticsadmin.properties.customMetrics.list`

GET

grr analyticsadmin properties customMetrics list v1beta/{+parent}/customMetrics

Lists CustomMetrics on a property.

Parameter	Type	Required	Repeated	Location	Description	Enum values
`pageSize`	integer	—	—	query	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	—
`parent`	string	yes	—	path	Required. Example format: properties/1234	—

https://www.googleapis.com/auth/analytics.readonly least privilege

2 scopes

https://www.googleapis.com/auth/analytics.edit
https://www.googleapis.com/auth/analytics.readonly

grr analyticsadmin properties customMetrics list

grr analyticsadmin properties customMetrics list --parent <parent>

`analyticsadmin.properties.customMetrics.patch`

PATCH

grr analyticsadmin properties customMetrics patch v1beta/{+name}

Updates a CustomMetric on a property.

Parameter	Type	Required	Repeated	Location	Description	Enum values
`name`	string	yes	—	path	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	—

https://www.googleapis.com/auth/analytics.edit least privilege

1 scope

https://www.googleapis.com/auth/analytics.edit

grr analyticsadmin properties customMetrics patch

grr analyticsadmin properties customMetrics patch --name <name> --body-file ./body.json

`analyticsadmin.properties.dataStreams`

5 methods

`analyticsadmin.properties.dataStreams.create`

POST

grr analyticsadmin properties dataStreams create v1beta/{+parent}/dataStreams

Creates a DataStream.

Parameter	Type	Required	Repeated	Location	Description	Enum values
`parent`	string	yes	—	path	Required. Example format: properties/1234	—

https://www.googleapis.com/auth/analytics.edit least privilege

1 scope

https://www.googleapis.com/auth/analytics.edit

grr analyticsadmin properties dataStreams create

grr analyticsadmin properties dataStreams create --parent <parent> --body-file ./body.json

`analyticsadmin.properties.dataStreams.delete`

DELETE

grr analyticsadmin properties dataStreams delete v1beta/{+name}

Deletes a DataStream on a property.

Parameter	Type	Required	Repeated	Location	Description	Enum values
`name`	string	yes	—	path	Required. The name of the DataStream to delete. Example format: properties/1234/dataStreams/5678	—

https://www.googleapis.com/auth/analytics.edit least privilege

1 scope

https://www.googleapis.com/auth/analytics.edit

grr analyticsadmin properties dataStreams delete

grr analyticsadmin properties dataStreams delete --name <name>

`analyticsadmin.properties.dataStreams.get`

GET

grr analyticsadmin properties dataStreams get v1beta/{+name}

Lookup for a single DataStream.

Parameter	Type	Required	Repeated	Location	Description	Enum values
`name`	string	yes	—	path	Required. The name of the DataStream to get. Example format: properties/1234/dataStreams/5678	—

https://www.googleapis.com/auth/analytics.readonly least privilege

2 scopes

https://www.googleapis.com/auth/analytics.edit
https://www.googleapis.com/auth/analytics.readonly

grr analyticsadmin properties dataStreams get

grr analyticsadmin properties dataStreams get --name <name>

`analyticsadmin.properties.dataStreams.list`

GET

grr analyticsadmin properties dataStreams list v1beta/{+parent}/dataStreams

Lists DataStreams on a property.

Parameter	Type	Required	Repeated	Location	Description	Enum values
`pageSize`	integer	—	—	query	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 `	—
`parent`	string	yes	—	path	Required. Example format: properties/1234	—

https://www.googleapis.com/auth/analytics.readonly least privilege

2 scopes

https://www.googleapis.com/auth/analytics.edit
https://www.googleapis.com/auth/analytics.readonly

grr analyticsadmin properties dataStreams list

grr analyticsadmin properties dataStreams list --parent <parent>

`analyticsadmin.properties.dataStreams.patch`

PATCH

grr analyticsadmin properties dataStreams patch v1beta/{+name}

Updates a DataStream on a property.

Parameter	Type	Required	Repeated	Location	Description	Enum values
`name`	string	yes	—	path	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	—

https://www.googleapis.com/auth/analytics.edit least privilege

1 scope

https://www.googleapis.com/auth/analytics.edit

grr analyticsadmin properties dataStreams patch

grr analyticsadmin properties dataStreams patch --name <name> --body-file ./body.json

`analyticsadmin.properties.dataStreams.measurementProtocolSecrets`

5 methods

`analyticsadmin.properties.dataStreams.measurementProtocolSecrets.create`

POST

grr analyticsadmin properties dataStreams measurementProtocolSecrets create v1beta/{+parent}/measurementProtocolSecrets

Creates a measurement protocol secret.

Parameter	Type	Required	Repeated	Location	Description	Enum values
`parent`	string	yes	—	path	Required. The parent resource where this secret will be created. Format: properties/{property}/dataStreams/{dataStream}	—

https://www.googleapis.com/auth/analytics.edit least privilege

1 scope

https://www.googleapis.com/auth/analytics.edit

grr analyticsadmin properties dataStreams measurementProtocolSecrets create

grr analyticsadmin properties dataStreams measurementProtocolSecrets create --parent <parent> --body-file ./body.json

`analyticsadmin.properties.dataStreams.measurementProtocolSecrets.delete`

DELETE

grr analyticsadmin properties dataStreams measurementProtocolSecrets delete v1beta/{+name}

Deletes target MeasurementProtocolSecret.

Parameter	Type	Required	Repeated	Location	Description	Enum values
`name`	string	yes	—	path	Required. The name of the MeasurementProtocolSecret to delete. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementPro	—

https://www.googleapis.com/auth/analytics.edit least privilege

1 scope

https://www.googleapis.com/auth/analytics.edit

grr analyticsadmin properties dataStreams measurementProtocolSecrets delete

grr analyticsadmin properties dataStreams measurementProtocolSecrets delete --name <name>

`analyticsadmin.properties.dataStreams.measurementProtocolSecrets.get`

GET

grr analyticsadmin properties dataStreams measurementProtocolSecrets get v1beta/{+name}

Lookup for a single MeasurementProtocolSecret.

Parameter	Type	Required	Repeated	Location	Description	Enum values
`name`	string	yes	—	path	Required. The name of the measurement protocol secret to lookup. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementP	—

https://www.googleapis.com/auth/analytics.readonly least privilege

2 scopes

https://www.googleapis.com/auth/analytics.edit
https://www.googleapis.com/auth/analytics.readonly

grr analyticsadmin properties dataStreams measurementProtocolSecrets get

grr analyticsadmin properties dataStreams measurementProtocolSecrets get --name <name>

`analyticsadmin.properties.dataStreams.measurementProtocolSecrets.list`

GET

grr analyticsadmin properties dataStreams measurementProtocolSecrets list v1beta/{+parent}/measurementProtocolSecrets

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	—

https://www.googleapis.com/auth/analytics.readonly least privilege

2 scopes

https://www.googleapis.com/auth/analytics.edit
https://www.googleapis.com/auth/analytics.readonly

grr analyticsadmin properties dataStreams measurementProtocolSecrets list

grr analyticsadmin properties dataStreams measurementProtocolSecrets list --parent <parent>

`analyticsadmin.properties.dataStreams.measurementProtocolSecrets.patch`

PATCH

grr analyticsadmin properties dataStreams measurementProtocolSecrets patch v1beta/{+name}

Updates a measurement protocol secret.

Parameter	Type	Required	Repeated	Location	Description	Enum values
`name`	string	yes	—	path	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.	—

https://www.googleapis.com/auth/analytics.edit least privilege

1 scope

https://www.googleapis.com/auth/analytics.edit

grr analyticsadmin properties dataStreams measurementProtocolSecrets patch

grr analyticsadmin properties dataStreams measurementProtocolSecrets patch --name <name> --body-file ./body.json

`analyticsadmin.properties.firebaseLinks`

3 methods

`analyticsadmin.properties.firebaseLinks.create`

POST

grr analyticsadmin properties firebaseLinks create v1beta/{+parent}/firebaseLinks

Creates a FirebaseLink. Properties can have at most one FirebaseLink.

Parameter	Type	Required	Repeated	Location	Description	Enum values
`parent`	string	yes	—	path	Required. Format: properties/{property_id} Example: `properties/1234`	—

https://www.googleapis.com/auth/analytics.edit least privilege

1 scope

https://www.googleapis.com/auth/analytics.edit

grr analyticsadmin properties firebaseLinks create

grr analyticsadmin properties firebaseLinks create --parent <parent> --body-file ./body.json

`analyticsadmin.properties.firebaseLinks.delete`

DELETE

grr analyticsadmin properties firebaseLinks delete v1beta/{+name}

Deletes a FirebaseLink on a property

Parameter	Type	Required	Repeated	Location	Description	Enum values
`name`	string	yes	—	path	Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: `properties/1234/firebaseLinks/5678`	—

https://www.googleapis.com/auth/analytics.edit least privilege

1 scope

https://www.googleapis.com/auth/analytics.edit

grr analyticsadmin properties firebaseLinks delete

grr analyticsadmin properties firebaseLinks delete --name <name>

`analyticsadmin.properties.firebaseLinks.list`

GET

grr analyticsadmin properties firebaseLinks list v1beta/{+parent}/firebaseLinks

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	—
`parent`	string	yes	—	path	Required. Format: properties/{property_id} Example: `properties/1234`	—

https://www.googleapis.com/auth/analytics.readonly least privilege

2 scopes

https://www.googleapis.com/auth/analytics.edit
https://www.googleapis.com/auth/analytics.readonly

grr analyticsadmin properties firebaseLinks list

grr analyticsadmin properties firebaseLinks list --parent <parent>

`analyticsadmin.properties.googleAdsLinks`

4 methods

`analyticsadmin.properties.googleAdsLinks.create`

POST

grr analyticsadmin properties googleAdsLinks create v1beta/{+parent}/googleAdsLinks

Creates a GoogleAdsLink.

Parameter	Type	Required	Repeated	Location	Description	Enum values
`parent`	string	yes	—	path	Required. Example format: properties/1234	—

https://www.googleapis.com/auth/analytics.edit least privilege

1 scope

https://www.googleapis.com/auth/analytics.edit

grr analyticsadmin properties googleAdsLinks create

grr analyticsadmin properties googleAdsLinks create --parent <parent> --body-file ./body.json

`analyticsadmin.properties.googleAdsLinks.delete`

DELETE

grr analyticsadmin properties googleAdsLinks delete v1beta/{+name}

Deletes a GoogleAdsLink on a property

Parameter	Type	Required	Repeated	Location	Description	Enum values
`name`	string	yes	—	path	Required. Example format: properties/1234/googleAdsLinks/5678	—

https://www.googleapis.com/auth/analytics.edit least privilege

1 scope

https://www.googleapis.com/auth/analytics.edit

grr analyticsadmin properties googleAdsLinks delete

grr analyticsadmin properties googleAdsLinks delete --name <name>

`analyticsadmin.properties.googleAdsLinks.list`

GET

grr analyticsadmin properties googleAdsLinks list v1beta/{+parent}/googleAdsLinks

Lists GoogleAdsLinks on a property.

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 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	—
`parent`	string	yes	—	path	Required. Example format: properties/1234	—

https://www.googleapis.com/auth/analytics.readonly least privilege

2 scopes

https://www.googleapis.com/auth/analytics.edit
https://www.googleapis.com/auth/analytics.readonly

grr analyticsadmin properties googleAdsLinks list

grr analyticsadmin properties googleAdsLinks list --parent <parent>

`analyticsadmin.properties.googleAdsLinks.patch`

PATCH

grr analyticsadmin properties googleAdsLinks patch v1beta/{+name}

Updates a GoogleAdsLink on a property

Parameter	Type	Required	Repeated	Location	Description	Enum values
`name`	string	yes	—	path	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	—

https://www.googleapis.com/auth/analytics.edit least privilege

1 scope

https://www.googleapis.com/auth/analytics.edit

grr analyticsadmin properties googleAdsLinks patch

grr analyticsadmin properties googleAdsLinks patch --name <name> --body-file ./body.json

`analyticsadmin.properties.keyEvents`

5 methods

`analyticsadmin.properties.keyEvents.create`

POST

grr analyticsadmin properties keyEvents create v1beta/{+parent}/keyEvents

Creates a Key Event.

Parameter	Type	Required	Repeated	Location	Description	Enum values
`parent`	string	yes	—	path	Required. The resource name of the parent property where this Key Event will be created. Format: properties/123	—

https://www.googleapis.com/auth/analytics.edit least privilege

1 scope

https://www.googleapis.com/auth/analytics.edit

grr analyticsadmin properties keyEvents create

grr analyticsadmin properties keyEvents create --parent <parent> --body-file ./body.json

`analyticsadmin.properties.keyEvents.delete`

DELETE

grr analyticsadmin properties keyEvents delete v1beta/{+name}

Deletes a Key Event.

Parameter	Type	Required	Repeated	Location	Description	Enum values
`name`	string	yes	—	path	Required. The resource name of the Key Event to delete. Format: properties/{property}/keyEvents/{key_event} Example: "properties/123/keyEvents/456"	—

https://www.googleapis.com/auth/analytics.edit least privilege

1 scope

https://www.googleapis.com/auth/analytics.edit

grr analyticsadmin properties keyEvents delete

grr analyticsadmin properties keyEvents delete --name <name>

`analyticsadmin.properties.keyEvents.get`

GET

grr analyticsadmin properties keyEvents get v1beta/{+name}

Retrieves a single Key Event.

Parameter	Type	Required	Repeated	Location	Description	Enum values
`name`	string	yes	—	path	Required. The resource name of the Key Event to retrieve. Format: properties/{property}/keyEvents/{key_event} Example: "properties/123/keyEvents/456"	—

https://www.googleapis.com/auth/analytics.readonly least privilege

2 scopes

https://www.googleapis.com/auth/analytics.edit
https://www.googleapis.com/auth/analytics.readonly

grr analyticsadmin properties keyEvents get

grr analyticsadmin properties keyEvents get --name <name>

`analyticsadmin.properties.keyEvents.list`

GET

grr analyticsadmin properties keyEvents list v1beta/{+parent}/keyEvents

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'	—

https://www.googleapis.com/auth/analytics.readonly least privilege

2 scopes

https://www.googleapis.com/auth/analytics.edit
https://www.googleapis.com/auth/analytics.readonly

grr analyticsadmin properties keyEvents list

grr analyticsadmin properties keyEvents list --parent <parent>

`analyticsadmin.properties.keyEvents.patch`

PATCH

grr analyticsadmin properties keyEvents patch v1beta/{+name}

Updates a Key Event.

Parameter	Type	Required	Repeated	Location	Description	Enum values
`name`	string	yes	—	path	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	—

https://www.googleapis.com/auth/analytics.edit least privilege

1 scope

https://www.googleapis.com/auth/analytics.edit

grr analyticsadmin properties keyEvents patch

grr analyticsadmin properties keyEvents patch --name <name> --body-file ./body.json