2022-11-30
▼ ▲ analyticsadmin.accounts.provisionAccountTicket
Description: Requests a ticket for creating an account.
Path: v1beta/accounts:provisionAccountTicket
Flat Path: v1beta/accounts:provisionAccountTicket
HTTP Method: POST
▼ ▲ analyticsadmin.accounts.patch
Parameters:
updateMask
Location: query
Format: google-fieldmask
Type: string
Description: 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 entire entity, use one path with the string "*" to match all fields.
name
Description: Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"
Pattern: ^accounts/[^/]+$
Required: Yes
Type: string
Location: path
Parameter Order: name
HTTP Method: PATCH
Path: v1beta/{+name}
Flat Path: v1beta/accounts/{accountsId}
Scopes: https://www.googleapis.com/auth/analytics.edit
Description: Updates an account.
▼ ▲ analyticsadmin.accounts.getDataSharingSettings
Parameter Order: name
Scopes:
HTTP Method: GET
Flat Path: v1beta/accounts/{accountsId}/dataSharingSettings
Description: Get data sharing settings on an account. Data sharing settings are singletons.
Parameters:
name
Pattern: ^accounts/[^/]+/dataSharingSettings$
Required: Yes
Location: path
Description: Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings"
Type: string
Path: v1beta/{+name}
▼ ▲ analyticsadmin.accounts.searchChangeHistoryEvents
Parameters:
account
Description: Required. The account resource for which to return change history resources.
Location: path
Required: Yes
Pattern: ^accounts/[^/]+$
Type: string
Description: Searches through all changes to an account or its children given the specified set of filters.
Parameter Order: account
Path: v1beta/{+account}:searchChangeHistoryEvents
Flat Path: v1beta/accounts/{accountsId}:searchChangeHistoryEvents
HTTP Method: POST
▼ ▲ analyticsadmin.accounts.delete
Flat Path: v1beta/accounts/{accountsId}
Scopes: https://www.googleapis.com/auth/analytics.edit
HTTP Method: DELETE
Parameters:
name
Required: Yes
Description: Required. The name of the Account to soft-delete. Format: accounts/{account} Example: "accounts/100"
Location: path
Type: string
Pattern: ^accounts/[^/]+$
Parameter Order: name
Description: 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, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.
Path: v1beta/{+name}
▼ ▲ analyticsadmin.accounts.get
Flat Path: v1beta/accounts/{accountsId}
Description: Lookup for a single Account.
Path: v1beta/{+name}
Parameter Order: name
Parameters:
name
Required: Yes
Location: path
Type: string
Description: Required. The name of the account to lookup. Format: accounts/{account} Example: "accounts/100"
Pattern: ^accounts/[^/]+$
Scopes:
HTTP Method: GET
▼ ▲ analyticsadmin.accounts.list
Description: Returns all accounts accessible by the caller. Note that these accounts might not currently have GA4 properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found.
Path: v1beta/accounts
Parameters:
showDeleted
Location: query
Type: boolean
Description: Whether to include soft-deleted (ie: "trashed") Accounts in the results. Accounts can be inspected to determine whether they are deleted or not.
pageToken
Type: string
Location: query
Description: A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.
pageSize
Location: query
Type: integer
Description: 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 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
Format: int32
Scopes:
HTTP Method: GET
Flat Path: v1beta/accounts
▼ ▲ analyticsadmin.accountSummaries.list
Scopes:
HTTP Method: GET
Parameters:
pageToken
Location: query
Description: A page token, received from a previous `ListAccountSummaries` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountSummaries` must match the call that provided the page token.
Type: string
pageSize
Description: The maximum number of AccountSummary resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
Location: query
Format: int32
Type: integer
Path: v1beta/accountSummaries
Description: Returns summaries of all accounts accessible by the caller.
Flat Path: v1beta/accountSummaries
▼ ▲ analyticsadmin.properties.googleAdsLinks.create
Parameters:
parent
Type: string
Description: Required. Example format: properties/1234
Location: path
Pattern: ^properties/[^/]+$
Required: Yes
HTTP Method: POST
Parameter Order: parent
Path: v1beta/{+parent}/googleAdsLinks
Description: Creates a GoogleAdsLink.
Flat Path: v1beta/properties/{propertiesId}/googleAdsLinks
▼ ▲ analyticsadmin.properties.googleAdsLinks.patch
HTTP Method: PATCH
Flat Path: v1beta/properties/{propertiesId}/googleAdsLinks/{googleAdsLinksId}
Parameters:
updateMask
Location: query
Format: google-fieldmask
Type: string
Description: 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 entire entity, use one path with the string "*" to match all fields.
name
Required: Yes
Type: string
Description: Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.
Location: path
Pattern: ^properties/[^/]+/googleAdsLinks/[^/]+$
Parameter Order: name
Scopes: https://www.googleapis.com/auth/analytics.edit
Path: v1beta/{+name}
Description: Updates a GoogleAdsLink on a property
▼ ▲ analyticsadmin.properties.googleAdsLinks.delete
Scopes: https://www.googleapis.com/auth/analytics.edit
HTTP Method: DELETE
Parameter Order: name
Description: Deletes a GoogleAdsLink on a property
Flat Path: v1beta/properties/{propertiesId}/googleAdsLinks/{googleAdsLinksId}
Parameters:
name
Type: string
Description: Required. Example format: properties/1234/googleAdsLinks/5678
Location: path
Pattern: ^properties/[^/]+/googleAdsLinks/[^/]+$
Required: Yes
Path: v1beta/{+name}
▼ ▲ analyticsadmin.properties.googleAdsLinks.list
Parameter Order: parent
Scopes:
Parameters:
parent
Type: string
Required: Yes
Description: Required. Example format: properties/1234
Location: path
Pattern: ^properties/[^/]+$
pageToken
Description: A page token, received from a previous `ListGoogleAdsLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListGoogleAdsLinks` must match the call that provided the page token.
Type: string
Location: query
pageSize
Type: integer
Format: int32
Description: 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 maximum).
Location: query
HTTP Method: GET
Description: Lists GoogleAdsLinks on a property.
Flat Path: v1beta/properties/{propertiesId}/googleAdsLinks
Path: v1beta/{+parent}/googleAdsLinks
▼ ▲ analyticsadmin.properties.conversionEvents.list
Description: Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.
Flat Path: v1beta/properties/{propertiesId}/conversionEvents
HTTP Method: GET
Scopes:
Parameters:
pageSize
Format: int32
Type: integer
Location: query
Description: 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 maximum)
parent
Description: Required. The resource name of the parent property. Example: 'properties/123'
Pattern: ^properties/[^/]+$
Type: string
Location: path
Required: Yes
pageToken
Type: string
Location: query
Description: A page token, received from a previous `ListConversionEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConversionEvents` must match the call that provided the page token.
Parameter Order: parent
Path: v1beta/{+parent}/conversionEvents
▼ ▲ analyticsadmin.properties.conversionEvents.delete
Scopes: https://www.googleapis.com/auth/analytics.edit
Path: v1beta/{+name}
Parameter Order: name
Description: Deletes a conversion event in a property.
Flat Path: v1beta/properties/{propertiesId}/conversionEvents/{conversionEventsId}
Parameters:
name
Description: Required. The resource name of the conversion event to delete. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conversionEvents/456"
Required: Yes
Type: string
Pattern: ^properties/[^/]+/conversionEvents/[^/]+$
Location: path
HTTP Method: DELETE
▼ ▲ analyticsadmin.properties.conversionEvents.create
Flat Path: v1beta/properties/{propertiesId}/conversionEvents
Description: Creates a conversion event with the specified attributes.
Parameter Order: parent
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/analytics.edit
Parameters:
parent
Location: path
Required: Yes
Type: string
Pattern: ^properties/[^/]+$
Description: Required. The resource name of the parent property where this conversion event will be created. Format: properties/123
Path: v1beta/{+parent}/conversionEvents
▼ ▲ analyticsadmin.properties.conversionEvents.get
Flat Path: v1beta/properties/{propertiesId}/conversionEvents/{conversionEventsId}
Description: Retrieve a single conversion event.
HTTP Method: GET
Scopes:
Path: v1beta/{+name}
Parameters:
name
Location: path
Pattern: ^properties/[^/]+/conversionEvents/[^/]+$
Required: Yes
Type: string
Description: Required. The resource name of the conversion event to retrieve. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conversionEvents/456"
Parameter Order: name
▼ ▲ analyticsadmin.properties.firebaseLinks.list
Flat Path: v1beta/properties/{propertiesId}/firebaseLinks
Parameters:
pageToken
Description: A page token, received from a previous `ListFirebaseLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListFirebaseLinks` must match the call that provided the page token.
Location: query
Type: string
pageSize
Type: integer
Location: query
Description: 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 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
Format: int32
parent
Pattern: ^properties/[^/]+$
Description: Required. Format: properties/{property_id} Example: properties/1234
Location: path
Type: string
Required: Yes
Description: Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.
Path: v1beta/{+parent}/firebaseLinks
HTTP Method: GET
Scopes:
Parameter Order: parent
▼ ▲ analyticsadmin.properties.firebaseLinks.delete
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/analytics.edit
Parameter Order: name
Path: v1beta/{+name}
Description: Deletes a FirebaseLink on a property
Parameters:
name
Required: Yes
Description: Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: properties/1234/firebaseLinks/5678
Pattern: ^properties/[^/]+/firebaseLinks/[^/]+$
Location: path
Type: string
Flat Path: v1beta/properties/{propertiesId}/firebaseLinks/{firebaseLinksId}
▼ ▲ analyticsadmin.properties.firebaseLinks.create
Parameter Order: parent
Flat Path: v1beta/properties/{propertiesId}/firebaseLinks
Scopes: https://www.googleapis.com/auth/analytics.edit
HTTP Method: POST
Path: v1beta/{+parent}/firebaseLinks
Parameters:
parent
Location: path
Type: string
Pattern: ^properties/[^/]+$
Description: Required. Format: properties/{property_id} Example: properties/1234
Required: Yes
Description: Creates a FirebaseLink. Properties can have at most one FirebaseLink.
▼ ▲ analyticsadmin.properties.customMetrics.archive
Description: Archives a CustomMetric on a property.
HTTP Method: POST
Parameters:
name
Required: Yes
Pattern: ^properties/[^/]+/customMetrics/[^/]+$
Description: Required. The name of the CustomMetric to archive. Example format: properties/1234/customMetrics/5678
Location: path
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/analytics.edit
Path: v1beta/{+name}:archive
Flat Path: v1beta/properties/{propertiesId}/customMetrics/{customMetricsId}:archive
▼ ▲ analyticsadmin.properties.customMetrics.list
Path: v1beta/{+parent}/customMetrics
Scopes:
HTTP Method: GET
Parameters:
parent
Location: path
Pattern: ^properties/[^/]+$
Description: Required. Example format: properties/1234
Required: Yes
Type: string
pageSize
Location: query
Description: 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 maximum).
Type: integer
Format: int32
pageToken
Location: query
Type: string
Description: A page token, received from a previous `ListCustomMetrics` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomMetrics` must match the call that provided the page token.
Parameter Order: parent
Description: Lists CustomMetrics on a property.
Flat Path: v1beta/properties/{propertiesId}/customMetrics
▼ ▲ analyticsadmin.properties.customMetrics.patch
Path: v1beta/{+name}
Description: Updates a CustomMetric on a property.
Scopes: https://www.googleapis.com/auth/analytics.edit
Parameters:
updateMask
Type: string
Description: 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 fields.
Format: google-fieldmask
Location: query
name
Description: Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}
Pattern: ^properties/[^/]+/customMetrics/[^/]+$
Location: path
Required: Yes
Type: string
Flat Path: v1beta/properties/{propertiesId}/customMetrics/{customMetricsId}
HTTP Method: PATCH
Parameter Order: name
▼ ▲ analyticsadmin.properties.customMetrics.create
Flat Path: v1beta/properties/{propertiesId}/customMetrics
Parameters:
parent
Description: Required. Example format: properties/1234
Pattern: ^properties/[^/]+$
Location: path
Type: string
Required: Yes
Parameter Order: parent
Path: v1beta/{+parent}/customMetrics
Description: Creates a CustomMetric.
Scopes: https://www.googleapis.com/auth/analytics.edit
HTTP Method: POST
▼ ▲ analyticsadmin.properties.customMetrics.get
Flat Path: v1beta/properties/{propertiesId}/customMetrics/{customMetricsId}
Parameter Order: name
Description: Lookup for a single CustomMetric.
HTTP Method: GET
Scopes:
Path: v1beta/{+name}
Parameters:
name
Type: string
Pattern: ^properties/[^/]+/customMetrics/[^/]+$
Location: path
Description: Required. The name of the CustomMetric to get. Example format: properties/1234/customMetrics/5678
Required: Yes
▼ ▲ analyticsadmin.properties.dataStreams.measurementProtocolSecrets.get
Description: Lookup for a single "GA4" MeasurementProtocolSecret.
Parameter Order: name
Flat Path: v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}
Scopes:
Path: v1beta/{+name}
Parameters:
name
Location: path
Required: Yes
Type: string
Pattern: ^properties/[^/]+/dataStreams/[^/]+/measurementProtocolSecrets/[^/]+$
Description: Required. The name of the measurement protocol secret to lookup. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
HTTP Method: GET
▼ ▲ analyticsadmin.properties.dataStreams.measurementProtocolSecrets.list
Description: Returns child MeasurementProtocolSecrets under the specified parent Property.
Path: v1beta/{+parent}/measurementProtocolSecrets
Scopes:
Flat Path: v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets
Parameters:
pageSize
Location: query
Format: int32
Type: integer
Description: 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 coerced to the maximum.
pageToken
Location: query
Description: A page token, received from a previous `ListMeasurementProtocolSecrets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMeasurementProtocolSecrets` must match the call that provided the page token.
Type: string
parent
Required: Yes
Description: Required. The resource name of the parent stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets
Pattern: ^properties/[^/]+/dataStreams/[^/]+$
Location: path
Type: string
Parameter Order: parent
HTTP Method: GET
▼ ▲ analyticsadmin.properties.dataStreams.measurementProtocolSecrets.delete
Path: v1beta/{+name}
Description: Deletes target MeasurementProtocolSecret.
HTTP Method: DELETE
Parameters:
name
Pattern: ^properties/[^/]+/dataStreams/[^/]+/measurementProtocolSecrets/[^/]+$
Required: Yes
Location: path
Type: string
Description: Required. The name of the MeasurementProtocolSecret to delete. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
Scopes: https://www.googleapis.com/auth/analytics.edit
Parameter Order: name
Flat Path: v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}
▼ ▲ analyticsadmin.properties.dataStreams.measurementProtocolSecrets.create
Parameters:
parent
Required: Yes
Location: path
Type: string
Description: Required. The parent resource where this secret will be created. Format: properties/{property}/dataStreams/{dataStream}
Pattern: ^properties/[^/]+/dataStreams/[^/]+$
Description: Creates a measurement protocol secret.
Path: v1beta/{+parent}/measurementProtocolSecrets
HTTP Method: POST
Flat Path: v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets
Parameter Order: parent
▼ ▲ analyticsadmin.properties.dataStreams.measurementProtocolSecrets.patch
Description: Updates a measurement protocol secret.
Scopes: https://www.googleapis.com/auth/analytics.edit
Path: v1beta/{+name}
Parameters:
name
Location: path
Required: Yes
Type: string
Description: Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
Pattern: ^properties/[^/]+/dataStreams/[^/]+/measurementProtocolSecrets/[^/]+$
updateMask
Type: string
Format: google-fieldmask
Location: query
Description: The list of fields to be updated. Omitted fields will not be updated.
Parameter Order: name
HTTP Method: PATCH
Flat Path: v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}
▼ ▲ analyticsadmin.properties.dataStreams.delete
Flat Path: v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}
Parameter Order: name
Parameters:
name
Type: string
Location: path
Pattern: ^properties/[^/]+/dataStreams/[^/]+$
Description: Required. The name of the DataStream to delete. Example format: properties/1234/dataStreams/5678
Required: Yes
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/analytics.edit
Description: Deletes a DataStream on a property.
Path: v1beta/{+name}
▼ ▲ analyticsadmin.properties.dataStreams.list
Scopes:
Parameters:
pageToken
Type: string
Location: query
Description: A page token, received from a previous `ListDataStreams` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDataStreams` must match the call that provided the page token.
parent
Required: Yes
Location: path
Pattern: ^properties/[^/]+$
Description: Required. Example format: properties/1234
Type: string
pageSize
Description: 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 maximum).
Format: int32
Location: query
Type: integer
Description: Lists DataStreams on a property.
HTTP Method: GET
Parameter Order: parent
Flat Path: v1beta/properties/{propertiesId}/dataStreams
Path: v1beta/{+parent}/dataStreams
▼ ▲ analyticsadmin.properties.dataStreams.patch
Scopes: https://www.googleapis.com/auth/analytics.edit
Path: v1beta/{+name}
HTTP Method: PATCH
Parameter Order: name
Parameters:
updateMask
Type: string
Description: 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 fields.
Format: google-fieldmask
Location: query
name
Type: string
Description: Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000"
Pattern: ^properties/[^/]+/dataStreams/[^/]+$
Location: path
Required: Yes
Flat Path: v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}
Description: Updates a DataStream on a property.
▼ ▲ analyticsadmin.properties.dataStreams.get
Parameter Order: name
Description: Lookup for a single DataStream.
Flat Path: v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}
HTTP Method: GET
Scopes:
Path: v1beta/{+name}
Parameters:
name
Pattern: ^properties/[^/]+/dataStreams/[^/]+$
Type: string
Location: path
Required: Yes
Description: Required. The name of the DataStream to get. Example format: properties/1234/dataStreams/5678
▼ ▲ analyticsadmin.properties.dataStreams.create
Scopes: https://www.googleapis.com/auth/analytics.edit
Parameters:
parent
Description: Required. Example format: properties/1234
Type: string
Location: path
Required: Yes
Pattern: ^properties/[^/]+$
Parameter Order: parent
HTTP Method: POST
Flat Path: v1beta/properties/{propertiesId}/dataStreams
Description: Creates a DataStream.
Path: v1beta/{+parent}/dataStreams
▼ ▲ analyticsadmin.properties.customDimensions.get
Path: v1beta/{+name}
Flat Path: v1beta/properties/{propertiesId}/customDimensions/{customDimensionsId}
Scopes:
HTTP Method: GET
Parameters:
name
Location: path
Required: Yes
Pattern: ^properties/[^/]+/customDimensions/[^/]+$
Description: Required. The name of the CustomDimension to get. Example format: properties/1234/customDimensions/5678
Type: string
Parameter Order: name
Description: Lookup for a single CustomDimension.
▼ ▲ analyticsadmin.properties.customDimensions.create
Flat Path: v1beta/properties/{propertiesId}/customDimensions
Description: Creates a CustomDimension.
Parameter Order: parent
Path: v1beta/{+parent}/customDimensions
Parameters:
parent
Location: path
Type: string
Required: Yes
Pattern: ^properties/[^/]+$
Description: Required. Example format: properties/1234
HTTP Method: POST
▼ ▲ analyticsadmin.properties.customDimensions.list
HTTP Method: GET
Description: Lists CustomDimensions on a property.
Path: v1beta/{+parent}/customDimensions
Scopes:
Parameter Order: parent
Parameters:
parent
Location: path
Description: Required. Example format: properties/1234
Required: Yes
Type: string
Pattern: ^properties/[^/]+$
pageSize
Location: query
Description: 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 maximum).
Format: int32
Type: integer
pageToken
Type: string
Location: query
Description: A page token, received from a previous `ListCustomDimensions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomDimensions` must match the call that provided the page token.
Flat Path: v1beta/properties/{propertiesId}/customDimensions
▼ ▲ analyticsadmin.properties.customDimensions.archive
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/analytics.edit
Flat Path: v1beta/properties/{propertiesId}/customDimensions/{customDimensionsId}:archive
Description: Archives a CustomDimension on a property.
Parameters:
name
Required: Yes
Location: path
Description: Required. The name of the CustomDimension to archive. Example format: properties/1234/customDimensions/5678
Type: string
Pattern: ^properties/[^/]+/customDimensions/[^/]+$
Parameter Order: name
Path: v1beta/{+name}:archive
▼ ▲ analyticsadmin.properties.customDimensions.patch
HTTP Method: PATCH
Description: Updates a CustomDimension on a property.
Flat Path: v1beta/properties/{propertiesId}/customDimensions/{customDimensionsId}
Parameters:
updateMask
Location: query
Type: string
Format: google-fieldmask
Description: 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 fields.
name
Pattern: ^properties/[^/]+/customDimensions/[^/]+$
Required: Yes
Description: Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}
Type: string
Location: path
Scopes: https://www.googleapis.com/auth/analytics.edit
Parameter Order: name
Path: v1beta/{+name}
▼ ▲ analyticsadmin.properties.get
HTTP Method: GET
Parameter Order: name
Flat Path: v1beta/properties/{propertiesId}
Description: Lookup for a single "GA4" Property.
Parameters:
name
Description: Required. The name of the property to lookup. Format: properties/{property_id} Example: "properties/1000"
Required: Yes
Type: string
Location: path
Pattern: ^properties/[^/]+$
Path: v1beta/{+name}
Scopes:
▼ ▲ analyticsadmin.properties.patch
Flat Path: v1beta/properties/{propertiesId}
HTTP Method: PATCH
Path: v1beta/{+name}
Parameters:
name
Required: Yes
Pattern: ^properties/[^/]+$
Description: Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
Location: path
Type: string
updateMask
Location: query
Format: google-fieldmask
Type: string
Description: 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 entire entity, use one path with the string "*" to match all fields.
Parameter Order: name
Scopes: https://www.googleapis.com/auth/analytics.edit
Description: Updates a property.
▼ ▲ analyticsadmin.properties.getDataRetentionSettings
Description: Returns the singleton data retention settings for this property.
Parameters:
name
Location: path
Type: string
Required: Yes
Pattern: ^properties/[^/]+/dataRetentionSettings$
Description: Required. The name of the settings to lookup. Format: properties/{property}/dataRetentionSettings Example: "properties/1000/dataRetentionSettings"
Parameter Order: name
Path: v1beta/{+name}
Flat Path: v1beta/properties/{propertiesId}/dataRetentionSettings
HTTP Method: GET
Scopes:
▼ ▲ analyticsadmin.properties.updateDataRetentionSettings
Parameter Order: name
Scopes: https://www.googleapis.com/auth/analytics.edit
Flat Path: v1beta/properties/{propertiesId}/dataRetentionSettings
Description: Updates the singleton data retention settings for this property.
Path: v1beta/{+name}
HTTP Method: PATCH
Parameters:
updateMask
Description: 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 entire entity, use one path with the string "*" to match all fields.
Type: string
Format: google-fieldmask
Location: query
name
Location: path
Pattern: ^properties/[^/]+/dataRetentionSettings$
Required: Yes
Type: string
Description: Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
▼ ▲ analyticsadmin.properties.create
Flat Path: v1beta/properties
Path: v1beta/properties
Scopes: https://www.googleapis.com/auth/analytics.edit
Description: Creates an "GA4" property with the specified location and attributes.
HTTP Method: POST
▼ ▲ analyticsadmin.properties.list
Parameters:
showDeleted
Location: query
Type: boolean
Description: Whether to include soft-deleted (ie: "trashed") Properties in the results. Properties can be inspected to determine whether they are deleted or not.
filter
Location: query
Type: string
Description: Required. An expression for filtering the results of the request. Fields eligible for filtering are: `parent:`(The resource name of the parent account/property) or `ancestor:`(The resource name of the parent account) or `firebase_project:`(The id or number of the linked firebase project). Some examples of filters: ``` | Filter | Description | |-----------------------------|-------------------------------------------| | parent:accounts/123 | The account with account id: 123. | | parent:properties/123 | The property with property id: 123. | | ancestor:accounts/123 | The account with account id: 123. | | firebase_project:project-id | The firebase project with id: project-id. | | firebase_project:123 | The firebase project with number: 123. | ```
pageSize
Type: integer
Location: query
Format: int32
Description: 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 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
pageToken
Location: query
Description: A page token, received from a previous `ListProperties` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProperties` must match the call that provided the page token.
Type: string
HTTP Method: GET
Path: v1beta/properties
Flat Path: v1beta/properties
Description: Returns child Properties under the specified parent Account. Only "GA4" properties will be returned. 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.
Scopes:
▼ ▲ analyticsadmin.properties.delete
Parameters:
name
Location: path
Description: Required. The name of the Property to soft-delete. Format: properties/{property_id} Example: "properties/1000"
Pattern: ^properties/[^/]+$
Type: string
Required: Yes
Path: v1beta/{+name}
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/analytics.edit
Parameter Order: name
Flat Path: v1beta/properties/{propertiesId}
Description: 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, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found, or is not a GA4 Property.
▼ ▲ analyticsadmin.properties.acknowledgeUserDataCollection
Description: Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or via this API) before MeasurementProtocolSecret resources may be created.
Parameter Order: property
Path: v1beta/{+property}:acknowledgeUserDataCollection
Parameters:
property
Location: path
Required: Yes
Description: Required. The property for which to acknowledge user data collection.
Pattern: ^properties/[^/]+$
Type: string
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/analytics.edit
Flat Path: v1beta/properties/{propertiesId}:acknowledgeUserDataCollection