Package google.analytics.admin.v1alpha

Index

AnalyticsAdminService

Service Interface for the Analytics Admin API (GA4).

AcknowledgeUserDataCollection

rpc AcknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest) returns (AcknowledgeUserDataCollectionResponse)

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.

Authorization scopes

Requires the following OAuth scope:

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

rpc ApproveDisplayVideo360AdvertiserLinkProposal(ApproveDisplayVideo360AdvertiserLinkProposalRequest) returns (ApproveDisplayVideo360AdvertiserLinkProposalResponse)

Approves a DisplayVideo360AdvertiserLinkProposal. The DisplayVideo360AdvertiserLinkProposal will be deleted and a new DisplayVideo360AdvertiserLink will be created.

Authorization scopes

Requires the following OAuth scope:

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

rpc ArchiveAudience(ArchiveAudienceRequest) returns (Empty)

Archives an Audience on a property.

Authorization scopes

Requires the following OAuth scope:

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

rpc ArchiveCustomDimension(ArchiveCustomDimensionRequest) returns (Empty)

Archives a CustomDimension on a property.

Authorization scopes

Requires the following OAuth scope:

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

rpc ArchiveCustomMetric(ArchiveCustomMetricRequest) returns (Empty)

Archives a CustomMetric on a property.

Authorization scopes

Requires the following OAuth scope:

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

rpc BatchCreateAccessBindings(BatchCreateAccessBindingsRequest) returns (BatchCreateAccessBindingsResponse)

Creates information about multiple access bindings to an account or property.

This method is transactional. If any AccessBinding cannot be created, none of the AccessBindings will be created.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.manage.users
BatchDeleteAccessBindings

rpc BatchDeleteAccessBindings(BatchDeleteAccessBindingsRequest) returns (Empty)

Deletes information about multiple users' links to an account or property.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.manage.users
BatchGetAccessBindings

rpc BatchGetAccessBindings(BatchGetAccessBindingsRequest) returns (BatchGetAccessBindingsResponse)

Gets information about multiple access bindings to an account or property.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.manage.users.readonly
  • https://www.googleapis.com/auth/analytics.manage.users
BatchUpdateAccessBindings

rpc BatchUpdateAccessBindings(BatchUpdateAccessBindingsRequest) returns (BatchUpdateAccessBindingsResponse)

Updates information about multiple access bindings to an account or property.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.manage.users
CancelDisplayVideo360AdvertiserLinkProposal

rpc CancelDisplayVideo360AdvertiserLinkProposal(CancelDisplayVideo360AdvertiserLinkProposalRequest) returns (DisplayVideo360AdvertiserLinkProposal)

Cancels a DisplayVideo360AdvertiserLinkProposal. Cancelling can mean either: - Declining a proposal initiated from Display & Video 360 - Withdrawing a proposal initiated from Google Analytics After being cancelled, a proposal will eventually be deleted automatically.

Authorization scopes

Requires the following OAuth scope:

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

rpc CreateAccessBinding(CreateAccessBindingRequest) returns (AccessBinding)

Creates an access binding on an account or property.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.manage.users
CreateAudience

rpc CreateAudience(CreateAudienceRequest) returns (Audience)

Creates an Audience.

Authorization scopes

Requires the following OAuth scope:

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

rpc CreateCalculatedMetric(CreateCalculatedMetricRequest) returns (CalculatedMetric)

Creates a CalculatedMetric.

Authorization scopes

Requires the following OAuth scope:

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

rpc CreateChannelGroup(CreateChannelGroupRequest) returns (ChannelGroup)

Creates a ChannelGroup.

Authorization scopes

Requires the following OAuth scope:

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

rpc CreateConnectedSiteTag(CreateConnectedSiteTagRequest) returns (CreateConnectedSiteTagResponse)

Creates a connected site tag for a Universal Analytics property. You can create a maximum of 20 connected site tags per property. Note: This API cannot be used on GA4 properties.

Authorization scopes

Requires the following OAuth scope:

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

rpc CreateConversionEvent(CreateConversionEventRequest) returns (ConversionEvent)

Creates a conversion event with the specified attributes.

Authorization scopes

Requires the following OAuth scope:

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

rpc CreateCustomDimension(CreateCustomDimensionRequest) returns (CustomDimension)

Creates a CustomDimension.

Authorization scopes

Requires the following OAuth scope:

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

rpc CreateCustomMetric(CreateCustomMetricRequest) returns (CustomMetric)

Creates a CustomMetric.

Authorization scopes

Requires the following OAuth scope:

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

rpc CreateDataStream(CreateDataStreamRequest) returns (DataStream)

Creates a DataStream.

Authorization scopes

Requires the following OAuth scope:

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

rpc CreateDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest) returns (DisplayVideo360AdvertiserLinkProposal)

Creates a DisplayVideo360AdvertiserLinkProposal.

Authorization scopes

Requires the following OAuth scope:

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

rpc CreateEventCreateRule(CreateEventCreateRuleRequest) returns (EventCreateRule)

Creates an EventCreateRule.

Authorization scopes

Requires the following OAuth scope:

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

rpc CreateExpandedDataSet(CreateExpandedDataSetRequest) returns (ExpandedDataSet)

Creates a ExpandedDataSet.

Authorization scopes

Requires the following OAuth scope:

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

rpc CreateKeyEvent(CreateKeyEventRequest) returns (KeyEvent)

Creates a Key Event.

Authorization scopes

Requires the following OAuth scope:

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

rpc CreateMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret)

Creates a measurement protocol secret.

Authorization scopes

Requires the following OAuth scope:

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

rpc CreateProperty(CreatePropertyRequest) returns (Property)

Creates an "GA4" property with the specified location and attributes.

Authorization scopes

Requires the following OAuth scope:

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

rpc CreateRollupProperty(CreateRollupPropertyRequest) returns (CreateRollupPropertyResponse)

Create a roll-up property and all roll-up property source links.

Authorization scopes

Requires the following OAuth scope:

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

rpc CreateSKAdNetworkConversionValueSchema(CreateSKAdNetworkConversionValueSchemaRequest) returns (SKAdNetworkConversionValueSchema)

Creates a SKAdNetworkConversionValueSchema.

Authorization scopes

Requires the following OAuth scope:

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

rpc CreateSubproperty(CreateSubpropertyRequest) returns (CreateSubpropertyResponse)

Create a subproperty and a subproperty event filter that applies to the created subproperty.

Authorization scopes

Requires the following OAuth scope:

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

rpc CreateSubpropertyEventFilter(CreateSubpropertyEventFilterRequest) returns (SubpropertyEventFilter)

Creates a subproperty Event Filter.

Authorization scopes

Requires the following OAuth scope:

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

rpc DeleteAccessBinding(DeleteAccessBindingRequest) returns (Empty)

Deletes an access binding on an account or property.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.manage.users
DeleteAccount

rpc DeleteAccount(DeleteAccountRequest) returns (Empty)

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.

Authorization scopes

Requires the following OAuth scope:

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

rpc DeleteCalculatedMetric(DeleteCalculatedMetricRequest) returns (Empty)

Deletes a CalculatedMetric on a property.

Authorization scopes

Requires the following OAuth scope:

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

rpc DeleteChannelGroup(DeleteChannelGroupRequest) returns (Empty)

Deletes a ChannelGroup on a property.

Authorization scopes

Requires the following OAuth scope:

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

rpc DeleteConnectedSiteTag(DeleteConnectedSiteTagRequest) returns (Empty)

Deletes a connected site tag for a Universal Analytics property. Note: this has no effect on GA4 properties.

Authorization scopes

Requires the following OAuth scope:

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

rpc DeleteConversionEvent(DeleteConversionEventRequest) returns (Empty)

Deletes a conversion event in a property.

Authorization scopes

Requires the following OAuth scope:

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

rpc DeleteDataStream(DeleteDataStreamRequest) returns (Empty)

Deletes a DataStream on a property.

Authorization scopes

Requires the following OAuth scope:

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

rpc DeleteDisplayVideo360AdvertiserLinkProposal(DeleteDisplayVideo360AdvertiserLinkProposalRequest) returns (Empty)

Deletes a DisplayVideo360AdvertiserLinkProposal on a property. This can only be used on cancelled proposals.

Authorization scopes

Requires the following OAuth scope:

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

rpc DeleteEventCreateRule(DeleteEventCreateRuleRequest) returns (Empty)

Deletes an EventCreateRule.

Authorization scopes

Requires the following OAuth scope:

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

rpc DeleteExpandedDataSet(DeleteExpandedDataSetRequest) returns (Empty)

Deletes a ExpandedDataSet on a property.

Authorization scopes

Requires the following OAuth scope:

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

rpc DeleteKeyEvent(DeleteKeyEventRequest) returns (Empty)

Deletes a Key Event.

Authorization scopes

Requires the following OAuth scope:

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

rpc DeleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest) returns (Empty)

Deletes target MeasurementProtocolSecret.

Authorization scopes

Requires the following OAuth scope:

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

rpc DeleteProperty(DeletePropertyRequest) returns (Property)

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, or is not a GA4 Property.

Authorization scopes

Requires the following OAuth scope:

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

rpc DeleteSKAdNetworkConversionValueSchema(DeleteSKAdNetworkConversionValueSchemaRequest) returns (Empty)

Deletes target SKAdNetworkConversionValueSchema.

Authorization scopes

Requires the following OAuth scope:

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

rpc DeleteSubpropertyEventFilter(DeleteSubpropertyEventFilterRequest) returns (Empty)

Deletes a subproperty event filter.

Authorization scopes

Requires the following OAuth scope:

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

rpc FetchAutomatedGa4ConfigurationOptOut(FetchAutomatedGa4ConfigurationOptOutRequest) returns (FetchAutomatedGa4ConfigurationOptOutResponse)

Fetches the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc FetchConnectedGa4Property(FetchConnectedGa4PropertyRequest) returns (FetchConnectedGa4PropertyResponse)

Given a specified UA property, looks up the GA4 property connected to it. Note: this cannot be used with GA4 properties.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc GetAccessBinding(GetAccessBindingRequest) returns (AccessBinding)

Gets information about an access binding.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.manage.users.readonly
  • https://www.googleapis.com/auth/analytics.manage.users
GetAccount

rpc GetAccount(GetAccountRequest) returns (Account)

Lookup for a single Account.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc GetAttributionSettings(GetAttributionSettingsRequest) returns (AttributionSettings)

Lookup for a AttributionSettings singleton.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc GetAudience(GetAudienceRequest) returns (Audience)

Lookup for a single Audience. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc GetCalculatedMetric(GetCalculatedMetricRequest) returns (CalculatedMetric)

Lookup for a single CalculatedMetric.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc GetChannelGroup(GetChannelGroupRequest) returns (ChannelGroup)

Lookup for a single ChannelGroup.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc GetConversionEvent(GetConversionEventRequest) returns (ConversionEvent)

Retrieve a single conversion event.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc GetCustomDimension(GetCustomDimensionRequest) returns (CustomDimension)

Lookup for a single CustomDimension.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc GetCustomMetric(GetCustomMetricRequest) returns (CustomMetric)

Lookup for a single CustomMetric.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc GetDataRedactionSettings(GetDataRedactionSettingsRequest) returns (DataRedactionSettings)

Lookup for a single DataRedactionSettings.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc GetDataRetentionSettings(GetDataRetentionSettingsRequest) returns (DataRetentionSettings)

Returns the singleton data retention settings for this property.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc GetDataSharingSettings(GetDataSharingSettingsRequest) returns (DataSharingSettings)

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

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc GetDataStream(GetDataStreamRequest) returns (DataStream)

Lookup for a single DataStream.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc GetDisplayVideo360AdvertiserLinkProposal(GetDisplayVideo360AdvertiserLinkProposalRequest) returns (DisplayVideo360AdvertiserLinkProposal)

Lookup for a single DisplayVideo360AdvertiserLinkProposal.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc GetEnhancedMeasurementSettings(GetEnhancedMeasurementSettingsRequest) returns (EnhancedMeasurementSettings)

Returns the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc GetEventCreateRule(GetEventCreateRuleRequest) returns (EventCreateRule)

Lookup for a single EventCreateRule.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc GetExpandedDataSet(GetExpandedDataSetRequest) returns (ExpandedDataSet)

Lookup for a single ExpandedDataSet.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc GetGlobalSiteTag(GetGlobalSiteTagRequest) returns (GlobalSiteTag)

Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc GetGoogleSignalsSettings(GetGoogleSignalsSettingsRequest) returns (GoogleSignalsSettings)

Lookup for Google Signals settings for a property.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc GetKeyEvent(GetKeyEventRequest) returns (KeyEvent)

Retrieve a single Key Event.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc GetMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret)

Lookup for a single "GA4" MeasurementProtocolSecret.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc GetProperty(GetPropertyRequest) returns (Property)

Lookup for a single "GA4" Property.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc GetSKAdNetworkConversionValueSchema(GetSKAdNetworkConversionValueSchemaRequest) returns (SKAdNetworkConversionValueSchema)

Looks up a single SKAdNetworkConversionValueSchema.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc GetSubpropertyEventFilter(GetSubpropertyEventFilterRequest) returns (SubpropertyEventFilter)

Lookup for a single subproperty Event Filter.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc ListAccessBindings(ListAccessBindingsRequest) returns (ListAccessBindingsResponse)

Lists all access bindings on an account or property.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.manage.users.readonly
  • https://www.googleapis.com/auth/analytics.manage.users
ListAccountSummaries

rpc ListAccountSummaries(ListAccountSummariesRequest) returns (ListAccountSummariesResponse)

Returns summaries of all accounts accessible by the caller.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc ListAccounts(ListAccountsRequest) returns (ListAccountsResponse)

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.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc ListAudiences(ListAudiencesRequest) returns (ListAudiencesResponse)

Lists Audiences on a property. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc ListCalculatedMetrics(ListCalculatedMetricsRequest) returns (ListCalculatedMetricsResponse)

Lists CalculatedMetrics on a property.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc ListChannelGroups(ListChannelGroupsRequest) returns (ListChannelGroupsResponse)

Lists ChannelGroups on a property.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc ListConnectedSiteTags(ListConnectedSiteTagsRequest) returns (ListConnectedSiteTagsResponse)

Lists the connected site tags for a Universal Analytics property. A maximum of 20 connected site tags will be returned. Note: this has no effect on GA4 property.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc ListConversionEvents(ListConversionEventsRequest) returns (ListConversionEventsResponse)

Returns a list of conversion events in the specified parent property.

Returns an empty list if no conversion events are found.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc ListCustomDimensions(ListCustomDimensionsRequest) returns (ListCustomDimensionsResponse)

Lists CustomDimensions on a property.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc ListCustomMetrics(ListCustomMetricsRequest) returns (ListCustomMetricsResponse)

Lists CustomMetrics on a property.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc ListDataStreams(ListDataStreamsRequest) returns (ListDataStreamsResponse)

Lists DataStreams on a property.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc ListDisplayVideo360AdvertiserLinkProposals(ListDisplayVideo360AdvertiserLinkProposalsRequest) returns (ListDisplayVideo360AdvertiserLinkProposalsResponse)

Lists DisplayVideo360AdvertiserLinkProposals on a property.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc ListEventCreateRules(ListEventCreateRulesRequest) returns (ListEventCreateRulesResponse)

Lists EventCreateRules on a web data stream.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc ListExpandedDataSets(ListExpandedDataSetsRequest) returns (ListExpandedDataSetsResponse)

Lists ExpandedDataSets on a property.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc ListKeyEvents(ListKeyEventsRequest) returns (ListKeyEventsResponse)

Returns a list of Key Events in the specified parent property. Returns an empty list if no Key Events are found.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc ListMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest) returns (ListMeasurementProtocolSecretsResponse)

Returns child MeasurementProtocolSecrets under the specified parent Property.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc ListProperties(ListPropertiesRequest) returns (ListPropertiesResponse)

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.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc ListSKAdNetworkConversionValueSchemas(ListSKAdNetworkConversionValueSchemasRequest) returns (ListSKAdNetworkConversionValueSchemasResponse)

Lists SKAdNetworkConversionValueSchema on a stream. Properties can have at most one SKAdNetworkConversionValueSchema.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc ListSubpropertyEventFilters(ListSubpropertyEventFiltersRequest) returns (ListSubpropertyEventFiltersResponse)

List all subproperty Event Filters on a property.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc ProvisionAccountTicket(ProvisionAccountTicketRequest) returns (ProvisionAccountTicketResponse)

Requests a ticket for creating an account.

Authorization scopes

Requires the following OAuth scope:

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

rpc RunAccessReport(RunAccessReportRequest) returns (RunAccessReportResponse)

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 GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see searchChangeHistoryEvents.

Authorization scopes

Requires one of the following OAuth scopes:

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

rpc SearchChangeHistoryEvents(SearchChangeHistoryEventsRequest) returns (SearchChangeHistoryEventsResponse)

Searches through all changes to an account or its children given the specified set of filters.

Authorization scopes

Requires the following OAuth scope:

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

rpc SetAutomatedGa4ConfigurationOptOut(SetAutomatedGa4ConfigurationOptOutRequest) returns (SetAutomatedGa4ConfigurationOptOutResponse)

Sets the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.

Authorization scopes

Requires the following OAuth scope:

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

rpc UpdateAccessBinding(UpdateAccessBindingRequest) returns (AccessBinding)

Updates an access binding on an account or property.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.manage.users
UpdateAccount

rpc UpdateAccount(UpdateAccountRequest) returns (Account)

Updates an account.

Authorization scopes

Requires the following OAuth scope:

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

rpc UpdateAttributionSettings(UpdateAttributionSettingsRequest) returns (AttributionSettings)

Updates attribution settings on a property.

Authorization scopes

Requires the following OAuth scope:

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

rpc UpdateAudience(UpdateAudienceRequest) returns (Audience)

Updates an Audience on a property.

Authorization scopes

Requires the following OAuth scope:

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

rpc UpdateCalculatedMetric(UpdateCalculatedMetricRequest) returns (CalculatedMetric)

Updates a CalculatedMetric on a property.

Authorization scopes

Requires the following OAuth scope:

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

rpc UpdateChannelGroup(UpdateChannelGroupRequest) returns (ChannelGroup)

Updates a ChannelGroup.

Authorization scopes

Requires the following OAuth scope:

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

rpc UpdateConversionEvent(UpdateConversionEventRequest) returns (ConversionEvent)

Updates a conversion event with the specified attributes.

Authorization scopes

Requires the following OAuth scope:

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

rpc UpdateCustomDimension(UpdateCustomDimensionRequest) returns (CustomDimension)

Updates a CustomDimension on a property.

Authorization scopes

Requires the following OAuth scope:

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

rpc UpdateCustomMetric(UpdateCustomMetricRequest) returns (CustomMetric)

Updates a CustomMetric on a property.

Authorization scopes

Requires the following OAuth scope:

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

rpc UpdateDataRedactionSettings(UpdateDataRedactionSettingsRequest) returns (DataRedactionSettings)

Updates a DataRedactionSettings on a property.

Authorization scopes

Requires the following OAuth scope:

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

rpc UpdateDataRetentionSettings(UpdateDataRetentionSettingsRequest) returns (DataRetentionSettings)

Updates the singleton data retention settings for this property.

Authorization scopes

Requires the following OAuth scope:

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

rpc UpdateDataStream(UpdateDataStreamRequest) returns (DataStream)

Updates a DataStream on a property.

Authorization scopes

Requires the following OAuth scope:

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

rpc UpdateEnhancedMeasurementSettings(UpdateEnhancedMeasurementSettingsRequest) returns (EnhancedMeasurementSettings)

Updates the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect.

Authorization scopes

Requires the following OAuth scope:

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

rpc UpdateEventCreateRule(UpdateEventCreateRuleRequest) returns (EventCreateRule)

Updates an EventCreateRule.

Authorization scopes

Requires the following OAuth scope:

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

rpc UpdateExpandedDataSet(UpdateExpandedDataSetRequest) returns (ExpandedDataSet)

Updates a ExpandedDataSet on a property.

Authorization scopes

Requires the following OAuth scope:

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

rpc UpdateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest) returns (GoogleSignalsSettings)

Updates Google Signals settings for a property.

Authorization scopes

Requires the following OAuth scope:

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

rpc UpdateKeyEvent(UpdateKeyEventRequest) returns (KeyEvent)

Updates a Key Event.

Authorization scopes

Requires the following OAuth scope:

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

rpc UpdateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret)

Updates a measurement protocol secret.

Authorization scopes

Requires the following OAuth scope:

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

rpc UpdateProperty(UpdatePropertyRequest) returns (Property)

Updates a property.

Authorization scopes

Requires the following OAuth scope:

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

rpc UpdateSKAdNetworkConversionValueSchema(UpdateSKAdNetworkConversionValueSchemaRequest) returns (SKAdNetworkConversionValueSchema)

Updates a SKAdNetworkConversionValueSchema.

Authorization scopes

Requires the following OAuth scope:

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

rpc UpdateSubpropertyEventFilter(UpdateSubpropertyEventFilterRequest) returns (SubpropertyEventFilter)

Updates a subproperty Event Filter.

Authorization scopes

Requires the following OAuth scope:

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

AccessBetweenFilter

To express that the result needs to be between two numbers (inclusive).

Fields
from_value

NumericValue

Begins with this number.

to_value

NumericValue

Ends with this number.

AccessBinding

A binding of a user to a set of roles.

Fields
name

string

Output only. Resource name of this binding.

Format: accounts/{account}/accessBindings/{access_binding} or properties/{property}/accessBindings/{access_binding}

Example: "accounts/100/accessBindings/200"

roles[]

string

A list of roles for to grant to the parent resource.

Valid values: predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-data

For users, if an empty list of roles is set, this AccessBinding will be deleted.

Union field access_target. The target for which to set roles for. access_target can be only one of the following:
user

string

If set, the email address of the user to set roles for. Format: "someuser@gmail.com"

AccessDateRange

A contiguous range of days: startDate, startDate + 1, ..., endDate.

Fields
start_date

string

The inclusive start date for the query in the format YYYY-MM-DD. Cannot be after endDate. The format NdaysAgo, yesterday, or today is also accepted, and in that case, the date is inferred based on the current time in the request's time zone.

end_date

string

The inclusive end date for the query in the format YYYY-MM-DD. Cannot be before startDate. The format NdaysAgo, yesterday, or today is also accepted, and in that case, the date is inferred based on the current time in the request's time zone.

AccessDimension

Dimensions are attributes of your data. For example, the dimension userEmail indicates the email of the user that accessed reporting data. Dimension values in report responses are strings.

Fields
dimension_name

string

The API name of the dimension. See Data Access Schema for the list of dimensions supported in this API.

Dimensions are referenced by name in dimensionFilter and orderBys.

AccessDimensionHeader

Describes a dimension column in the report. Dimensions requested in a report produce column entries within rows and DimensionHeaders. However, dimensions used exclusively within filters or expressions do not produce columns in a report; correspondingly, those dimensions do not produce headers.

Fields
dimension_name

string

The dimension's name; for example 'userEmail'.

AccessDimensionValue

The value of a dimension.

Fields
value

string

The dimension value. For example, this value may be 'France' for the 'country' dimension.

AccessFilter

An expression to filter dimension or metric values.

Fields
field_name

string

The dimension name or metric name.

Union field one_filter. Specify one type of filter for Filter. one_filter can be only one of the following:
string_filter

AccessStringFilter

Strings related filter.

in_list_filter

AccessInListFilter

A filter for in list values.

numeric_filter

AccessNumericFilter

A filter for numeric or date values.

between_filter

AccessBetweenFilter

A filter for two values.

AccessFilterExpression

Expresses dimension or metric filters. The fields in the same expression need to be either all dimensions or all metrics.

Fields
Union field one_expression. Specify one type of filter expression for FilterExpression. one_expression can be only one of the following:
and_group

AccessFilterExpressionList

Each of the FilterExpressions in the and_group has an AND relationship.

or_group

AccessFilterExpressionList

Each of the FilterExpressions in the or_group has an OR relationship.

not_expression

AccessFilterExpression

The FilterExpression is NOT of not_expression.

access_filter

AccessFilter

A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions or all metrics.

AccessFilterExpressionList

A list of filter expressions.

Fields
expressions[]

AccessFilterExpression

A list of filter expressions.

AccessInListFilter

The result needs to be in a list of string values.

Fields
values[]

string

The list of string values. Must be non-empty.

case_sensitive

bool

If true, the string value is case sensitive.

AccessMetric

The quantitative measurements of a report. For example, the metric accessCount is the total number of data access records.

Fields
metric_name

string

The API name of the metric. See Data Access Schema for the list of metrics supported in this API.

Metrics are referenced by name in metricFilter & orderBys.

AccessMetricHeader

Describes a metric column in the report. Visible metrics requested in a report produce column entries within rows and MetricHeaders. However, metrics used exclusively within filters or expressions do not produce columns in a report; correspondingly, those metrics do not produce headers.

Fields
metric_name

string

The metric's name; for example 'accessCount'.

AccessMetricValue

The value of a metric.

Fields
value

string

The measurement value. For example, this value may be '13'.

AccessNumericFilter

Filters for numeric or date values.

Fields
operation

Operation

The operation type for this filter.

value

NumericValue

A numeric value or a date value.

Operation

The operation applied to a numeric filter.

Enums
OPERATION_UNSPECIFIED Unspecified.
EQUAL Equal
LESS_THAN Less than
LESS_THAN_OR_EQUAL Less than or equal
GREATER_THAN Greater than
GREATER_THAN_OR_EQUAL Greater than or equal

AccessOrderBy

Order bys define how rows will be sorted in the response. For example, ordering rows by descending access count is one ordering, and ordering rows by the country string is a different ordering.

Fields
desc

bool

If true, sorts by descending order. If false or unspecified, sorts in ascending order.

Union field one_order_by. Specify one type of order by for OrderBy. one_order_by can be only one of the following:
metric

MetricOrderBy

Sorts results by a metric's values.

dimension

DimensionOrderBy

Sorts results by a dimension's values.

DimensionOrderBy

Sorts by dimension values.

Fields
dimension_name

string

A dimension name in the request to order by.

order_type

OrderType

Controls the rule for dimension value ordering.

OrderType

Rule to order the string dimension values by.

Enums
ORDER_TYPE_UNSPECIFIED Unspecified.
ALPHANUMERIC Alphanumeric sort by Unicode code point. For example, "2" < "A" < "X" < "b" < "z".
CASE_INSENSITIVE_ALPHANUMERIC Case insensitive alphanumeric sort by lower case Unicode code point. For example, "2" < "A" < "b" < "X" < "z".
NUMERIC Dimension values are converted to numbers before sorting. For example in NUMERIC sort, "25" < "100", and in ALPHANUMERIC sort, "100" < "25". Non-numeric dimension values all have equal ordering value below all numeric values.

MetricOrderBy

Sorts by metric values.

Fields
metric_name

string

A metric name in the request to order by.

AccessQuota

Current state of all quotas for this Analytics property. If any quota for a property is exhausted, all requests to that property will return Resource Exhausted errors.

Fields
tokens_per_day

AccessQuotaStatus

Properties can use 250,000 tokens per day. Most requests consume fewer than 10 tokens.

tokens_per_hour

AccessQuotaStatus

Properties can use 50,000 tokens per hour. An API request consumes a single number of tokens, and that number is deducted from all of the hourly, daily, and per project hourly quotas.

concurrent_requests

AccessQuotaStatus

Properties can use up to 50 concurrent requests.

server_errors_per_project_per_hour

AccessQuotaStatus

Properties and cloud project pairs can have up to 50 server errors per hour.

tokens_per_project_per_hour

AccessQuotaStatus

Properties can use up to 25% of their tokens per project per hour. This amounts to Analytics 360 Properties can use 12,500 tokens per project per hour. An API request consumes a single number of tokens, and that number is deducted from all of the hourly, daily, and per project hourly quotas.

AccessQuotaStatus

Current state for a particular quota group.

Fields
consumed

int32

Quota consumed by this request.

remaining

int32

Quota remaining after this request.

AccessRow

Access report data for each row.

Fields
dimension_values[]

AccessDimensionValue

List of dimension values. These values are in the same order as specified in the request.

metric_values[]

AccessMetricValue

List of metric values. These values are in the same order as specified in the request.

AccessStringFilter

The filter for strings.

Fields
match_type

MatchType

The match type for this filter.

value

string

The string value used for the matching.

case_sensitive

bool

If true, the string value is case sensitive.

MatchType

The match type of a string filter.

Enums
MATCH_TYPE_UNSPECIFIED Unspecified
EXACT Exact match of the string value.
BEGINS_WITH Begins with the string value.
ENDS_WITH Ends with the string value.
CONTAINS Contains the string value.
FULL_REGEXP Full match for the regular expression with the string value.
PARTIAL_REGEXP Partial match for the regular expression with the string value.

Account

A resource message representing a Google Analytics account.

Fields
name

string

Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"

create_time

Timestamp

Output only. Time when this account was originally created.

update_time

Timestamp

Output only. Time when account payload fields were last updated.

display_name

string

Required. Human-readable display name for this account.

region_code

string

Country of business. Must be a Unicode CLDR region code.

deleted

bool

Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.

gmp_organization

string

Output only. The URI for a Google Marketing Platform organization resource. Only set when this account is connected to a GMP organization. Format: marketingplatformadmin.googleapis.com/organizations/{org_id}

AccountSummary

A virtual resource representing an overview of an account and all its child GA4 properties.

Fields
name

string

Resource name for this account summary. Format: accountSummaries/{account_id} Example: "accountSummaries/1000"

account

string

Resource name of account referred to by this account summary Format: accounts/{account_id} Example: "accounts/1000"

display_name

string

Display name for the account referred to in this account summary.

property_summaries[]

PropertySummary

List of summaries for child accounts of this account.

AcknowledgeUserDataCollectionRequest

Request message for AcknowledgeUserDataCollection RPC.

Fields
property

string

Required. The property for which to acknowledge user data collection.

acknowledgement

string

Required. An acknowledgement that the caller of this method understands the terms of user data collection.

This field must contain the exact value: "I acknowledge that I have the necessary privacy disclosures and rights from my end users for the collection and processing of their data, including the association of such data with the visitation information Google Analytics collects from my site and/or app property."

AcknowledgeUserDataCollectionResponse

This type has no fields.

Response message for AcknowledgeUserDataCollection RPC.

ActionType

Types of actions that may change a resource.

Enums
ACTION_TYPE_UNSPECIFIED Action type unknown or not specified.
CREATED Resource was created in this change.
UPDATED Resource was updated in this change.
DELETED Resource was deleted in this change.

ActorType

Different kinds of actors that can make changes to Google Analytics resources.

Enums
ACTOR_TYPE_UNSPECIFIED Unknown or unspecified actor type.
USER Changes made by the user specified in actor_email.
SYSTEM Changes made by the Google Analytics system.
SUPPORT Changes made by Google Analytics support team staff.

ApproveDisplayVideo360AdvertiserLinkProposalRequest

Request message for ApproveDisplayVideo360AdvertiserLinkProposal RPC.

Fields
name

string

Required. The name of the DisplayVideo360AdvertiserLinkProposal to approve. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678

ApproveDisplayVideo360AdvertiserLinkProposalResponse

Response message for ApproveDisplayVideo360AdvertiserLinkProposal RPC.

Fields

ArchiveAudienceRequest

Request message for ArchiveAudience RPC.

Fields
name

string

Required. Example format: properties/1234/audiences/5678

ArchiveCustomDimensionRequest

Request message for ArchiveCustomDimension RPC.

Fields
name

string

Required. The name of the CustomDimension to archive. Example format: properties/1234/customDimensions/5678

ArchiveCustomMetricRequest

Request message for ArchiveCustomMetric RPC.

Fields
name

string

Required. The name of the CustomMetric to archive. Example format: properties/1234/customMetrics/5678

AttributionSettings

The attribution settings used for a given property. This is a singleton resource.

Fields
name

string

Output only. Resource name of this attribution settings resource. Format: properties/{property_id}/attributionSettings Example: "properties/1000/attributionSettings"

acquisition_conversion_event_lookback_window

AcquisitionConversionEventLookbackWindow

Required. The lookback window configuration for acquisition conversion events. The default window size is 30 days.

other_conversion_event_lookback_window

OtherConversionEventLookbackWindow

Required. The lookback window for all other, non-acquisition conversion events. The default window size is 90 days.

reporting_attribution_model

ReportingAttributionModel

Required. The reporting attribution model used to calculate conversion credit in this property's reports.

Changing the attribution model will apply to both historical and future data. These changes will be reflected in reports with conversion and revenue data. User and session data will be unaffected.

ads_web_conversion_data_export_scope

AdsWebConversionDataExportScope

Required. The Conversion Export Scope for data exported to linked Ads Accounts.

AcquisitionConversionEventLookbackWindow

How far back in time events should be considered for inclusion in a converting path which leads to the first install of an app or the first visit to a site.

Enums
ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_UNSPECIFIED Lookback window size unspecified.
ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_7_DAYS 7-day lookback window.
ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_30_DAYS 30-day lookback window.

AdsWebConversionDataExportScope

The Conversion Export Scope for data exported to linked Ads Accounts.

Enums
ADS_WEB_CONVERSION_DATA_EXPORT_SCOPE_UNSPECIFIED Default value. This value is unused.
NOT_SELECTED_YET No data export scope selected yet. Export scope can never be changed back to this value.
PAID_AND_ORGANIC_CHANNELS Paid and organic channels are eligible to receive conversion credit, but only credit assigned to Google Ads channels will appear in your Ads accounts. To learn more, see Paid and Organic channels.
GOOGLE_PAID_CHANNELS Only Google Ads paid channels are eligible to receive conversion credit. To learn more, see Google Paid channels.

OtherConversionEventLookbackWindow

How far back in time events should be considered for inclusion in a converting path for all conversions other than first app install/first site visit.

Enums
OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_UNSPECIFIED Lookback window size unspecified.
OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_30_DAYS 30-day lookback window.
OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_60_DAYS 60-day lookback window.
OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_90_DAYS 90-day lookback window.

ReportingAttributionModel

The reporting attribution model used to calculate conversion credit in this property's reports.

Enums
REPORTING_ATTRIBUTION_MODEL_UNSPECIFIED Reporting attribution model unspecified.
PAID_AND_ORGANIC_CHANNELS_DATA_DRIVEN Data-driven attribution distributes credit for the conversion based on data for each conversion event. Each Data-driven model is specific to each advertiser and each conversion event. Previously CROSS_CHANNEL_DATA_DRIVEN
PAID_AND_ORGANIC_CHANNELS_LAST_CLICK Ignores direct traffic and attributes 100% of the conversion value to the last channel that the customer clicked through (or engaged view through for YouTube) before converting. Previously CROSS_CHANNEL_LAST_CLICK
GOOGLE_PAID_CHANNELS_LAST_CLICK Attributes 100% of the conversion value to the last Google Paid channel that the customer clicked through before converting. Previously ADS_PREFERRED_LAST_CLICK

Audience

A resource message representing a GA4 Audience.

Fields
name

string

Output only. The resource name for this Audience resource. Format: properties/{propertyId}/audiences/{audienceId}

display_name

string

Required. The display name of the Audience.

description

string

Required. The description of the Audience.

membership_duration_days

int32

Required. Immutable. The duration a user should stay in an Audience. It cannot be set to more than 540 days.

ads_personalization_enabled

bool

Output only. It is automatically set by GA to false if this is an NPA Audience and is excluded from ads personalization.

event_trigger

AudienceEventTrigger

Optional. Specifies an event to log when a user joins the Audience. If not set, no event is logged when a user joins the Audience.

exclusion_duration_mode

AudienceExclusionDurationMode

Immutable. Specifies how long an exclusion lasts for users that meet the exclusion filter. It is applied to all EXCLUDE filter clauses and is ignored when there is no EXCLUDE filter clause in the Audience.

filter_clauses[]

AudienceFilterClause

Required. Immutable. Unordered list. Filter clauses that define the Audience. All clauses will be AND’ed together.

AudienceExclusionDurationMode

Specifies how long an exclusion lasts for users that meet the exclusion filter.

Enums
AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED Not specified.
EXCLUDE_TEMPORARILY Exclude users from the Audience during periods when they meet the filter clause.
EXCLUDE_PERMANENTLY Exclude users from the Audience if they've ever met the filter clause.

AudienceDimensionOrMetricFilter

A specific filter for a single dimension or metric.

Fields
field_name

string

Required. Immutable. The dimension name or metric name to filter. If the field name refers to a custom dimension or metric, a scope prefix will be added to the front of the custom dimensions or metric name. For more on scope prefixes or custom dimensions/metrics, reference the Google Analytics Data API documentation.

at_any_point_in_time

bool

Optional. Indicates whether this filter needs dynamic evaluation or not. If set to true, users join the Audience if they ever met the condition (static evaluation). If unset or set to false, user evaluation for an Audience is dynamic; users are added to an Audience when they meet the conditions and then removed when they no longer meet them.

This can only be set when Audience scope is ACROSS_ALL_SESSIONS.

in_any_n_day_period

int32

Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (For example, infinite time window).

For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false.

It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days.

Union field one_filter. One of the above filters. one_filter can be only one of the following:
string_filter

StringFilter

A filter for a string-type dimension that matches a particular pattern.

in_list_filter

InListFilter

A filter for a string dimension that matches a particular list of options.

numeric_filter

NumericFilter

A filter for numeric or date values on a dimension or metric.

between_filter

BetweenFilter

A filter for numeric or date values between certain values on a dimension or metric.

BetweenFilter

A filter for numeric or date values between certain values on a dimension or metric.

Fields
from_value

NumericValue

Required. Begins with this number, inclusive.

to_value

NumericValue

Required. Ends with this number, inclusive.

InListFilter

A filter for a string dimension that matches a particular list of options.

Fields
values[]

string

Required. The list of possible string values to match against. Must be non-empty.

case_sensitive

bool

Optional. If true, the match is case-sensitive. If false, the match is case-insensitive.

NumericFilter

A filter for numeric or date values on a dimension or metric.

Fields
operation

Operation

Required. The operation applied to a numeric filter.

value

NumericValue

Required. The numeric or date value to match against.

Operation

The operation applied to a numeric filter.

Enums
OPERATION_UNSPECIFIED Unspecified.
EQUAL Equal.
LESS_THAN Less than.
GREATER_THAN Greater than.

NumericValue

To represent a number.

Fields
Union field one_value. One of a numeric value. one_value can be only one of the following:
int64_value

int64

Integer value.

double_value

double

Double value.

StringFilter

A filter for a string-type dimension that matches a particular pattern.

Fields
match_type

MatchType

Required. The match type for the string filter.

value

string

Required. The string value to be matched against.

case_sensitive

bool

Optional. If true, the match is case-sensitive. If false, the match is case-insensitive.

MatchType

The match type for the string filter.

Enums
MATCH_TYPE_UNSPECIFIED Unspecified
EXACT Exact match of the string value.
BEGINS_WITH Begins with the string value.
ENDS_WITH Ends with the string value.
CONTAINS Contains the string value.
FULL_REGEXP Full regular expression matches with the string value.

AudienceEventFilter

A filter that matches events of a single event name. If an event parameter is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter.

Fields
event_name

string

Required. Immutable. The name of the event to match against.

event_parameter_filter_expression

AudienceFilterExpression

Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (For example, nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored.

AudienceEventTrigger

Specifies an event to log when a user joins the Audience.

Fields
event_name

string

Required. The event name that will be logged.

log_condition

LogCondition

Required. When to log the event.

LogCondition

Determines when to log the event.

Enums
LOG_CONDITION_UNSPECIFIED Log condition is not specified.
AUDIENCE_JOINED The event should be logged only when a user is joined.
AUDIENCE_MEMBERSHIP_RENEWED The event should be logged whenever the Audience condition is met, even if the user is already a member of the Audience.

AudienceFilterClause

A clause for defining either a simple or sequence filter. A filter can be inclusive (For example, users satisfying the filter clause are included in the Audience) or exclusive (For example, users satisfying the filter clause are excluded from the Audience).

Fields
clause_type

AudienceClauseType

Required. Specifies whether this is an include or exclude filter clause.

Union field filter.

filter can be only one of the following:

simple_filter

AudienceSimpleFilter

A simple filter that a user must satisfy to be a member of the Audience.

sequence_filter

AudienceSequenceFilter

Filters that must occur in a specific order for the user to be a member of the Audience.

AudienceClauseType

Specifies whether this is an include or exclude filter clause.

Enums
AUDIENCE_CLAUSE_TYPE_UNSPECIFIED Unspecified clause type.
INCLUDE Users will be included in the Audience if the filter clause is met.
EXCLUDE Users will be excluded from the Audience if the filter clause is met.

AudienceFilterExpression

A logical expression of Audience dimension, metric, or event filters.

Fields
Union field expr. The expression applied to a filter. expr can be only one of the following:
and_group

AudienceFilterExpressionList

A list of expressions to be AND’ed together. It can only contain AudienceFilterExpressions with or_group. This must be set for the top level AudienceFilterExpression.

or_group

AudienceFilterExpressionList

A list of expressions to OR’ed together. It cannot contain AudienceFilterExpressions with and_group or or_group.

not_expression

AudienceFilterExpression

A filter expression to be NOT'ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression.

dimension_or_metric_filter

AudienceDimensionOrMetricFilter

A filter on a single dimension or metric. This cannot be set on the top level AudienceFilterExpression.

event_filter

AudienceEventFilter

Creates a filter that matches a specific event. This cannot be set on the top level AudienceFilterExpression.

AudienceFilterExpressionList

A list of Audience filter expressions.

Fields
filter_expressions[]

AudienceFilterExpression

A list of Audience filter expressions.

AudienceFilterScope

Specifies how to evaluate users for joining an Audience.

Enums
AUDIENCE_FILTER_SCOPE_UNSPECIFIED Scope is not specified.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT User joins the Audience if the filter condition is met within one event.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION User joins the Audience if the filter condition is met within one session.
AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS User joins the Audience if the filter condition is met by any event across any session.

AudienceSequenceFilter

Defines filters that must occur in a specific order for the user to be a member of the Audience.

Fields
scope

AudienceFilterScope

Required. Immutable. Specifies the scope for this filter.

sequence_maximum_duration

Duration

Optional. Defines the time period in which the whole sequence must occur.

sequence_steps[]

AudienceSequenceStep

Required. An ordered sequence of steps. A user must complete each step in order to join the sequence filter.

AudienceSequenceStep

A condition that must occur in the specified step order for this user to match the sequence.

Fields
scope

AudienceFilterScope

Required. Immutable. Specifies the scope for this step.

immediately_follows

bool

Optional. If true, the event satisfying this step must be the very next event after the event satisfying the last step. If unset or false, this step indirectly follows the prior step; for example, there may be events between the prior step and this step. It is ignored for the first step.

constraint_duration

Duration

Optional. When set, this step must be satisfied within the constraint_duration of the previous step (For example, t[i] - t[i-1] <= constraint_duration). If not set, there is no duration requirement (the duration is effectively unlimited). It is ignored for the first step.

filter_expression

AudienceFilterExpression

Required. Immutable. A logical expression of Audience dimension, metric, or event filters in each step.

AudienceSimpleFilter

Defines a simple filter that a user must satisfy to be a member of the Audience.

Fields
scope

AudienceFilterScope

Required. Immutable. Specifies the scope for this filter.

filter_expression

AudienceFilterExpression

Required. Immutable. A logical expression of Audience dimension, metric, or event filters.

BatchCreateAccessBindingsRequest

Request message for BatchCreateAccessBindings RPC.

Fields
parent

string

Required. The account or property that owns the access bindings. The parent field in the CreateAccessBindingRequest messages must either be empty or match this field. Formats: - accounts/{account} - properties/{property}

requests[]

CreateAccessBindingRequest

Required. The requests specifying the access bindings to create. A maximum of 1000 access bindings can be created in a batch.

BatchCreateAccessBindingsResponse

Response message for BatchCreateAccessBindings RPC.

Fields
access_bindings[]

AccessBinding

The access bindings created.

BatchDeleteAccessBindingsRequest

Request message for BatchDeleteAccessBindings RPC.

Fields
parent

string

Required. The account or property that owns the access bindings. The parent of all provided values for the 'names' field in DeleteAccessBindingRequest messages must match this field. Formats: - accounts/{account} - properties/{property}

requests[]

DeleteAccessBindingRequest

Required. The requests specifying the access bindings to delete. A maximum of 1000 access bindings can be deleted in a batch.

BatchGetAccessBindingsRequest

Request message for BatchGetAccessBindings RPC.

Fields
parent

string

Required. The account or property that owns the access bindings. The parent of all provided values for the 'names' field must match this field. Formats: - accounts/{account} - properties/{property}

names[]

string

Required. The names of the access bindings to retrieve. A maximum of 1000 access bindings can be retrieved in a batch. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}

BatchGetAccessBindingsResponse

Response message for BatchGetAccessBindings RPC.

Fields
access_bindings[]

AccessBinding

The requested access bindings.

BatchUpdateAccessBindingsRequest

Request message for BatchUpdateAccessBindings RPC.

Fields
parent

string

Required. The account or property that owns the access bindings. The parent of all provided AccessBinding in UpdateAccessBindingRequest messages must match this field. Formats: - accounts/{account} - properties/{property}

requests[]

UpdateAccessBindingRequest

Required. The requests specifying the access bindings to update. A maximum of 1000 access bindings can be updated in a batch.

BatchUpdateAccessBindingsResponse

Response message for BatchUpdateAccessBindings RPC.

Fields
access_bindings[]

AccessBinding

The access bindings updated.

CalculatedMetric

A definition for a calculated metric.

Fields
name

string

Output only. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}'

description

string

Optional. Description for this calculated metric. Max length of 4096 characters.

display_name

string

Required. Display name for this calculated metric as shown in the Google Analytics UI. Max length 82 characters.

calculated_metric_id

string

Output only. The ID to use for the calculated metric. In the UI, this is referred to as the "API name."

The calculated_metric_id is used when referencing this calculated metric from external APIs. For example, "calcMetric:{calculated_metric_id}".

metric_unit

MetricUnit

Required. The type for the calculated metric's value.

restricted_metric_type[]

RestrictedMetricType

Output only. Types of restricted data that this metric contains.

formula

string

Required. The calculated metric's definition. Maximum number of unique referenced custom metrics is 5. Formulas supports the following operations: + (addition), - (subtraction), - (negative), * (multiplication), / (division), () (parenthesis). Any valid real numbers are acceptable that fit in a Long (64bit integer) or a Double (64 bit floating point number). Example formula: "( customEvent:parameter_name + cartPurchaseQuantity ) / 2.0"

invalid_metric_reference

bool

Output only. If true, this calculated metric has a invalid metric reference. Anything using a calculated metric with invalid_metric_reference set to true may fail, produce warnings, or produce unexpected results.

MetricUnit

Possible types of representing the calculated metric's value.

Enums
METRIC_UNIT_UNSPECIFIED MetricUnit unspecified or missing.
STANDARD This metric uses default units.
CURRENCY This metric measures a currency.
FEET This metric measures feet.
MILES This metric measures miles.
METERS This metric measures meters.
KILOMETERS This metric measures kilometers.
MILLISECONDS This metric measures milliseconds.
SECONDS This metric measures seconds.
MINUTES This metric measures minutes.
HOURS This metric measures hours.

RestrictedMetricType

Labels that mark the data in calculated metric used in conjunction with user roles that restrict access to cost and/or revenue metrics.

Enums
RESTRICTED_METRIC_TYPE_UNSPECIFIED Type unknown or unspecified.
COST_DATA Metric reports cost data.
REVENUE_DATA Metric reports revenue data.

CancelDisplayVideo360AdvertiserLinkProposalRequest

Request message for CancelDisplayVideo360AdvertiserLinkProposal RPC.

Fields
name

string

Required. The name of the DisplayVideo360AdvertiserLinkProposal to cancel. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678

ChangeHistoryChange

A description of a change to a single Google Analytics resource.

Fields
resource

string

Resource name of the resource whose changes are described by this entry.

action

ActionType

The type of action that changed this resource.

resource_before_change

ChangeHistoryResource

Resource contents from before the change was made. If this resource was created in this change, this field will be missing.

resource_after_change

ChangeHistoryResource

Resource contents from after the change was made. If this resource was deleted in this change, this field will be missing.

ChangeHistoryResource

A snapshot of a resource as before or after the result of a change in change history.

Fields

Union field resource.

resource can be only one of the following:

account

Account

A snapshot of an Account resource in change history.

property

Property

A snapshot of a Property resource in change history.

google_signals_settings

GoogleSignalsSettings

A snapshot of a GoogleSignalsSettings resource in change history.

conversion_event

ConversionEvent

A snapshot of a ConversionEvent resource in change history.

measurement_protocol_secret

MeasurementProtocolSecret

A snapshot of a MeasurementProtocolSecret resource in change history.

custom_dimension

CustomDimension

A snapshot of a CustomDimension resource in change history.

custom_metric

CustomMetric

A snapshot of a CustomMetric resource in change history.

data_retention_settings

DataRetentionSettings

A snapshot of a data retention settings resource in change history.

data_stream

DataStream

A snapshot of a DataStream resource in change history.

attribution_settings

AttributionSettings

A snapshot of AttributionSettings resource in change history.

expanded_data_set

ExpandedDataSet

A snapshot of an ExpandedDataSet resource in change history.

channel_group

ChannelGroup

A snapshot of a ChannelGroup resource in change history.

enhanced_measurement_settings

EnhancedMeasurementSettings

A snapshot of EnhancedMeasurementSettings resource in change history.

data_redaction_settings

DataRedactionSettings

A snapshot of DataRedactionSettings resource in change history.

skadnetwork_conversion_value_schema

SKAdNetworkConversionValueSchema

A snapshot of SKAdNetworkConversionValueSchema resource in change history.

audience

Audience

A snapshot of an Audience resource in change history.

event_create_rule

EventCreateRule

A snapshot of an EventCreateRule resource in change history.

calculated_metric

CalculatedMetric

A snapshot of a CalculatedMetric resource in change history.

ChangeHistoryEvent

A set of changes within a Google Analytics account or its child properties that resulted from the same cause. Common causes would be updates made in the Google Analytics UI, changes from customer support, or automatic Google Analytics system changes.

Fields
id

string

ID of this change history event. This ID is unique across Google Analytics.

change_time

Timestamp

Time when change was made.

actor_type

ActorType

The type of actor that made this change.

user_actor_email

string

Email address of the Google account that made the change. This will be a valid email address if the actor field is set to USER, and empty otherwise. Google accounts that have been deleted will cause an error.

changes_filtered

bool

If true, then the list of changes returned was filtered, and does not represent all changes that occurred in this event.

changes[]

ChangeHistoryChange

A list of changes made in this change history event that fit the filters specified in SearchChangeHistoryEventsRequest.

ChangeHistoryResourceType

Types of resources whose changes may be returned from change history.

Enums
CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED Resource type unknown or not specified.
ACCOUNT Account resource
PROPERTY Property resource
GOOGLE_SIGNALS_SETTINGS GoogleSignalsSettings resource
CONVERSION_EVENT ConversionEvent resource
MEASUREMENT_PROTOCOL_SECRET MeasurementProtocolSecret resource
CUSTOM_DIMENSION CustomDimension resource
CUSTOM_METRIC CustomMetric resource
DATA_RETENTION_SETTINGS DataRetentionSettings resource
DATA_STREAM DataStream resource
ATTRIBUTION_SETTINGS AttributionSettings resource
EXPANDED_DATA_SET ExpandedDataSet resource
CHANNEL_GROUP ChannelGroup resource
ENHANCED_MEASUREMENT_SETTINGS EnhancedMeasurementSettings resource
DATA_REDACTION_SETTINGS DataRedactionSettings resource
SKADNETWORK_CONVERSION_VALUE_SCHEMA SKAdNetworkConversionValueSchema resource
AUDIENCE Audience resource
EVENT_CREATE_RULE EventCreateRule resource
CALCULATED_METRIC CalculatedMetric resource

ChannelGroup

A resource message representing a Channel Group.

Fields
name

string

Output only. The resource name for this Channel Group resource. Format: properties/{property}/channelGroups/{channel_group}

display_name

string

Required. The display name of the Channel Group. Max length of 80 characters.

description

string

The description of the Channel Group. Max length of 256 characters.

grouping_rule[]

GroupingRule

Required. The grouping rules of channels. Maximum number of rules is 50.

system_defined

bool

Output only. If true, then this channel group is the Default Channel Group predefined by Google Analytics. Display name and grouping rules cannot be updated for this channel group.

primary

bool

Optional. If true, this channel group will be used as the default channel group for reports. Only one channel group can be set as primary at any time. If the primary field gets set on a channel group, it will get unset on the previous primary channel group.

The Google Analytics predefined channel group is the primary by default.

ChannelGroupFilter

A specific filter for a single dimension.

Fields
field_name

string

Required. Immutable. The dimension name to filter.

Union field value_filter. A StringFilter or InListFilter that defines this filters behavior. value_filter can be only one of the following:
string_filter

StringFilter

A filter for a string-type dimension that matches a particular pattern.

in_list_filter

InListFilter

A filter for a string dimension that matches a particular list of options.

InListFilter

A filter for a string dimension that matches a particular list of options. The match is case insensitive.

Fields
values[]

string

Required. The list of possible string values to match against. Must be non-empty.

StringFilter

Filter where the field value is a String. The match is case insensitive.

Fields
match_type

MatchType

Required. The match type for the string filter.

value

string

Required. The string value to be matched against.

MatchType

How the filter will be used to determine a match.

Enums
MATCH_TYPE_UNSPECIFIED Default match type.
EXACT Exact match of the string value.
BEGINS_WITH Begins with the string value.
ENDS_WITH Ends with the string value.
CONTAINS Contains the string value.
FULL_REGEXP Full regular expression match with the string value.
PARTIAL_REGEXP Partial regular expression match with the string value.

ChannelGroupFilterExpression

A logical expression of Channel Group dimension filters.

Fields
Union field expr. The expression applied to a filter. expr can be only one of the following:
and_group

ChannelGroupFilterExpressionList

A list of expressions to be AND’ed together. It can only contain ChannelGroupFilterExpressions with or_group. This must be set for the top level ChannelGroupFilterExpression.

or_group

ChannelGroupFilterExpressionList

A list of expressions to OR’ed together. It cannot contain ChannelGroupFilterExpressions with and_group or or_group.

not_expression

ChannelGroupFilterExpression

A filter expression to be NOT'ed (that is inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level ChannelGroupFilterExpression.

filter

ChannelGroupFilter

A filter on a single dimension. This cannot be set on the top level ChannelGroupFilterExpression.

ChannelGroupFilterExpressionList

A list of Channel Group filter expressions.

Fields
filter_expressions[]

ChannelGroupFilterExpression

A list of Channel Group filter expressions.

CoarseValue

The coarse conversion value set on the updatePostbackConversionValue SDK call when a ConversionValues.event_mappings conditions are satisfied. For more information, see SKAdNetwork.CoarseConversionValue.

Enums
COARSE_VALUE_UNSPECIFIED Coarse value not specified.
COARSE_VALUE_LOW Coarse value of low.
COARSE_VALUE_MEDIUM Coarse value of medium.
COARSE_VALUE_HIGH Coarse value of high.

ConnectedSiteTag

Configuration for a specific Connected Site Tag.

Fields
display_name

string

Required. User-provided display name for the connected site tag. Must be less than 256 characters.

tag_id

string

Required. "Tag ID to forward events to. Also known as the Measurement ID, or the "G-ID" (For example: G-12345).

ConversionEvent

A conversion event in a Google Analytics property.

Fields
name

string

Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}

event_name

string

Immutable. The event name for this conversion event. Examples: 'click', 'purchase'

create_time

Timestamp

Output only. Time when this conversion event was created in the property.

deletable

bool

Output only. If set, this event can currently be deleted with DeleteConversionEvent.

custom

bool

Output only. If set to true, this conversion event refers to a custom event. If set to false, this conversion event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom conversion events that may be created per property.

counting_method

ConversionCountingMethod

Optional. The method by which conversions will be counted across multiple events within a session. If this value is not provided, it will be set to ONCE_PER_EVENT.

default_conversion_value

DefaultConversionValue

Optional. Defines a default value/currency for a conversion event.

ConversionCountingMethod

The method by which conversions will be counted across multiple events within a session.

Enums
CONVERSION_COUNTING_METHOD_UNSPECIFIED Counting method not specified.
ONCE_PER_EVENT Each Event instance is considered a Conversion.
ONCE_PER_SESSION An Event instance is considered a Conversion at most once per session per user.

DefaultConversionValue

Defines a default value/currency for a conversion event. Both value and currency must be provided.

Fields
value

double

This value will be used to populate the value for all conversions of the specified event_name where the event "value" parameter is unset.

currency_code

string

When a conversion event for this event_name has no set currency, this currency will be applied as the default. Must be in ISO 4217 currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for more information.

ConversionValues

Conversion value settings for a postback window for SKAdNetwork conversion value schema.

Fields
display_name

string

Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.

coarse_value

CoarseValue

Required. A coarse grained conversion value.

This value is not guaranteed to be unique.

event_mappings[]

EventMapping

Event conditions that must be met for this Conversion Value to be achieved. The conditions in this list are ANDed together. It must have minimum of 1 entry and maximum of 3 entries, if the postback window is enabled.

lock_enabled

bool

If true, the SDK should lock to this conversion value for the current postback window.

fine_value

int32

The fine-grained conversion value. This is applicable only to the first postback window. Its valid values are [0,63], both inclusive. It must be set for postback window 1, and must not be set for postback window 2 & 3. This value is not guaranteed to be unique.

If the configuration for the first postback window is re-used for second or third postback windows this field has no effect.

CreateAccessBindingRequest

Request message for CreateAccessBinding RPC.

Fields
parent

string

Required. Formats: - accounts/{account} - properties/{property}

access_binding

AccessBinding

Required. The access binding to create.

CreateAdSenseLinkRequest

Request message to be passed to CreateAdSenseLink method.

Fields
parent

string

Required. The property for which to create an AdSense Link. Format: properties/{propertyId} Example: properties/1234

CreateAudienceRequest

Request message for CreateAudience RPC.

Fields
parent

string

Required. Example format: properties/1234

audience

Audience

Required. The audience to create.

CreateCalculatedMetricRequest

Request message for CreateCalculatedMetric RPC.

Fields
parent

string

Required. Format: properties/{property_id} Example: properties/1234

calculated_metric_id

string

Required. The ID to use for the calculated metric which will become the final component of the calculated metric's resource name.

This value should be 1-80 characters and valid characters are /[a-zA-Z0-9_]/, no spaces allowed. calculated_metric_id must be unique between all calculated metrics under a property. The calculated_metric_id is used when referencing this calculated metric from external APIs, for example, "calcMetric:{calculated_metric_id}".

calculated_metric

CalculatedMetric

Required. The CalculatedMetric to create.

CreateChannelGroupRequest

Request message for CreateChannelGroup RPC.

Fields
parent

string

Required. The property for which to create a ChannelGroup. Example format: properties/1234

channel_group

ChannelGroup

Required. The ChannelGroup to create.

CreateConnectedSiteTagRequest

Request message for CreateConnectedSiteTag RPC.

Fields
property

string

The Universal Analytics property to create connected site tags for. This API does not support GA4 properties. Format: properties/{universalAnalyticsPropertyId} Example: properties/1234

connected_site_tag

ConnectedSiteTag

Required. The tag to add to the Universal Analytics property

CreateConnectedSiteTagResponse

This type has no fields.

Response message for CreateConnectedSiteTag RPC.

CreateConversionEventRequest

Request message for CreateConversionEvent RPC

Fields
conversion_event

ConversionEvent

Required. The conversion event to create.

parent

string

Required. The resource name of the parent property where this conversion event will be created. Format: properties/123

CreateCustomDimensionRequest

Request message for CreateCustomDimension RPC.

Fields
parent

string

Required. Example format: properties/1234

custom_dimension

CustomDimension

Required. The CustomDimension to create.

CreateCustomMetricRequest

Request message for CreateCustomMetric RPC.

Fields
parent

string

Required. Example format: properties/1234

custom_metric

CustomMetric

Required. The CustomMetric to create.

CreateDataStreamRequest

Request message for CreateDataStream RPC.

Fields
parent

string

Required. Example format: properties/1234

data_stream

DataStream

Required. The DataStream to create.

CreateDisplayVideo360AdvertiserLinkProposalRequest

Request message for CreateDisplayVideo360AdvertiserLinkProposal RPC.

Fields
parent

string

Required. Example format: properties/1234

CreateDisplayVideo360AdvertiserLinkRequest

Request message for CreateDisplayVideo360AdvertiserLink RPC.

Fields
parent

string

Required. Example format: properties/1234

CreateEventCreateRuleRequest

Request message for CreateEventCreateRule RPC.

Fields
parent

string

Required. Example format: properties/123/dataStreams/456

event_create_rule

EventCreateRule

Required. The EventCreateRule to create.

CreateExpandedDataSetRequest

Request message for CreateExpandedDataSet RPC.

Fields
parent

string

Required. Example format: properties/1234

expanded_data_set

ExpandedDataSet

Required. The ExpandedDataSet to create.

CreateFirebaseLinkRequest

Request message for CreateFirebaseLink RPC

Fields
parent

string

Required. Format: properties/{property_id} Example: properties/1234

CreateGoogleAdsLinkRequest

Request message for CreateGoogleAdsLink RPC

Fields
parent

string

Required. Example format: properties/1234

CreateKeyEventRequest

Request message for CreateKeyEvent RPC

Fields
key_event

KeyEvent

Required. The Key Event to create.

parent

string

Required. The resource name of the parent property where this Key Event will be created. Format: properties/123

CreateMeasurementProtocolSecretRequest

Request message for CreateMeasurementProtocolSecret RPC

Fields
parent

string

Required. The parent resource where this secret will be created. Format: properties/{property}/dataStreams/{dataStream}

measurement_protocol_secret

MeasurementProtocolSecret

Required. The measurement protocol secret to create.

CreatePropertyRequest

Request message for CreateProperty RPC.

Fields
property

Property

Required. The property to create. Note: the supplied property must specify its parent.

CreateRollupPropertyRequest

Request message for CreateRollupProperty RPC.

Fields
rollup_property

Property

Required. The roll-up property to create.

source_properties[]

string

Optional. The resource names of properties that will be sources to the created roll-up property.

CreateRollupPropertyResponse

Response message for CreateRollupProperty RPC.

Fields
rollup_property

Property

The created roll-up property.

CreateRollupPropertySourceLinkRequest

Request message for CreateRollupPropertySourceLink RPC.

Fields
parent

string

Required. Format: properties/{property_id} Example: properties/1234

CreateSKAdNetworkConversionValueSchemaRequest

Request message for CreateSKAdNetworkConversionValueSchema RPC.

Fields
parent

string

Required. The parent resource where this schema will be created. Format: properties/{property}/dataStreams/{dataStream}

skadnetwork_conversion_value_schema

SKAdNetworkConversionValueSchema

Required. SKAdNetwork conversion value schema to create.

CreateSearchAds360LinkRequest

Request message for CreateSearchAds360Link RPC.

Fields
parent

string

Required. Example format: properties/1234

CreateSubpropertyEventFilterRequest

Request message for CreateSubpropertyEventFilter RPC.

Fields
parent

string

Required. The ordinary property for which to create a subproperty event filter. Format: properties/property_id Example: properties/123

subproperty_event_filter

SubpropertyEventFilter

Required. The subproperty event filter to create.

CreateSubpropertyRequest

Request message for CreateSubproperty RPC.

Fields
parent

string

Required. The ordinary property for which to create a subproperty. Format: properties/property_id Example: properties/123

subproperty

Property

Required. The subproperty to create.

subproperty_event_filter

SubpropertyEventFilter

Optional. The subproperty event filter to create on an ordinary property.

CreateSubpropertyResponse

Response message for CreateSubproperty RPC.

Fields
subproperty

Property

The created subproperty.

subproperty_event_filter

SubpropertyEventFilter

The created subproperty event filter.

CustomDimension

A definition for a CustomDimension.

Fields
name

string

Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}

parameter_name

string

Required. Immutable. Tagging parameter name for this custom dimension.

If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name.

If this is an item-scoped dimension, then this is the parameter name found in the eCommerce items array.

May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions.

display_name

string

Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.

description

string

Optional. Description for this custom dimension. Max length of 150 characters.

scope

DimensionScope

Required. Immutable. The scope of this dimension.

disallow_ads_personalization

bool

Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization.

This is currently only supported by user-scoped custom dimensions.

DimensionScope

Valid values for the scope of this dimension.

Enums
DIMENSION_SCOPE_UNSPECIFIED Scope unknown or not specified.
EVENT Dimension scoped to an event.
USER Dimension scoped to a user.
ITEM Dimension scoped to eCommerce items

CustomMetric

A definition for a custom metric.

Fields
name

string

Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}

parameter_name

string

Required. Immutable. Tagging name for this custom metric.

If this is an event-scoped metric, then this is the event parameter name.

May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics.

display_name

string

Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.

description

string

Optional. Description for this custom dimension. Max length of 150 characters.

measurement_unit

MeasurementUnit

Required. The type for the custom metric's value.

scope

MetricScope

Required. Immutable. The scope of this custom metric.

restricted_metric_type[]

RestrictedMetricType

Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit.

MeasurementUnit

Possible types of representing the custom metric's value.

Currency representation may change in the future, requiring a breaking API change.

Enums
MEASUREMENT_UNIT_UNSPECIFIED MeasurementUnit unspecified or missing.
STANDARD This metric uses default units.
CURRENCY This metric measures a currency.
FEET This metric measures feet.
METERS This metric measures meters.
KILOMETERS This metric measures kilometers.
MILES This metric measures miles.
MILLISECONDS This metric measures milliseconds.
SECONDS This metric measures seconds.
MINUTES This metric measures minutes.
HOURS This metric measures hours.

MetricScope

The scope of this metric.

Enums
METRIC_SCOPE_UNSPECIFIED Scope unknown or not specified.
EVENT Metric scoped to an event.

RestrictedMetricType

Labels that mark the data in this custom metric as data that should be restricted to specific users.

Enums
RESTRICTED_METRIC_TYPE_UNSPECIFIED Type unknown or unspecified.
COST_DATA Metric reports cost data.
REVENUE_DATA Metric reports revenue data.

DataRedactionSettings

Settings for client-side data redaction. Singleton resource under a Web Stream.

Fields
name

string

Output only. Name of this Data Redaction Settings resource. Format: properties/{property_id}/dataStreams/{data_stream}/dataRedactionSettings Example: "properties/1000/dataStreams/2000/dataRedactionSettings"

email_redaction_enabled

bool

If enabled, any event parameter or user property values that look like an email will be redacted.

query_parameter_redaction_enabled

bool

Query Parameter redaction removes the key and value portions of a query parameter if it is in the configured set of query parameters.

If enabled, URL query replacement logic will be run for the Stream. Any query parameters defined in query_parameter_keys will be redacted.

query_parameter_keys[]

string

The query parameter keys to apply redaction logic to if present in the URL. Query parameter matching is case-insensitive.

Must contain at least one element if query_parameter_replacement_enabled is true. Keys cannot contain commas.

DataRetentionSettings

Settings values for data retention. This is a singleton resource.

Fields
name

string

Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings

event_data_retention

RetentionDuration

The length of time that event-level data is retained.

reset_user_data_on_new_activity

bool

If true, reset the retention period for the user identifier with every event from that user.

RetentionDuration

Valid values for the data retention duration.

Enums
RETENTION_DURATION_UNSPECIFIED Data retention time duration is not specified.
TWO_MONTHS The data retention time duration is 2 months.
FOURTEEN_MONTHS The data retention time duration is 14 months.
TWENTY_SIX_MONTHS The data retention time duration is 26 months. Available to 360 properties only.
THIRTY_EIGHT_MONTHS The data retention time duration is 38 months. Available to 360 properties only.
FIFTY_MONTHS The data retention time duration is 50 months. Available to 360 properties only.

DataSharingSettings

A resource message representing data sharing settings of a Google Analytics account.

Fields
name

string

Output only. Resource name. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings"

sharing_with_google_support_enabled

bool

Allows Google support to access the data in order to help troubleshoot issues.

sharing_with_google_assigned_sales_enabled

bool

Allows Google sales teams that are assigned to the customer to access the data in order to suggest configuration changes to improve results. Sales team restrictions still apply when enabled.

sharing_with_google_any_sales_enabled

bool

Allows any of Google sales to access the data in order to suggest configuration changes to improve results.

sharing_with_google_products_enabled

bool

Allows Google to use the data to improve other Google products or services.

sharing_with_others_enabled

bool

Allows Google to share the data anonymously in aggregate form with others.

DataStream

A resource message representing a data stream.

Fields
name

string

Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000"

type

DataStreamType

Required. Immutable. The type of this DataStream resource.

display_name

string

Human-readable display name for the Data Stream.

Required for web data streams.

The max allowed display name length is 255 UTF-16 code units.

create_time

Timestamp

Output only. Time when this stream was originally created.

update_time

Timestamp

Output only. Time when stream payload fields were last updated.

Union field stream_data. Data for specific data stream types. The message that will be set corresponds to the type of this stream. stream_data can be only one of the following:
web_stream_data

WebStreamData

Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.

android_app_stream_data

AndroidAppStreamData

Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.

ios_app_stream_data

IosAppStreamData

Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.

AndroidAppStreamData

Data specific to Android app streams.

Fields
firebase_app_id

string

Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.

package_name

string

Immutable. The package name for the app being measured. Example: "com.example.myandroidapp"

DataStreamType

The type of the data stream.

Enums
DATA_STREAM_TYPE_UNSPECIFIED Type unknown or not specified.
WEB_DATA_STREAM Web data stream.
ANDROID_APP_DATA_STREAM Android app data stream.
IOS_APP_DATA_STREAM iOS app data stream.

IosAppStreamData

Data specific to iOS app streams.

Fields
firebase_app_id

string

Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.

bundle_id

string

Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp"

WebStreamData

Data specific to web streams.

Fields
measurement_id

string

Output only. Analytics Measurement ID.

Example: "G-1A2BCD345E"

firebase_app_id

string

Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.

default_uri

string

Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"

DeleteAccessBindingRequest

Request message for DeleteAccessBinding RPC.

Fields
name

string

Required. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}

DeleteAccountRequest

Request message for DeleteAccount RPC.

Fields
name

string

Required. The name of the Account to soft-delete. Format: accounts/{account} Example: "accounts/100"

DeleteAdSenseLinkRequest

Request message to be passed to DeleteAdSenseLink method.

Fields
name

string

Required. Unique identifier for the AdSense Link to be deleted. Format: properties/{propertyId}/adSenseLinks/{linkId} Example: properties/1234/adSenseLinks/5678

DeleteCalculatedMetricRequest

Request message for DeleteCalculatedMetric RPC.

Fields
name

string

Required. The name of the CalculatedMetric to delete. Format: properties/{property_id}/calculatedMetrics/{calculated_metric_id} Example: properties/1234/calculatedMetrics/Metric01

DeleteChannelGroupRequest

Request message for DeleteChannelGroup RPC.

Fields
name

string

Required. The ChannelGroup to delete. Example format: properties/1234/channelGroups/5678

DeleteConnectedSiteTagRequest

Request message for DeleteConnectedSiteTag RPC.

Fields
property

string

The Universal Analytics property to delete connected site tags for. This API does not support GA4 properties. Format: properties/{universalAnalyticsPropertyId} Example: properties/1234

tag_id

string

Tag ID to forward events to. Also known as the Measurement ID, or the "G-ID" (For example: G-12345).

DeleteConversionEventRequest

Request message for DeleteConversionEvent RPC

Fields
name

string

Required. The resource name of the conversion event to delete. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conversionEvents/456"

DeleteDataStreamRequest

Request message for DeleteDataStream RPC.

Fields
name

string

Required. The name of the DataStream to delete. Example format: properties/1234/dataStreams/5678

DeleteDisplayVideo360AdvertiserLinkProposalRequest

Request message for DeleteDisplayVideo360AdvertiserLinkProposal RPC.

Fields
name

string

Required. The name of the DisplayVideo360AdvertiserLinkProposal to delete. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678

DeleteDisplayVideo360AdvertiserLinkRequest

Request message for DeleteDisplayVideo360AdvertiserLink RPC.

Fields
name

string

Required. The name of the DisplayVideo360AdvertiserLink to delete. Example format: properties/1234/displayVideo360AdvertiserLinks/5678

DeleteEventCreateRuleRequest

Request message for DeleteEventCreateRule RPC.

Fields
name

string

Required. Example format: properties/123/dataStreams/456/eventCreateRules/789

DeleteExpandedDataSetRequest

Request message for DeleteExpandedDataSet RPC.

Fields
name

string

Required. Example format: properties/1234/expandedDataSets/5678

DeleteFirebaseLinkRequest

Request message for DeleteFirebaseLink RPC

Fields
name

string

Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: properties/1234/firebaseLinks/5678

DeleteGoogleAdsLinkRequest

Request message for DeleteGoogleAdsLink RPC.

Fields
name

string

Required. Example format: properties/1234/googleAdsLinks/5678

DeleteKeyEventRequest

Request message for DeleteKeyEvent RPC

Fields
name

string

Required. The resource name of the Key Event to delete. Format: properties/{property}/keyEvents/{key_event} Example: "properties/123/keyEvents/456"

DeleteMeasurementProtocolSecretRequest

Request message for DeleteMeasurementProtocolSecret RPC

Fields
name

string

Required. The name of the MeasurementProtocolSecret to delete. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

DeletePropertyRequest

Request message for DeleteProperty RPC.

Fields
name

string

Required. The name of the Property to soft-delete. Format: properties/{property_id} Example: "properties/1000"

DeleteRollupPropertySourceLinkRequest

Request message for DeleteRollupPropertySourceLink RPC.

Fields
name

string

Required. Format: properties/{property_id}/rollupPropertySourceLinks/{rollup_property_source_link_id} Example: properties/1234/rollupPropertySourceLinks/5678

DeleteSKAdNetworkConversionValueSchemaRequest

Request message for DeleteSKAdNetworkConversionValueSchema RPC.

Fields
name

string

Required. The name of the SKAdNetworkConversionValueSchema to delete. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema/{skadnetwork_conversion_value_schema}

DeleteSearchAds360LinkRequest

Request message for DeleteSearchAds360Link RPC.

Fields
name

string

Required. The name of the SearchAds360Link to delete. Example format: properties/1234/SearchAds360Links/5678

DeleteSubpropertyEventFilterRequest

Request message for DeleteSubpropertyEventFilter RPC.

Fields
name

string

Required. Resource name of the subproperty event filter to delete. Format: properties/property_id/subpropertyEventFilters/subproperty_event_filter Example: properties/123/subpropertyEventFilters/456

DisplayVideo360AdvertiserLinkProposal

A proposal for a link between a GA4 property and a Display & Video 360 advertiser.

A proposal is converted to a DisplayVideo360AdvertiserLink once approved. Google Analytics admins approve inbound proposals while Display & Video 360 admins approve outbound proposals.

Fields
name

string

Output only. The resource name for this DisplayVideo360AdvertiserLinkProposal resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId}

Note: proposalId is not the Display & Video 360 Advertiser ID

advertiser_id

string

Immutable. The Display & Video 360 Advertiser's advertiser ID.

advertiser_display_name

string

Output only. The display name of the Display & Video Advertiser. Only populated for proposals that originated from Display & Video 360.

validation_email

string

Input only. On a proposal being sent to Display & Video 360, this field must be set to the email address of an admin on the target advertiser. This is used to verify that the Google Analytics admin is aware of at least one admin on the Display & Video 360 Advertiser. This does not restrict approval of the proposal to a single user. Any admin on the Display & Video 360 Advertiser may approve the proposal.

ads_personalization_enabled

BoolValue

Immutable. Enables personalized advertising features with this integration. If this field is not set on create, it will be defaulted to true.

campaign_data_sharing_enabled

BoolValue

Immutable. Enables the import of campaign data from Display & Video 360. If this field is not set on create, it will be defaulted to true.

cost_data_sharing_enabled

BoolValue

Immutable. Enables the import of cost data from Display & Video 360. This can only be enabled if campaign_data_sharing_enabled is enabled. If this field is not set on create, it will be defaulted to true.

EnhancedMeasurementSettings

Singleton resource under a web DataStream, configuring measurement of additional site interactions and content.

Fields
name

string

Output only. Resource name of the Enhanced Measurement Settings. Format: properties/{property_id}/dataStreams/{data_stream}/enhancedMeasurementSettings Example: "properties/1000/dataStreams/2000/enhancedMeasurementSettings"

stream_enabled

bool

Indicates whether Enhanced Measurement Settings will be used to automatically measure interactions and content on this web stream.

Changing this value does not affect the settings themselves, but determines whether they are respected.

scrolls_enabled

bool

If enabled, capture scroll events each time a visitor gets to the bottom of a page.

outbound_clicks_enabled

bool

If enabled, capture an outbound click event each time a visitor clicks a link that leads them away from your domain.

site_search_enabled

bool

If enabled, capture a view search results event each time a visitor performs a search on your site (based on a query parameter).

video_engagement_enabled

bool

If enabled, capture video play, progress, and complete events as visitors view embedded videos on your site.

file_downloads_enabled

bool

If enabled, capture a file download event each time a link is clicked with a common document, compressed file, application, video, or audio extension.

page_changes_enabled

bool

If enabled, capture a page view event each time the website changes the browser history state.

form_interactions_enabled

bool

If enabled, capture a form interaction event each time a visitor interacts with a form on your website. False by default.

search_query_parameter

string

Required. URL query parameters to interpret as site search parameters. Max length is 1024 characters. Must not be empty.

uri_query_parameter

string

Additional URL query parameters. Max length is 1024 characters.

EventCreateRule

An Event Create Rule defines conditions that will trigger the creation of an entirely new event based upon matched criteria of a source event. Additional mutations of the parameters from the source event can be defined.

Unlike Event Edit rules, Event Creation Rules have no defined order. They will all be run independently.

Event Edit and Event Create rules can't be used to modify an event created from an Event Create rule.

Fields
name

string

Output only. Resource name for this EventCreateRule resource. Format: properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}

destination_event

string

Required. The name of the new event to be created.

This value must: * be less than 40 characters * consist only of letters, digits or _ (underscores) * start with a letter

event_conditions[]

MatchingCondition

Required. Must have at least one condition, and can have up to 10 max. Conditions on the source event must match for this rule to be applied.

source_copy_parameters

bool

If true, the source parameters are copied to the new event. If false, or unset, all non-internal parameters are not copied from the source event. Parameter mutations are applied after the parameters have been copied.

parameter_mutations[]

ParameterMutation

Parameter mutations define parameter behavior on the new event, and are applied in order. A maximum of 20 mutations can be applied.

EventMapping

Event setting conditions to match an event.

Fields
event_name

string

Required. Name of the GA4 event. It must always be set. The max allowed display name length is 40 UTF-16 code units.

min_event_count

int64

At least one of the following four min/max values must be set. The values set will be ANDed together to qualify an event. The minimum number of times the event occurred. If not set, minimum event count won't be checked.

max_event_count

int64

The maximum number of times the event occurred. If not set, maximum event count won't be checked.

min_event_value

double

The minimum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, minimum event value won't be checked.

max_event_value

double

The maximum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, maximum event value won't be checked.

ExpandedDataSet

A resource message representing a GA4 ExpandedDataSet.

Fields
name

string

Output only. The resource name for this ExpandedDataSet resource. Format: properties/{property_id}/expandedDataSets/{expanded_data_set}

display_name

string

Required. The display name of the ExpandedDataSet. Max 200 chars.

description

string

Optional. The description of the ExpandedDataSet. Max 50 chars.

dimension_names[]

string

Immutable. The list of dimensions included in the ExpandedDataSet. See the API Dimensions for the list of dimension names.

metric_names[]

string

Immutable. The list of metrics included in the ExpandedDataSet. See the API Metrics for the list of dimension names.

dimension_filter_expression

ExpandedDataSetFilterExpression

Immutable. A logical expression of ExpandedDataSet filters applied to dimension included in the ExpandedDataSet. This filter is used to reduce the number of rows and thus the chance of encountering other row.

data_collection_start_time

Timestamp

Output only. Time when expanded data set began (or will begin) collecing data.

ExpandedDataSetFilter

A specific filter for a single dimension

Fields
field_name

string

Required. The dimension name to filter.

Union field one_filter. One of the above filters. one_filter can be only one of the following:
string_filter

StringFilter

A filter for a string-type dimension that matches a particular pattern.

in_list_filter

InListFilter

A filter for a string dimension that matches a particular list of options.

InListFilter

A filter for a string dimension that matches a particular list of options.

Fields
values[]

string

Required. The list of possible string values to match against. Must be non-empty.

case_sensitive

bool

Optional. If true, the match is case-sensitive. If false, the match is case-insensitive. Must be true.

StringFilter

A filter for a string-type dimension that matches a particular pattern.

Fields
match_type

MatchType

Required. The match type for the string filter.

value

string

Required. The string value to be matched against.

case_sensitive

bool

Optional. If true, the match is case-sensitive. If false, the match is case-insensitive. Must be true when match_type is EXACT. Must be false when match_type is CONTAINS.

MatchType

The match type for the string filter.

Enums
MATCH_TYPE_UNSPECIFIED Unspecified
EXACT Exact match of the string value.
CONTAINS Contains the string value.

ExpandedDataSetFilterExpression

A logical expression of EnhancedDataSet dimension filters.

Fields
Union field expr. The expression applied to a filter. expr can be only one of the following:
and_group

ExpandedDataSetFilterExpressionList

A list of expressions to be AND’ed together. It must contain a ExpandedDataSetFilterExpression with either not_expression or dimension_filter. This must be set for the top level ExpandedDataSetFilterExpression.

not_expression

ExpandedDataSetFilterExpression

A filter expression to be NOT'ed (that is, inverted, complemented). It must include a dimension_filter. This cannot be set on the top level ExpandedDataSetFilterExpression.

filter

ExpandedDataSetFilter

A filter on a single dimension. This cannot be set on the top level ExpandedDataSetFilterExpression.

ExpandedDataSetFilterExpressionList

A list of ExpandedDataSet filter expressions.

Fields
filter_expressions[]

ExpandedDataSetFilterExpression

A list of ExpandedDataSet filter expressions.

FetchAutomatedGa4ConfigurationOptOutRequest

Request for fetching the opt out status for the automated GA4 setup process.

Fields
property

string

Required. The UA property to get the opt out status. Note this request uses the internal property ID, not the tracking ID of the form UA-XXXXXX-YY. Format: properties/{internalWebPropertyId} Example: properties/1234

FetchAutomatedGa4ConfigurationOptOutResponse

Response message for fetching the opt out status for the automated GA4 setup process.

Fields
opt_out

bool

The opt out status for the UA property.

FetchConnectedGa4PropertyRequest

Request for looking up GA4 property connected to a UA property.

Fields
property

string

Required. The UA property for which to look up the connected GA4 property. Note this request uses the internal property ID, not the tracking ID of the form UA-XXXXXX-YY. Format: properties/{internal_web_property_id} Example: properties/1234

FetchConnectedGa4PropertyResponse

Response for looking up GA4 property connected to a UA property.

Fields
property

string

The GA4 property connected to the UA property. An empty string is returned when there is no connected GA4 property. Format: properties/{property_id} Example: properties/1234

GetAccessBindingRequest

Request message for GetAccessBinding RPC.

Fields
name

string

Required. The name of the access binding to retrieve. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}

GetAccountRequest

Request message for GetAccount RPC.

Fields
name

string

Required. The name of the account to lookup. Format: accounts/{account} Example: "accounts/100"

GetAdSenseLinkRequest

Request message to be passed to GetAdSenseLink method.

Fields
name

string

Required. Unique identifier for the AdSense Link requested. Format: properties/{propertyId}/adSenseLinks/{linkId} Example: properties/1234/adSenseLinks/5678

GetAttributionSettingsRequest

Request message for GetAttributionSettings RPC.

Fields
name

string

Required. The name of the attribution settings to retrieve. Format: properties/{property}/attributionSettings

GetAudienceRequest

Request message for GetAudience RPC.

Fields
name

string

Required. The name of the Audience to get. Example format: properties/1234/audiences/5678

GetBigQueryLinkRequest

Request message for GetBigQueryLink RPC.

Fields
name

string

Required. The name of the BigQuery link to lookup. Format: properties/{property_id}/bigQueryLinks/{bigquery_link_id} Example: properties/123/bigQueryLinks/456

GetCalculatedMetricRequest

Request message for GetCalculatedMetric RPC.

Fields
name

string

Required. The name of the CalculatedMetric to get. Format: properties/{property_id}/calculatedMetrics/{calculated_metric_id} Example: properties/1234/calculatedMetrics/Metric01

GetChannelGroupRequest

Request message for GetChannelGroup RPC.

Fields
name

string

Required. The ChannelGroup to get. Example format: properties/1234/channelGroups/5678

GetConversionEventRequest

Request message for GetConversionEvent RPC

Fields
name

string

Required. The resource name of the conversion event to retrieve. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conversionEvents/456"

GetCustomDimensionRequest

Request message for GetCustomDimension RPC.

Fields
name

string

Required. The name of the CustomDimension to get. Example format: properties/1234/customDimensions/5678

GetCustomMetricRequest

Request message for GetCustomMetric RPC.

Fields
name

string

Required. The name of the CustomMetric to get. Example format: properties/1234/customMetrics/5678

GetDataRedactionSettingsRequest

Request message for GetDataRedactionSettings RPC.

Fields
name

string

Required. The name of the settings to lookup. Format: properties/{property}/dataStreams/{data_stream}/dataRedactionSettings Example: "properties/1000/dataStreams/2000/dataRedactionSettings"

GetDataRetentionSettingsRequest

Request message for GetDataRetentionSettings RPC.

Fields
name

string

Required. The name of the settings to lookup. Format: properties/{property}/dataRetentionSettings Example: "properties/1000/dataRetentionSettings"

GetDataSharingSettingsRequest

Request message for GetDataSharingSettings RPC.

Fields
name

string

Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings"

GetDataStreamRequest

Request message for GetDataStream RPC.

Fields
name

string

Required. The name of the DataStream to get. Example format: properties/1234/dataStreams/5678

GetDisplayVideo360AdvertiserLinkProposalRequest

Request message for GetDisplayVideo360AdvertiserLinkProposal RPC.

Fields
name

string

Required. The name of the DisplayVideo360AdvertiserLinkProposal to get. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678

GetDisplayVideo360AdvertiserLinkRequest

Request message for GetDisplayVideo360AdvertiserLink RPC.

Fields
name

string

Required. The name of the DisplayVideo360AdvertiserLink to get. Example format: properties/1234/displayVideo360AdvertiserLink/5678

GetEnhancedMeasurementSettingsRequest

Request message for GetEnhancedMeasurementSettings RPC.

Fields
name

string

Required. The name of the settings to lookup. Format: properties/{property}/dataStreams/{data_stream}/enhancedMeasurementSettings Example: "properties/1000/dataStreams/2000/enhancedMeasurementSettings"

GetEventCreateRuleRequest

Request message for GetEventCreateRule RPC.

Fields
name

string

Required. The name of the EventCreateRule to get. Example format: properties/123/dataStreams/456/eventCreateRules/789

GetExpandedDataSetRequest

Request message for GetExpandedDataSet RPC.

Fields
name

string

Required. The name of the ExpandedDataSet to get. Example format: properties/1234/expandedDataSets/5678

GetGlobalSiteTagRequest

Request message for GetGlobalSiteTag RPC.

Fields
name

string

Required. The name of the site tag to lookup. Note that site tags are singletons and do not have unique IDs. Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag Example: "properties/123/dataStreams/456/globalSiteTag"

GetGoogleSignalsSettingsRequest

Request message for GetGoogleSignalsSettings RPC

Fields
name

string

Required. The name of the google signals settings to retrieve. Format: properties/{property}/googleSignalsSettings

GetKeyEventRequest

Request message for GetKeyEvent RPC

Fields
name

string

Required. The resource name of the Key Event to retrieve. Format: properties/{property}/keyEvents/{key_event} Example: "properties/123/keyEvents/456"

GetMeasurementProtocolSecretRequest

Request message for GetMeasurementProtocolSecret RPC.

Fields
name

string

Required. The name of the measurement protocol secret to lookup. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

GetPropertyRequest

Request message for GetProperty RPC.

Fields
name

string

Required. The name of the property to lookup. Format: properties/{property_id} Example: "properties/1000"

GetRollupPropertySourceLinkRequest

Request message for GetRollupPropertySourceLink RPC.

Fields
name

string

Required. The name of the roll-up property source link to lookup. Format: properties/{property_id}/rollupPropertySourceLinks/{rollup_property_source_link_id} Example: properties/123/rollupPropertySourceLinks/456

GetSKAdNetworkConversionValueSchemaRequest

Request message for GetSKAdNetworkConversionValueSchema RPC.

Fields
name

string

Required. The resource name of SKAdNetwork conversion value schema to look up. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema/{skadnetwork_conversion_value_schema}

GetSearchAds360LinkRequest

Request message for GetSearchAds360Link RPC.

Fields
name

string

Required. The name of the SearchAds360Link to get. Example format: properties/1234/SearchAds360Link/5678

GetSubpropertyEventFilterRequest

Request message for GetSubpropertyEventFilter RPC.

Fields
name

string

Required. Resource name of the subproperty event filter to lookup. Format: properties/property_id/subpropertyEventFilters/subproperty_event_filter Example: properties/123/subpropertyEventFilters/456

GlobalSiteTag

Read-only resource with the tag for sending data from a website to a DataStream. Only present for web DataStream resources.

Fields
name

string

Output only. Resource name for this GlobalSiteTag resource. Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag Example: "properties/123/dataStreams/456/globalSiteTag"

snippet

string

Immutable. JavaScript code snippet to be pasted as the first item into the head tag of every webpage to measure.

GoogleSignalsConsent

Consent field of the Google Signals settings.

Enums

GoogleSignalsSettings

Settings values for Google Signals. This is a singleton resource.

Fields
name

string

Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: "properties/1000/googleSignalsSettings"

state

GoogleSignalsState

Status of this setting.

consent

GoogleSignalsConsent

Output only. Terms of Service acceptance.

GoogleSignalsState

Status of the Google Signals settings.

Enums
GOOGLE_SIGNALS_STATE_UNSPECIFIED Google Signals status defaults to GOOGLE_SIGNALS_STATE_UNSPECIFIED to represent that the user has not made an explicit choice.
GOOGLE_SIGNALS_ENABLED Google Signals is enabled.
GOOGLE_SIGNALS_DISABLED Google Signals is disabled.

GroupingRule

The rules that govern how traffic is grouped into one channel.

Fields
display_name

string

Required. Customer defined display name for the channel.

expression

ChannelGroupFilterExpression

Required. The Filter Expression that defines the Grouping Rule.

IndustryCategory

The category selected for this property, used for industry benchmarking.

Enums
INDUSTRY_CATEGORY_UNSPECIFIED Industry category unspecified
AUTOMOTIVE Automotive
BUSINESS_AND_INDUSTRIAL_MARKETS Business and industrial markets
FINANCE Finance
HEALTHCARE Healthcare
TECHNOLOGY Technology
TRAVEL Travel
OTHER Other
ARTS_AND_ENTERTAINMENT Arts and entertainment
BEAUTY_AND_FITNESS Beauty and fitness
BOOKS_AND_LITERATURE Books and literature
FOOD_AND_DRINK Food and drink
GAMES Games
HOBBIES_AND_LEISURE Hobbies and leisure
HOME_AND_GARDEN Home and garden
INTERNET_AND_TELECOM Internet and telecom
LAW_AND_GOVERNMENT Law and government
NEWS News
ONLINE_COMMUNITIES Online communities
PEOPLE_AND_SOCIETY People and society
PETS_AND_ANIMALS Pets and animals
REAL_ESTATE Real estate
REFERENCE Reference
SCIENCE Science
SPORTS Sports
JOBS_AND_EDUCATION Jobs and education
SHOPPING Shopping

KeyEvent

A key event in a Google Analytics property.

Fields
name

string

Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}

event_name

string

Immutable. The event name for this key event. Examples: 'click', 'purchase'

create_time

Timestamp

Output only. Time when this key event was created in the property.

deletable

bool

Output only. If set to true, this event can be deleted.

custom

bool

Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property.

counting_method

CountingMethod

Required. The method by which Key Events will be counted across multiple events within a session.

default_value

DefaultValue

Optional. Defines a default value/currency for a key event.

CountingMethod

The method by which Key Events will be counted across multiple events within a session.

Enums
COUNTING_METHOD_UNSPECIFIED Counting method not specified.
ONCE_PER_EVENT Each Event instance is considered a Key Event.
ONCE_PER_SESSION An Event instance is considered a Key Event at most once per session per user.

DefaultValue

Defines a default value/currency for a key event.

Fields
numeric_value

double

Required. This will be used to populate the "value" parameter for all occurrences of this Key Event (specified by event_name) where that parameter is unset.

currency_code

string

Required. When an occurrence of this Key Event (specified by event_name) has no set currency this currency will be applied as the default. Must be in ISO 4217 currency code format.

See https://en.wikipedia.org/wiki/ISO_4217 for more information.

LinkProposalInitiatingProduct

An indication of which product the user initiated a link proposal from.

Enums
GOOGLE_ANALYTICS This proposal was created by a user from Google Analytics.
LINKED_PRODUCT This proposal was created by a user from a linked product (not Google Analytics).

LinkProposalState

The state of a link proposal resource.

Enums
AWAITING_REVIEW_FROM_GOOGLE_ANALYTICS This proposal is awaiting review from a Google Analytics user. This proposal will automatically expire after some time.
AWAITING_REVIEW_FROM_LINKED_PRODUCT This proposal is awaiting review from a user of a linked product. This proposal will automatically expire after some time.
WITHDRAWN This proposal has been withdrawn by an admin on the initiating product. This proposal will be automatically deleted after some time.
DECLINED This proposal has been declined by an admin on the receiving product. This proposal will be automatically deleted after some time.
EXPIRED This proposal expired due to lack of response from an admin on the receiving product. This proposal will be automatically deleted after some time.
OBSOLETE This proposal has become obsolete because a link was directly created to the same external product resource that this proposal specifies. This proposal will be automatically deleted after some time.

LinkProposalStatusDetails

Status information for a link proposal.

Fields
requestor_email

string

Output only. The email address of the user that proposed this linkage.

ListAccessBindingsRequest

Request message for ListAccessBindings RPC.

Fields
parent

string

Required. Formats: - accounts/{account} - properties/{property}

page_size

int32

The maximum number of access bindings to return. The service may return fewer than this value. If unspecified, at most 200 access bindings will be returned. The maximum value is 500; values above 500 will be coerced to 500.

page_token

string

A page token, received from a previous ListAccessBindings call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAccessBindings must match the call that provided the page token.

ListAccessBindingsResponse

Response message for ListAccessBindings RPC.

Fields
access_bindings[]

AccessBinding

List of AccessBindings. These will be ordered stably, but in an arbitrary order.

next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListAccountSummariesRequest

Request message for ListAccountSummaries RPC.

Fields
page_size

int32

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)

page_token

string

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.

ListAccountSummariesResponse

Response message for ListAccountSummaries RPC.

Fields
account_summaries[]

AccountSummary

Account summaries of all accounts the caller has access to.

next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListAccountsRequest

Request message for ListAccounts RPC.

Fields
page_size

int32

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)

page_token

string

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.

show_deleted

bool

Whether to include soft-deleted (ie: "trashed") Accounts in the results. Accounts can be inspected to determine whether they are deleted or not.

ListAccountsResponse

Request message for ListAccounts RPC.

Fields
accounts[]

Account

Results that were accessible to the caller.

next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListAdSenseLinksRequest

Request message to be passed to ListAdSenseLinks method.

Fields
parent

string

Required. Resource name of the parent property. Format: properties/{propertyId} Example: properties/1234

page_size

int32

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

page_token

string

A page token received from a previous ListAdSenseLinks call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListAdSenseLinks must match the call that provided the page token.

ListAdSenseLinksResponse

Response message for ListAdSenseLinks method.

Fields
next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListAudiencesRequest

Request message for ListAudiences RPC.

Fields
parent

string

Required. Example format: properties/1234

page_size

int32

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

page_token

string

A page token, received from a previous ListAudiences call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListAudiences must match the call that provided the page token.

ListAudiencesResponse

Response message for ListAudiences RPC.

Fields
audiences[]

Audience

List of Audiences.

next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListBigQueryLinksRequest

Request message for ListBigQueryLinks RPC.

Fields
parent

string

Required. The name of the property to list BigQuery links under. Format: properties/{property_id} Example: properties/1234

page_size

int32

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)

page_token

string

A page token, received from a previous ListBigQueryLinks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListBigQueryLinks must match the call that provided the page token.

ListBigQueryLinksResponse

Response message for ListBigQueryLinks RPC

Fields
next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListCalculatedMetricsRequest

Request message for ListCalculatedMetrics RPC.

Fields
parent

string

Required. Example format: properties/1234

page_size

int32

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 coerced to the maximum).

page_token

string

Optional. A page token, received from a previous ListCalculatedMetrics call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListCalculatedMetrics must match the call that provided the page token.

ListCalculatedMetricsResponse

Response message for ListCalculatedMetrics RPC.

Fields
calculated_metrics[]

CalculatedMetric

List of CalculatedMetrics.

next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListChannelGroupsRequest

Request message for ListChannelGroups RPC.

Fields
parent

string

Required. The property for which to list ChannelGroups. Example format: properties/1234

page_size

int32

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

page_token

string

A page token, received from a previous ListChannelGroups call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListChannelGroups must match the call that provided the page token.

ListChannelGroupsResponse

Response message for ListChannelGroups RPC.

Fields
channel_groups[]

ChannelGroup

List of ChannelGroup. These will be ordered stably, but in an arbitrary order.

next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListConnectedSiteTagsRequest

Request message for ListConnectedSiteTags RPC.

Fields
property

string

The Universal Analytics property to fetch connected site tags for. This does not work on GA4 properties. A maximum of 20 connected site tags will be returned. Example Format: properties/1234

ListConnectedSiteTagsResponse

Response message for ListConnectedSiteTags RPC.

Fields
connected_site_tags[]

ConnectedSiteTag

The site tags for the Universal Analytics property. A maximum of 20 connected site tags will be returned.

ListConversionEventsRequest

Request message for ListConversionEvents RPC

Fields
parent

string

Required. The resource name of the parent property. Example: 'properties/123'

page_size

int32

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)

page_token

string

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.

ListConversionEventsResponse

Response message for ListConversionEvents RPC.

Fields
conversion_events[]

ConversionEvent

The requested conversion events

next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListCustomDimensionsRequest

Request message for ListCustomDimensions RPC.

Fields
parent

string

Required. Example format: properties/1234

page_size

int32

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

page_token

string

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.

ListCustomDimensionsResponse

Response message for ListCustomDimensions RPC.

Fields
custom_dimensions[]

CustomDimension

List of CustomDimensions.

next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListCustomMetricsRequest

Request message for ListCustomMetrics RPC.

Fields
parent

string

Required. Example format: properties/1234

page_size

int32

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

page_token

string

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.

ListCustomMetricsResponse

Response message for ListCustomMetrics RPC.

Fields
custom_metrics[]

CustomMetric

List of CustomMetrics.

next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListDataStreamsRequest

Request message for ListDataStreams RPC.

Fields
parent

string

Required. Example format: properties/1234

page_size

int32

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

page_token

string

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.

ListDataStreamsResponse

Response message for ListDataStreams RPC.

Fields
data_streams[]

DataStream

List of DataStreams.

next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListDisplayVideo360AdvertiserLinkProposalsRequest

Request message for ListDisplayVideo360AdvertiserLinkProposals RPC.

Fields
parent

string

Required. Example format: properties/1234

page_size

int32

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

page_token

string

A page token, received from a previous ListDisplayVideo360AdvertiserLinkProposals call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListDisplayVideo360AdvertiserLinkProposals must match the call that provided the page token.

ListDisplayVideo360AdvertiserLinkProposalsResponse

Response message for ListDisplayVideo360AdvertiserLinkProposals RPC.

Fields
next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListDisplayVideo360AdvertiserLinksRequest

Request message for ListDisplayVideo360AdvertiserLinks RPC.

Fields
parent

string

Required. Example format: properties/1234

page_size

int32

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

page_token

string

A page token, received from a previous ListDisplayVideo360AdvertiserLinks call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListDisplayVideo360AdvertiserLinks must match the call that provided the page token.

ListDisplayVideo360AdvertiserLinksResponse

Response message for ListDisplayVideo360AdvertiserLinks RPC.

Fields
next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListEventCreateRulesRequest

Request message for ListEventCreateRules RPC.

Fields
parent

string

Required. Example format: properties/123/dataStreams/456

page_size

int32

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

page_token

string

A page token, received from a previous ListEventCreateRules call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListEventCreateRules must match the call that provided the page token.

ListEventCreateRulesResponse

Response message for ListEventCreateRules RPC.

Fields
event_create_rules[]

EventCreateRule

List of EventCreateRules. These will be ordered stably, but in an arbitrary order.

next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListExpandedDataSetsRequest

Request message for ListExpandedDataSets RPC.

Fields
parent

string

Required. Example format: properties/1234

page_size

int32

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

page_token

string

A page token, received from a previous ListExpandedDataSets call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListExpandedDataSet must match the call that provided the page token.

ListExpandedDataSetsResponse

Response message for ListExpandedDataSets RPC.

Fields
expanded_data_sets[]

ExpandedDataSet

List of ExpandedDataSet. These will be ordered stably, but in an arbitrary order.

next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListFirebaseLinksRequest

Request message for ListFirebaseLinks RPC

Fields
parent

string

Required. Format: properties/{property_id} Example: properties/1234

page_size

int32

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)

page_token

string

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.

ListFirebaseLinksResponse

Response message for ListFirebaseLinks RPC

Fields
next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. Currently, Google Analytics supports only one FirebaseLink per property, so this will never be populated.

ListGoogleAdsLinksRequest

Request message for ListGoogleAdsLinks RPC.

Fields
parent

string

Required. Example format: properties/1234

page_size

int32

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

page_token

string

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.

ListGoogleAdsLinksResponse

Response message for ListGoogleAdsLinks RPC.

Fields
next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListKeyEventsRequest

Request message for ListKeyEvents RPC

Fields
parent

string

Required. The resource name of the parent property. Example: 'properties/123'

page_size

int32

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)

page_token

string

A page token, received from a previous ListKeyEvents call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListKeyEvents must match the call that provided the page token.

ListKeyEventsResponse

Response message for ListKeyEvents RPC.

Fields
key_events[]

KeyEvent

The requested Key Events

next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListMeasurementProtocolSecretsRequest

Request message for ListMeasurementProtocolSecret RPC

Fields
parent

string

Required. The resource name of the parent stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets

page_size

int32

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.

page_token

string

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.

ListMeasurementProtocolSecretsResponse

Response message for ListMeasurementProtocolSecret RPC

Fields
measurement_protocol_secrets[]

MeasurementProtocolSecret

A list of secrets for the parent stream specified in the request.

next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListPropertiesRequest

Request message for ListProperties RPC.

Fields
filter

string

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

int32

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)

page_token

string

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.

show_deleted

bool

Whether to include soft-deleted (ie: "trashed") Properties in the results. Properties can be inspected to determine whether they are deleted or not.

ListPropertiesResponse

Response message for ListProperties RPC.

Fields
properties[]

Property

Results that matched the filter criteria and were accessible to the caller.

next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListRollupPropertySourceLinksRequest

Request message for ListRollupPropertySourceLinks RPC.

Fields
parent

string

Required. The name of the roll-up property to list roll-up property source links under. Format: properties/{property_id} Example: properties/1234

page_size

int32

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 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)

page_token

string

Optional. A page token, received from a previous ListRollupPropertySourceLinks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListRollupPropertySourceLinks must match the call that provided the page token.

ListRollupPropertySourceLinksResponse

Response message for ListRollupPropertySourceLinks RPC.

Fields
next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListSKAdNetworkConversionValueSchemasRequest

Request message for ListSKAdNetworkConversionValueSchemas RPC

Fields
parent

string

Required. The DataStream resource to list schemas for. Format: properties/{property_id}/dataStreams/{dataStream} Example: properties/1234/dataStreams/5678

page_size

int32

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)

page_token

string

A page token, received from a previous ListSKAdNetworkConversionValueSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListSKAdNetworkConversionValueSchema must match the call that provided the page token.

ListSKAdNetworkConversionValueSchemasResponse

Response message for ListSKAdNetworkConversionValueSchemas RPC

Fields
skadnetwork_conversion_value_schemas[]

SKAdNetworkConversionValueSchema

List of SKAdNetworkConversionValueSchemas. This will have at most one value.

next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. Currently, Google Analytics supports only one SKAdNetworkConversionValueSchema per dataStream, so this will never be populated.

ListSearchAds360LinksRequest

Request message for ListSearchAds360Links RPC.

Fields
parent

string

Required. Example format: properties/1234

page_size

int32

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

page_token

string

A page token, received from a previous ListSearchAds360Links call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListSearchAds360Links must match the call that provided the page token.

ListSearchAds360LinksResponse

Response message for ListSearchAds360Links RPC.

Fields
next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListSubpropertyEventFiltersRequest

Request message for ListSubpropertyEventFilters RPC.

Fields
parent

string

Required. Resource name of the ordinary property. Format: properties/property_id Example: properties/123

page_size

int32

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 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)

page_token

string

Optional. A page token, received from a previous ListSubpropertyEventFilters call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListSubpropertyEventFilters must match the call that provided the page token.

ListSubpropertyEventFiltersResponse

Response message for ListSubpropertyEventFilter RPC.

Fields
subproperty_event_filters[]

SubpropertyEventFilter

List of subproperty event filters.

next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

MatchingCondition

Defines a condition for when an Event Edit or Event Creation rule applies to an event.

Fields
field

string

Required. The name of the field that is compared against for the condition. If 'event_name' is specified this condition will apply to the name of the event. Otherwise the condition will apply to a parameter with the specified name.

This value cannot contain spaces.

comparison_type

ComparisonType

Required. The type of comparison to be applied to the value.

v