Index
AnalyticsAdminService(interface)AccessBetweenFilter(message)AccessBinding(message)AccessDateRange(message)AccessDimension(message)AccessDimensionHeader(message)AccessDimensionValue(message)AccessFilter(message)AccessFilterExpression(message)AccessFilterExpressionList(message)AccessInListFilter(message)AccessMetric(message)AccessMetricHeader(message)AccessMetricValue(message)AccessNumericFilter(message)AccessNumericFilter.Operation(enum)AccessOrderBy(message)AccessOrderBy.DimensionOrderBy(message)AccessOrderBy.DimensionOrderBy.OrderType(enum)AccessOrderBy.MetricOrderBy(message)AccessQuota(message)AccessQuotaStatus(message)AccessRow(message)AccessStringFilter(message)AccessStringFilter.MatchType(enum)Account(message)AccountSummary(message)AcknowledgeUserDataCollectionRequest(message)AcknowledgeUserDataCollectionResponse(message)ActionType(enum)ActorType(enum)AdSenseLink(message)ApproveDisplayVideo360AdvertiserLinkProposalRequest(message)ApproveDisplayVideo360AdvertiserLinkProposalResponse(message)ArchiveAudienceRequest(message)ArchiveCustomDimensionRequest(message)ArchiveCustomMetricRequest(message)AttributionSettings(message)AttributionSettings.AcquisitionConversionEventLookbackWindow(enum)AttributionSettings.AdsWebConversionDataExportScope(enum)AttributionSettings.OtherConversionEventLookbackWindow(enum)AttributionSettings.ReportingAttributionModel(enum)Audience(message)Audience.AudienceExclusionDurationMode(enum)AudienceDimensionOrMetricFilter(message)AudienceDimensionOrMetricFilter.BetweenFilter(message)AudienceDimensionOrMetricFilter.InListFilter(message)AudienceDimensionOrMetricFilter.NumericFilter(message)AudienceDimensionOrMetricFilter.NumericFilter.Operation(enum)AudienceDimensionOrMetricFilter.NumericValue(message)AudienceDimensionOrMetricFilter.StringFilter(message)AudienceDimensionOrMetricFilter.StringFilter.MatchType(enum)AudienceEventFilter(message)AudienceEventTrigger(message)AudienceEventTrigger.LogCondition(enum)AudienceFilterClause(message)AudienceFilterClause.AudienceClauseType(enum)AudienceFilterExpression(message)AudienceFilterExpressionList(message)AudienceFilterScope(enum)AudienceSequenceFilter(message)AudienceSequenceFilter.AudienceSequenceStep(message)AudienceSimpleFilter(message)BatchCreateAccessBindingsRequest(message)BatchCreateAccessBindingsResponse(message)BatchDeleteAccessBindingsRequest(message)BatchGetAccessBindingsRequest(message)BatchGetAccessBindingsResponse(message)BatchUpdateAccessBindingsRequest(message)BatchUpdateAccessBindingsResponse(message)BigQueryLink(message)CalculatedMetric(message)CalculatedMetric.MetricUnit(enum)CalculatedMetric.RestrictedMetricType(enum)CancelDisplayVideo360AdvertiserLinkProposalRequest(message)ChangeHistoryChange(message)ChangeHistoryChange.ChangeHistoryResource(message)ChangeHistoryEvent(message)ChangeHistoryResourceType(enum)ChannelGroup(message)ChannelGroupFilter(message)ChannelGroupFilter.InListFilter(message)ChannelGroupFilter.StringFilter(message)ChannelGroupFilter.StringFilter.MatchType(enum)ChannelGroupFilterExpression(message)ChannelGroupFilterExpressionList(message)CoarseValue(enum)ConnectedSiteTag(message)ConversionEvent(message)ConversionEvent.ConversionCountingMethod(enum)ConversionEvent.DefaultConversionValue(message)ConversionValues(message)CreateAccessBindingRequest(message)CreateAdSenseLinkRequest(message)CreateAudienceRequest(message)CreateBigQueryLinkRequest(message)CreateCalculatedMetricRequest(message)CreateChannelGroupRequest(message)CreateConnectedSiteTagRequest(message)CreateConnectedSiteTagResponse(message)CreateConversionEventRequest(message)CreateCustomDimensionRequest(message)CreateCustomMetricRequest(message)CreateDataStreamRequest(message)CreateDisplayVideo360AdvertiserLinkProposalRequest(message)CreateDisplayVideo360AdvertiserLinkRequest(message)CreateEventCreateRuleRequest(message)CreateEventEditRuleRequest(message)CreateExpandedDataSetRequest(message)CreateFirebaseLinkRequest(message)CreateGoogleAdsLinkRequest(message)CreateKeyEventRequest(message)CreateMeasurementProtocolSecretRequest(message)CreatePropertyRequest(message)CreateReportingDataAnnotationRequest(message)CreateRollupPropertyRequest(message)CreateRollupPropertyResponse(message)CreateRollupPropertySourceLinkRequest(message)CreateSKAdNetworkConversionValueSchemaRequest(message)CreateSearchAds360LinkRequest(message)CreateSubpropertyEventFilterRequest(message)CustomDimension(message)CustomDimension.DimensionScope(enum)CustomMetric(message)CustomMetric.MeasurementUnit(enum)CustomMetric.MetricScope(enum)CustomMetric.RestrictedMetricType(enum)DataRedactionSettings(message)DataRetentionSettings(message)DataRetentionSettings.RetentionDuration(enum)DataSharingSettings(message)DataStream(message)DataStream.AndroidAppStreamData(message)DataStream.DataStreamType(enum)DataStream.IosAppStreamData(message)DataStream.WebStreamData(message)DeleteAccessBindingRequest(message)DeleteAccountRequest(message)DeleteAdSenseLinkRequest(message)DeleteBigQueryLinkRequest(message)DeleteCalculatedMetricRequest(message)DeleteChannelGroupRequest(message)DeleteConnectedSiteTagRequest(message)DeleteConversionEventRequest(message)DeleteDataStreamRequest(message)DeleteDisplayVideo360AdvertiserLinkProposalRequest(message)DeleteDisplayVideo360AdvertiserLinkRequest(message)DeleteEventCreateRuleRequest(message)DeleteEventEditRuleRequest(message)DeleteExpandedDataSetRequest(message)DeleteFirebaseLinkRequest(message)DeleteGoogleAdsLinkRequest(message)DeleteKeyEventRequest(message)DeleteMeasurementProtocolSecretRequest(message)DeletePropertyRequest(message)DeleteReportingDataAnnotationRequest(message)DeleteRollupPropertySourceLinkRequest(message)DeleteSKAdNetworkConversionValueSchemaRequest(message)DeleteSearchAds360LinkRequest(message)DeleteSubpropertyEventFilterRequest(message)DisplayVideo360AdvertiserLink(message)DisplayVideo360AdvertiserLinkProposal(message)EnhancedMeasurementSettings(message)EventCreateRule(message)EventEditRule(message)EventMapping(message)ExpandedDataSet(message)ExpandedDataSetFilter(message)ExpandedDataSetFilter.InListFilter(message)ExpandedDataSetFilter.StringFilter(message)ExpandedDataSetFilter.StringFilter.MatchType(enum)ExpandedDataSetFilterExpression(message)ExpandedDataSetFilterExpressionList(message)FetchAutomatedGa4ConfigurationOptOutRequest(message)FetchAutomatedGa4ConfigurationOptOutResponse(message)FetchConnectedGa4PropertyRequest(message)FetchConnectedGa4PropertyResponse(message)FirebaseLink(message)GetAccessBindingRequest(message)GetAccountRequest(message)GetAdSenseLinkRequest(message)GetAttributionSettingsRequest(message)GetAudienceRequest(message)GetBigQueryLinkRequest(message)GetCalculatedMetricRequest(message)GetChannelGroupRequest(message)GetConversionEventRequest(message)GetCustomDimensionRequest(message)GetCustomMetricRequest(message)GetDataRedactionSettingsRequest(message)GetDataRetentionSettingsRequest(message)GetDataSharingSettingsRequest(message)GetDataStreamRequest(message)GetDisplayVideo360AdvertiserLinkProposalRequest(message)GetDisplayVideo360AdvertiserLinkRequest(message)GetEnhancedMeasurementSettingsRequest(message)GetEventCreateRuleRequest(message)GetEventEditRuleRequest(message)GetExpandedDataSetRequest(message)GetGlobalSiteTagRequest(message)GetGoogleSignalsSettingsRequest(message)GetKeyEventRequest(message)GetMeasurementProtocolSecretRequest(message)GetPropertyRequest(message)GetReportingDataAnnotationRequest(message)GetRollupPropertySourceLinkRequest(message)GetSKAdNetworkConversionValueSchemaRequest(message)GetSearchAds360LinkRequest(message)GetSubpropertyEventFilterRequest(message)GlobalSiteTag(message)GoogleAdsLink(message)GoogleSignalsConsent(enum)GoogleSignalsSettings(message)GoogleSignalsState(enum)GroupingRule(message)IndustryCategory(enum)KeyEvent(message)KeyEvent.CountingMethod(enum)KeyEvent.DefaultValue(message)LinkProposalInitiatingProduct(enum)LinkProposalState(enum)LinkProposalStatusDetails(message)ListAccessBindingsRequest(message)ListAccessBindingsResponse(message)ListAccountSummariesRequest(message)ListAccountSummariesResponse(message)ListAccountsRequest(message)ListAccountsResponse(message)ListAdSenseLinksRequest(message)ListAdSenseLinksResponse(message)ListAudiencesRequest(message)ListAudiencesResponse(message)ListBigQueryLinksRequest(message)ListBigQueryLinksResponse(message)ListCalculatedMetricsRequest(message)ListCalculatedMetricsResponse(message)ListChannelGroupsRequest(message)ListChannelGroupsResponse(message)ListConnectedSiteTagsRequest(message)ListConnectedSiteTagsResponse(message)ListConversionEventsRequest(message)ListConversionEventsResponse(message)ListCustomDimensionsRequest(message)ListCustomDimensionsResponse(message)ListCustomMetricsRequest(message)ListCustomMetricsResponse(message)ListDataStreamsRequest(message)ListDataStreamsResponse(message)ListDisplayVideo360AdvertiserLinkProposalsRequest(message)ListDisplayVideo360AdvertiserLinkProposalsResponse(message)ListDisplayVideo360AdvertiserLinksRequest(message)ListDisplayVideo360AdvertiserLinksResponse(message)ListEventCreateRulesRequest(message)ListEventCreateRulesResponse(message)ListEventEditRulesRequest(message)ListEventEditRulesResponse(message)ListExpandedDataSetsRequest(message)ListExpandedDataSetsResponse(message)ListFirebaseLinksRequest(message)ListFirebaseLinksResponse(message)ListGoogleAdsLinksRequest(message)ListGoogleAdsLinksResponse(message)ListKeyEventsRequest(message)ListKeyEventsResponse(message)ListMeasurementProtocolSecretsRequest(message)ListMeasurementProtocolSecretsResponse(message)ListPropertiesRequest(message)ListPropertiesResponse(message)ListReportingDataAnnotationsRequest(message)ListReportingDataAnnotationsResponse(message)ListRollupPropertySourceLinksRequest(message)ListRollupPropertySourceLinksResponse(message)ListSKAdNetworkConversionValueSchemasRequest(message)ListSKAdNetworkConversionValueSchemasResponse(message)ListSearchAds360LinksRequest(message)ListSearchAds360LinksResponse(message)ListSubpropertyEventFiltersRequest(message)ListSubpropertyEventFiltersResponse(message)MatchingCondition(message)MatchingCondition.ComparisonType(enum)MeasurementProtocolSecret(message)NumericValue(message)ParameterMutation(message)PostbackWindow(message)Property(message)PropertySummary(message)PropertyType(enum)ProvisionAccountTicketRequest(message)ProvisionAccountTicketResponse(message)ProvisionSubpropertyRequest(message)ProvisionSubpropertyResponse(message)ReorderEventEditRulesRequest(message)ReportingDataAnnotation(message)ReportingDataAnnotation.Color(enum)ReportingDataAnnotation.DateRange(message)RollupPropertySourceLink(message)RunAccessReportRequest(message)RunAccessReportResponse(message)SKAdNetworkConversionValueSchema(message)SearchAds360Link(message)SearchChangeHistoryEventsRequest(message)SearchChangeHistoryEventsResponse(message)ServiceLevel(enum)SetAutomatedGa4ConfigurationOptOutRequest(message)SetAutomatedGa4ConfigurationOptOutResponse(message)SubmitUserDeletionRequest(message)SubmitUserDeletionResponse(message)SubpropertyEventFilter(message)SubpropertyEventFilterClause(message)SubpropertyEventFilterClause.FilterClauseType(enum)SubpropertyEventFilterCondition(message)SubpropertyEventFilterCondition.StringFilter(message)SubpropertyEventFilterCondition.StringFilter.MatchType(enum)SubpropertyEventFilterExpression(message)SubpropertyEventFilterExpressionList(message)UpdateAccessBindingRequest(message)UpdateAccountRequest(message)UpdateAttributionSettingsRequest(message)UpdateAudienceRequest(message)UpdateBigQueryLinkRequest(message)UpdateCalculatedMetricRequest(message)UpdateChannelGroupRequest(message)UpdateConversionEventRequest(message)UpdateCustomDimensionRequest(message)UpdateCustomMetricRequest(message)UpdateDataRedactionSettingsRequest(message)UpdateDataRetentionSettingsRequest(message)UpdateDataStreamRequest(message)UpdateDisplayVideo360AdvertiserLinkRequest(message)UpdateEnhancedMeasurementSettingsRequest(message)UpdateEventCreateRuleRequest(message)UpdateEventEditRuleRequest(message)UpdateExpandedDataSetRequest(message)UpdateGoogleAdsLinkRequest(message)UpdateGoogleSignalsSettingsRequest(message)UpdateKeyEventRequest(message)UpdateMeasurementProtocolSecretRequest(message)UpdatePropertyRequest(message)UpdateReportingDataAnnotationRequest(message)UpdateSKAdNetworkConversionValueSchemaRequest(message)UpdateSearchAds360LinkRequest(message)UpdateSubpropertyEventFilterRequest(message)
AnalyticsAdminService
Service Interface for the Google Analytics Admin API.
| AcknowledgeUserDataCollection |
|---|
|
Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or through this API) before MeasurementProtocolSecret resources may be created.
|
| ApproveDisplayVideo360AdvertiserLinkProposal |
|---|
|
Approves a DisplayVideo360AdvertiserLinkProposal. The DisplayVideo360AdvertiserLinkProposal will be deleted and a new DisplayVideo360AdvertiserLink will be created.
|
| ArchiveAudience |
|---|
|
Archives an Audience on a property.
|
| ArchiveCustomDimension |
|---|
|
Archives a CustomDimension on a property.
|
| ArchiveCustomMetric |
|---|
|
Archives a CustomMetric on a property.
|
| BatchCreateAccessBindings |
|---|
|
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.
|
| BatchDeleteAccessBindings |
|---|
|
Deletes information about multiple users' links to an account or property.
|
| BatchGetAccessBindings |
|---|
|
Gets information about multiple access bindings to an account or property.
|
| BatchUpdateAccessBindings |
|---|
|
Updates information about multiple access bindings to an account or property.
|
| CancelDisplayVideo360AdvertiserLinkProposal |
|---|
|
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.
|
| CreateAccessBinding |
|---|
|
Creates an access binding on an account or property.
|
| CreateAdSenseLink |
|---|
|
Creates an AdSenseLink.
|
| CreateAudience |
|---|
|
Creates an Audience.
|
| CreateBigQueryLink |
|---|
|
Creates a BigQueryLink.
|
| CreateCalculatedMetric |
|---|
|
Creates a CalculatedMetric.
|
| CreateChannelGroup |
|---|
|
Creates a ChannelGroup.
|
| CreateConnectedSiteTag |
|---|
|
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.
|
| CreateConversionEvent |
|---|
|
Deprecated: Use
|
| CreateCustomDimension |
|---|
|
Creates a CustomDimension.
|
| CreateCustomMetric |
|---|
|
Creates a CustomMetric.
|
| CreateDataStream |
|---|
|
Creates a DataStream.
|
| CreateDisplayVideo360AdvertiserLink |
|---|
|
Creates a DisplayVideo360AdvertiserLink. This can only be utilized by users who have proper authorization both on the Google Analytics property and on the Display & Video 360 advertiser. Users who do not have access to the Display & Video 360 advertiser should instead seek to create a DisplayVideo360LinkProposal.
|
| CreateDisplayVideo360AdvertiserLinkProposal |
|---|
|
Creates a DisplayVideo360AdvertiserLinkProposal.
|
| CreateEventCreateRule |
|---|
|
Creates an EventCreateRule.
|
| CreateEventEditRule |
|---|
|
Creates an EventEditRule.
|
| CreateExpandedDataSet |
|---|
|
Creates a ExpandedDataSet.
|
| CreateFirebaseLink |
|---|
|
Creates a FirebaseLink. Properties can have at most one FirebaseLink.
|
| CreateGoogleAdsLink |
|---|
|
Creates a GoogleAdsLink.
|
| CreateKeyEvent |
|---|
|
Creates a Key Event.
|
| CreateMeasurementProtocolSecret |
|---|
|
Creates a measurement protocol secret.
|
| CreateProperty |
|---|
|
Creates a Google Analytics property with the specified location and attributes.
|
| CreateReportingDataAnnotation |
|---|
|
Creates a Reporting Data Annotation.
|
| CreateRollupProperty |
|---|
|
Create a roll-up property and all roll-up property source links.
|
| CreateRollupPropertySourceLink |
|---|
|
Creates a roll-up property source link. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties.
|
| CreateSKAdNetworkConversionValueSchema |
|---|
|
Creates a SKAdNetworkConversionValueSchema.
|
| CreateSearchAds360Link |
|---|
|
Creates a SearchAds360Link.
|
| CreateSubpropertyEventFilter |
|---|
|
Creates a subproperty Event Filter.
|
| DeleteAccessBinding |
|---|
|
Deletes an access binding on an account or property.
|
| DeleteAccount |
|---|
|
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.
|
| DeleteAdSenseLink |
|---|
|
Deletes an AdSenseLink.
|
| DeleteBigQueryLink |
|---|
|
Deletes a BigQueryLink on a property.
|
| DeleteCalculatedMetric |
|---|
|
Deletes a CalculatedMetric on a property.
|
| DeleteChannelGroup |
|---|
|
Deletes a ChannelGroup on a property.
|
| DeleteConnectedSiteTag |
|---|
|
Deletes a connected site tag for a Universal Analytics property. Note: this has no effect on GA4 properties.
|
| DeleteConversionEvent |
|---|
|
Deprecated: Use
|
| DeleteDataStream |
|---|
|
Deletes a DataStream on a property.
|
| DeleteDisplayVideo360AdvertiserLink |
|---|
|
Deletes a DisplayVideo360AdvertiserLink on a property.
|
| DeleteDisplayVideo360AdvertiserLinkProposal |
|---|
|
Deletes a DisplayVideo360AdvertiserLinkProposal on a property. This can only be used on cancelled proposals.
|
| DeleteEventCreateRule |
|---|
|
Deletes an EventCreateRule.
|
| DeleteEventEditRule |
|---|
|
Deletes an EventEditRule.
|
| DeleteExpandedDataSet |
|---|
|
Deletes a ExpandedDataSet on a property.
|
| DeleteFirebaseLink |
|---|
|
Deletes a FirebaseLink on a property
|
| DeleteGoogleAdsLink |
|---|
|
Deletes a GoogleAdsLink on a property
|
| DeleteKeyEvent |
|---|
|
Deletes a Key Event.
|
| DeleteMeasurementProtocolSecret |
|---|
|
Deletes target MeasurementProtocolSecret.
|
| DeleteProperty |
|---|
|
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.
|
| DeleteReportingDataAnnotation |
|---|
|
Deletes a Reporting Data Annotation.
|
| DeleteRollupPropertySourceLink |
|---|
|
Deletes a roll-up property source link. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties.
|
| DeleteSKAdNetworkConversionValueSchema |
|---|
|
Deletes target SKAdNetworkConversionValueSchema.
|
| DeleteSearchAds360Link |
|---|
|
Deletes a SearchAds360Link on a property.
|
| DeleteSubpropertyEventFilter |
|---|
|
Deletes a subproperty event filter.
|
| FetchAutomatedGa4ConfigurationOptOut |
|---|
|
Fetches the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.
|
| FetchConnectedGa4Property |
|---|
|
Given a specified UA property, looks up the GA4 property connected to it. Note: this cannot be used with GA4 properties.
|
| GetAccessBinding |
|---|
|
Gets information about an access binding.
|
| GetAccount |
|---|
|
Lookup for a single Account.
|
| GetAdSenseLink |
|---|
|
Looks up a single AdSenseLink.
|
| GetAttributionSettings |
|---|
|
Lookup for a AttributionSettings singleton.
|
| GetAudience |
|---|
|
Lookup for a single Audience. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.
|
| GetBigQueryLink |
|---|
|
Lookup for a single BigQuery Link.
|
| GetCalculatedMetric |
|---|
|
Lookup for a single CalculatedMetric.
|
| GetChannelGroup |
|---|
|
Lookup for a single ChannelGroup.
|
| GetConversionEvent |
|---|
|
Deprecated: Use
|
| GetCustomDimension |
|---|
|
Lookup for a single CustomDimension.
|
| GetCustomMetric |
|---|
|
Lookup for a single CustomMetric.
|
| GetDataRedactionSettings |
|---|
|
Lookup for a single DataRedactionSettings.
|
| GetDataRetentionSettings |
|---|
|
Returns the singleton data retention settings for this property.
|
| GetDataSharingSettings |
|---|
|
Get data sharing settings on an account. Data sharing settings are singletons.
|
| GetDataStream |
|---|
|
Lookup for a single DataStream.
|
| GetDisplayVideo360AdvertiserLink |
|---|
|
Look up a single DisplayVideo360AdvertiserLink
|
| GetDisplayVideo360AdvertiserLinkProposal |
|---|
|
Lookup for a single DisplayVideo360AdvertiserLinkProposal.
|
| GetEnhancedMeasurementSettings |
|---|
|
Returns the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect.
|
| GetEventCreateRule |
|---|
|
Lookup for a single EventCreateRule.
|
| GetEventEditRule |
|---|
|
Lookup for a single EventEditRule.
|
| GetExpandedDataSet |
|---|
|
Lookup for a single ExpandedDataSet.
|
| GetGlobalSiteTag |
|---|
|
Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.
|
| GetGoogleSignalsSettings |
|---|
|
Lookup for Google Signals settings for a property.
|
| GetKeyEvent |
|---|
|
Retrieve a single Key Event.
|
| GetMeasurementProtocolSecret |
|---|
|
Lookup for a single MeasurementProtocolSecret.
|
| GetProperty |
|---|
|
Lookup for a single GA Property.
|
| GetReportingDataAnnotation |
|---|
|
Lookup a single Reporting Data Annotation.
|
| GetRollupPropertySourceLink |
|---|
|
Lookup for a single roll-up property source Link. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties.
|
| GetSKAdNetworkConversionValueSchema |
|---|
|
Looks up a single SKAdNetworkConversionValueSchema.
|
| GetSearchAds360Link |
|---|
|
Look up a single SearchAds360Link
|
| GetSubpropertyEventFilter |
|---|
|
Lookup for a single subproperty Event Filter.
|
| ListAccessBindings |
|---|
|
Lists all access bindings on an account or property.
|
| ListAccountSummaries |
|---|
|
Returns summaries of all accounts accessible by the caller.
|
| ListAccounts |
|---|
|
Returns all accounts accessible by the caller. Note that these accounts might not currently have GA properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found.
|
| ListAdSenseLinks |
|---|
|
Lists AdSenseLinks on a property.
|
| ListAudiences |
|---|
|
Lists Audiences on a property. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.
|
| ListBigQueryLinks |
|---|
|
Lists BigQuery Links on a property.
|
| ListCalculatedMetrics |
|---|
|
Lists CalculatedMetrics on a property.
|
| ListChannelGroups |
|---|
|
Lists ChannelGroups on a property.
|
| ListConnectedSiteTags |
|---|
|
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.
|
| ListConversionEvents |
|---|
|
Deprecated: Use Returns an empty list if no conversion events are found.
|
| ListCustomDimensions |
|---|
|
Lists CustomDimensions on a property.
|
| ListCustomMetrics |
|---|
|
Lists CustomMetrics on a property.
|
| ListDataStreams |
|---|
|
Lists DataStreams on a property.
|
| ListDisplayVideo360AdvertiserLinkProposals |
|---|
|
Lists DisplayVideo360AdvertiserLinkProposals on a property.
|
| ListDisplayVideo360AdvertiserLinks |
|---|
|
Lists all DisplayVideo360AdvertiserLinks on a property.
|
| ListEventCreateRules |
|---|
|
Lists EventCreateRules on a web data stream.
|
| ListEventEditRules |
|---|
|
Lists EventEditRules on a web data stream.
|
| ListExpandedDataSets |
|---|
|
Lists ExpandedDataSets on a property.
|
| ListFirebaseLinks |
|---|
|
Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.
|
| ListGoogleAdsLinks |
|---|
|
Lists GoogleAdsLinks on a property.
|
| ListKeyEvents |
|---|
|
Returns a list of Key Events in the specified parent property. Returns an empty list if no Key Events are found.
|
| ListMeasurementProtocolSecrets |
|---|
|
Returns child MeasurementProtocolSecrets under the specified parent Property.
|
| ListProperties |
|---|
|
Returns child Properties under the specified parent Account. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found.
|
| ListReportingDataAnnotations |
|---|
|
List all Reporting Data Annotations on a property.
|
| ListRollupPropertySourceLinks |
|---|
|
Lists roll-up property source Links on a property. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties.
|
| ListSKAdNetworkConversionValueSchemas |
|---|
|
Lists SKAdNetworkConversionValueSchema on a stream. Properties can have at most one SKAdNetworkConversionValueSchema.
|
| ListSearchAds360Links |
|---|
|
Lists all SearchAds360Links on a property.
|
| ListSubpropertyEventFilters |
|---|
|
List all subproperty Event Filters on a property.
|
| ProvisionAccountTicket |
|---|
|
Requests a ticket for creating an account.
|
| ProvisionSubproperty |
|---|
|
Create a subproperty and a subproperty event filter that applies to the created subproperty.
|
| ReorderEventEditRules |
|---|
|
Changes the processing order of event edit rules on the specified stream.
|
| RunAccessReport |
|---|
|
Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Explorations, GA Data API, and other products like Firebase & Admob that can retrieve data from Google 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. To give your feedback on this API, complete the Google Analytics Access Reports feedback form.
|
| SearchChangeHistoryEvents |
|---|
|
Searches through all changes to an account or its children given the specified set of filters. Only returns the subset of changes supported by the API. The UI may return additional changes.
|
| SetAutomatedGa4ConfigurationOptOut |
|---|
|
Sets the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.
|
| UpdateAccessBinding |
|---|
|
Updates an access binding on an account or property.
|
| UpdateAccount |
|---|
|
Updates an account.
|
| UpdateAttributionSettings |
|---|
|
Updates attribution settings on a property.
|
| UpdateAudience |
|---|
|
Updates an Audience on a property.
|
| UpdateBigQueryLink |
|---|
|
Updates a BigQueryLink.
|
| UpdateCalculatedMetric |
|---|
|
Updates a CalculatedMetric on a property.
|
| UpdateChannelGroup |
|---|
|
Updates a ChannelGroup.
|
| UpdateConversionEvent |
|---|
|
Deprecated: Use
|
| UpdateCustomDimension |
|---|
|
Updates a CustomDimension on a property.
|
| UpdateCustomMetric |
|---|
|
Updates a CustomMetric on a property.
|
| UpdateDataRedactionSettings |
|---|
|
Updates a DataRedactionSettings on a property.
|
| UpdateDataRetentionSettings |
|---|
|
Updates the singleton data retention settings for this property.
|
| UpdateDataStream |
|---|
|
Updates a DataStream on a property.
|
| UpdateDisplayVideo360AdvertiserLink |
|---|
|
Updates a DisplayVideo360AdvertiserLink on a property.
|
| UpdateEnhancedMeasurementSettings |
|---|
|
Updates the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect.
|
| UpdateEventCreateRule |
|---|
|
Updates an EventCreateRule.
|
| UpdateEventEditRule |
|---|
|
Updates an EventEditRule.
|
| UpdateExpandedDataSet |
|---|
|
Updates a ExpandedDataSet on a property.
|
| UpdateGoogleAdsLink |
|---|
|
Updates a GoogleAdsLink on a property
|
| UpdateGoogleSignalsSettings |
|---|
|
Updates Google Signals settings for a property.
|
| UpdateKeyEvent |
|---|
|
Updates a Key Event.
|
| UpdateMeasurementProtocolSecret |
|---|
|
Updates a measurement protocol secret.
|
| UpdateProperty |
|---|
|
Updates a property.
|
| UpdateReportingDataAnnotation |
|---|
|
Updates a Reporting Data Annotation.
|
| UpdateSKAdNetworkConversionValueSchema |
|---|
|
Updates a SKAdNetworkConversionValueSchema.
|
| UpdateSearchAds360Link |
|---|
|
Updates a SearchAds360Link on a property.
|
| UpdateSubpropertyEventFilter |
|---|
|
Updates a subproperty Event Filter.
|
AccessBetweenFilter
To express that the result needs to be between two numbers (inclusive).
| Fields | |
|---|---|
from_value |
Begins with this number. |
to_value |
Ends with this number. |
AccessBinding
A binding of a user to a set of roles.
| Fields | |
|---|---|
name |
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[] |
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 |
If set, the email address of the user to set roles for. Format: "[email protected]" |
AccessDateRange
A contiguous range of days: startDate, startDate + 1, ..., endDate.
| Fields | |
|---|---|
start_date |
The inclusive start date for the query in the format |
end_date |
The inclusive end date for the query in the format |
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 |
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 |
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 |
The dimension's name; for example 'userEmail'. |
AccessDimensionValue
The value of a dimension.
| Fields | |
|---|---|
value |
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 |
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 |
Strings related filter. |
in_list_filter |
A filter for in list values. |
numeric_filter |
A filter for numeric or date values. |
between_filter |
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 |
Each of the FilterExpressions in the and_group has an AND relationship. |
or_group |
Each of the FilterExpressions in the or_group has an OR relationship. |
not_expression |
The FilterExpression is NOT of not_expression. |
access_filter |
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[] |
A list of filter expressions. |
AccessInListFilter
The result needs to be in a list of string values.
| Fields | |
|---|---|
values[] |
The list of string values. Must be non-empty. |
case_sensitive |
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 |
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 |
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 |
The metric's name; for example 'accessCount'. |
AccessMetricValue
The value of a metric.
| Fields | |
|---|---|
value |
The measurement value. For example, this value may be '13'. |
AccessNumericFilter
Filters for numeric or date values.
| Fields | |
|---|---|
operation |
The operation type for this filter. |
value |
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 |
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 |
Sorts results by a metric's values. |
dimension |
Sorts results by a dimension's values. |
DimensionOrderBy
Sorts by dimension values.
| Fields | |
|---|---|
dimension_name |
A dimension name in the request to order by. |
order_type |
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 |
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 |
Properties can use 250,000 tokens per day. Most requests consume fewer than 10 tokens. |
tokens_per_hour |
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 |
Properties can use up to 50 concurrent requests. |
server_errors_per_project_per_hour |
Properties and cloud project pairs can have up to 50 server errors per hour. |
tokens_per_project_per_hour |
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 |
Quota consumed by this request. |
remaining |
Quota remaining after this request. |
AccessRow
Access report data for each row.
| Fields | |
|---|---|
dimension_values[] |
List of dimension values. These values are in the same order as specified in the request. |
metric_values[] |
List of metric values. These values are in the same order as specified in the request. |
AccessStringFilter
The filter for strings.
| Fields | |
|---|---|
match_type |
The match type for this filter. |
value |
The string value used for the matching. |
case_sensitive |
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 |
Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100" |
create_time |
Output only. Time when this account was originally created. |
update_time |
Output only. Time when account payload fields were last updated. |
display_name |
Required. Human-readable display name for this account. |
region_code |
Country of business. Must be a Unicode CLDR region code. |
deleted |
Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested. |
gmp_organization |
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 Google Analytics properties.
| Fields | |
|---|---|
name |
Resource name for this account summary. Format: accountSummaries/{account_id} Example: "accountSummaries/1000" |
account |
Resource name of account referred to by this account summary Format: accounts/{account_id} Example: "accounts/1000" |
display_name |
Display name for the account referred to in this account summary. |
property_summaries[] |
List of summaries for child accounts of this account. |
AcknowledgeUserDataCollectionRequest
Request message for AcknowledgeUserDataCollection RPC.
| Fields | |
|---|---|
property |
Required. The property for which to acknowledge user data collection. |
acknowledgement |
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. |
AdSenseLink
A link between a Google Analytics property and an AdSense for Content ad client.
| Fields | |
|---|---|
name |
Output only. The resource name for this AdSense Link resource. Format: properties/{propertyId}/adSenseLinks/{linkId} Example: properties/1234/adSenseLinks/6789 |
ad_client_code |
Immutable. The AdSense ad client code that the Google Analytics property is linked to. Example format: "ca-pub-1234567890" |
ApproveDisplayVideo360AdvertiserLinkProposalRequest
Request message for ApproveDisplayVideo360AdvertiserLinkProposal RPC.
| Fields | |
|---|---|
name |
Required. The name of the DisplayVideo360AdvertiserLinkProposal to approve. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678 |
ApproveDisplayVideo360AdvertiserLinkProposalResponse
Response message for ApproveDisplayVideo360AdvertiserLinkProposal RPC.
| Fields | |
|---|---|
display_video_360_advertiser_link |
The DisplayVideo360AdvertiserLink created as a result of approving the proposal. |
ArchiveAudienceRequest
Request message for ArchiveAudience RPC.
| Fields | |
|---|---|
name |
Required. Example format: properties/1234/audiences/5678 |
ArchiveCustomDimensionRequest
Request message for ArchiveCustomDimension RPC.
| Fields | |
|---|---|
name |
Required. The name of the CustomDimension to archive. Example format: properties/1234/customDimensions/5678 |
ArchiveCustomMetricRequest
Request message for ArchiveCustomMetric RPC.
| Fields | |
|---|---|
name |
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 |
Output only. Resource name of this attribution settings resource. Format: properties/{property_id}/attributionSettings Example: "properties/1000/attributionSettings" |
acquisition_conversion_event_lookback_window |
Required. The lookback window configuration for acquisition conversion events. The default window size is 30 days. |
other_conversion_event_lookback_window |
Required. The lookback window for all other, non-acquisition conversion events. The default window size is 90 days. |
reporting_attribution_model |
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 |
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 an Audience.
| Fields | |
|---|---|
name |
Output only. The resource name for this Audience resource. Format: properties/{propertyId}/audiences/{audienceId} |
display_name |
Required. The display name of the Audience. |
description |
Required. The description of the Audience. |
membership_duration_days |
Required. Immutable. The duration a user should stay in an Audience. It cannot be set to more than 540 days. |
ads_personalization_enabled |
Output only. It is automatically set by GA to false if this is an NPA Audience and is excluded from ads personalization. |
event_trigger |
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 |
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[] |
Required. Immutable. Unordered list. Filter clauses that define the Audience. All clauses will be AND’ed together. |
create_time |
Output only. Time when the Audience was created. |
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 |
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 |
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 |
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 |
A filter for a string-type dimension that matches a particular pattern. |
in_list_filter |
A filter for a string dimension that matches a particular list of options. |
numeric_filter |
A filter for numeric or date values on a dimension or metric. |
between_filter |
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 |
Required. Begins with this number, inclusive. |
to_value |
Required. Ends with this number, inclusive. |
InListFilter
A filter for a string dimension that matches a particular list of options.
| Fields | |
|---|---|
values[] |
Required. The list of possible string values to match against. Must be non-empty. |
case_sensitive |
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 |
Required. The operation applied to a numeric filter. |
value |
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 |
Integer value. |
double_value |
Double value. |
StringFilter
A filter for a string-type dimension that matches a particular pattern.
| Fields | |
|---|---|
match_type |
Required. The match type for the string filter. |
value |
Required. The string value to be matched against. |
case_sensitive |
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 |
Required. Immutable. The name of the event to match against. |
event_parameter_filter_expression |
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 |
Required. The event name that will be logged. |
log_condition |
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 |
Required. Specifies whether this is an include or exclude filter clause. |
Union field
|
|
simple_filter |
A simple filter that a user must satisfy to be a member of the Audience. |
sequence_filter |
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 |
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 |
A list of expressions to OR’ed together. It cannot contain AudienceFilterExpressions with and_group or or_group. |
not_expression |
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 |
A filter on a single dimension or metric. This cannot be set on the top level AudienceFilterExpression. |
event_filter |
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[] |
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 |
Required. Immutable. Specifies the scope for this filter. |
sequence_maximum_duration |
Optional. Defines the time period in which the whole sequence must occur. |
sequence_steps[] |
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 |
Required. Immutable. Specifies the scope for this step. |
immediately_follows |
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 |
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 |
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 |
Required. Immutable. Specifies the scope for this filter. |
filter_expression |
Required. Immutable. A logical expression of Audience dimension, metric, or event filters. |
BatchCreateAccessBindingsRequest
Request message for BatchCreateAccessBindings RPC.
| Fields | |
|---|---|
parent |
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[] |
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[] |
The access bindings created. |
BatchDeleteAccessBindingsRequest
Request message for BatchDeleteAccessBindings RPC.
| Fields | |
|---|---|
parent |
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[] |
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 |
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[] |
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[] |
The requested access bindings. |
BatchUpdateAccessBindingsRequest
Request message for BatchUpdateAccessBindings RPC.
| Fields | |
|---|---|
parent |
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[] |
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[] |
The access bindings updated. |
BigQueryLink
A link between a Google Analytics property and BigQuery project.
| Fields | |
|---|---|
name |
Output only. Resource name of this BigQuery link. Format: 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}' Format: 'properties/1234/bigQueryLinks/abc567' |
project |
Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234' |
create_time |
Output only. Time when the link was created. |
daily_export_enabled |
If set true, enables daily data export to the linked Google Cloud project. |
streaming_export_enabled |
If set true, enables streaming export to the linked Google Cloud project. |
fresh_daily_export_enabled |
If set true, enables fresh daily export to the linked Google Cloud project. |
include_advertising_id |
If set true, exported data will include advertising identifiers for mobile app streams. |
export_streams[] |
The list of streams under the parent property for which data will be exported. Format: properties/{property_id}/dataStreams/{stream_id} Example: ['properties/1000/dataStreams/2000'] |
excluded_events[] |
The list of event names that will be excluded from exports. |
dataset_location |
Required. Immutable. The geographic location where the created BigQuery dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. |
CalculatedMetric
A definition for a calculated metric.
| Fields | |
|---|---|
name |
Output only. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}' |
description |
Optional. Description for this calculated metric. Max length of 4096 characters. |
display_name |
Required. Display name for this calculated metric as shown in the Google Analytics UI. Max length 82 characters. |
calculated_metric_id |
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 |
Required. The type for the calculated metric's value. |
restricted_metric_type[] |
Output only. Types of restricted data that this metric contains. |
formula |
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 |
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 |
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 |
Resource name of the resource whose changes are described by this entry. |
action |
The type of action that changed this resource. |
resource_before_change |
Resource contents from before the change was made. If this resource was created in this change, this field will be missing. |
resource_after_change |
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
|
|
account |
A snapshot of an Account resource in change history. |
property |
A snapshot of a Property resource in change history. |
firebase_link |
A snapshot of a FirebaseLink resource in change history. |
google_ads_link |
A snapshot of a GoogleAdsLink resource in change history. |
google_signals_settings |
A snapshot of a GoogleSignalsSettings resource in change history. |
display_video_360_advertiser_link |
A snapshot of a DisplayVideo360AdvertiserLink resource in change history. |
display_video_360_advertiser_link_proposal |
A snapshot of a DisplayVideo360AdvertiserLinkProposal resource in change history. |
conversion_event |
A snapshot of a ConversionEvent resource in change history. |
measurement_protocol_secret |
A snapshot of a MeasurementProtocolSecret resource in change history. |
custom_dimension |
A snapshot of a CustomDimension resource in change history. |
custom_metric |
A snapshot of a CustomMetric resource in change history. |
data_retention_settings |
A snapshot of a data retention settings resource in change history. |
search_ads_360_link |
A snapshot of a SearchAds360Link resource in change history. |
data_stream |
A snapshot of a DataStream resource in change history. |
attribution_settings |
A snapshot of AttributionSettings resource in change history. |
expanded_data_set |
A snapshot of an ExpandedDataSet resource in change history. |
channel_group |
A snapshot of a ChannelGroup resource in change history. |
bigquery_link |
A snapshot of a BigQuery link resource in change history. |
enhanced_measurement_settings |
A snapshot of EnhancedMeasurementSettings resource in change history. |
data_redaction_settings |
A snapshot of DataRedactionSettings resource in change history. |
skadnetwork_conversion_value_schema |
A snapshot of SKAdNetworkConversionValueSchema resource in change history. |
adsense_link |
A snapshot of an AdSenseLink resource in change history. |
audience |
A snapshot of an Audience resource in change history. |
event_create_rule |
A snapshot of an EventCreateRule resource in change history. |
key_event |
A snapshot of a KeyEvent resource in change history. |
calculated_metric |
A snapshot of a CalculatedMetric resource in change history. |
reporting_data_annotation |
A snapshot of a ReportingDataAnnotation 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 |
ID of this change history event. This ID is unique across Google Analytics. |
change_time |
Time when change was made. |
actor_type |
The type of actor that made this change. |
user_actor_email |
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 |
If true, then the list of changes returned was filtered, and does not represent all changes that occurred in this event. |
changes[] |
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 |
FIREBASE_LINK |
FirebaseLink resource |
GOOGLE_ADS_LINK |
GoogleAdsLink 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 |
DISPLAY_VIDEO_360_ADVERTISER_LINK |
DisplayVideo360AdvertiserLink resource |
DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL |
DisplayVideo360AdvertiserLinkProposal resource |
SEARCH_ADS_360_LINK |
SearchAds360Link resource |
DATA_STREAM |
DataStream resource |
ATTRIBUTION_SETTINGS |
AttributionSettings resource |
EXPANDED_DATA_SET |
ExpandedDataSet resource |
CHANNEL_GROUP |
ChannelGroup resource |
BIGQUERY_LINK |
BigQuery link resource |
ENHANCED_MEASUREMENT_SETTINGS |
EnhancedMeasurementSettings resource |
DATA_REDACTION_SETTINGS |
DataRedactionSettings resource |
SKADNETWORK_CONVERSION_VALUE_SCHEMA |
SKAdNetworkConversionValueSchema resource |
ADSENSE_LINK |
AdSenseLink resource |
AUDIENCE |
Audience resource |
EVENT_CREATE_RULE |
EventCreateRule resource |
KEY_EVENT |
KeyEvent resource |
CALCULATED_METRIC |
CalculatedMetric resource |
REPORTING_DATA_ANNOTATION |
ReportingDataAnnotation resource |
ChannelGroup
A resource message representing a Channel Group.
| Fields | |
|---|---|
name |
Output only. The resource name for this Channel Group resource. Format: properties/{property}/channelGroups/{channel_group} |
display_name |
Required. The display name of the Channel Group. Max length of 80 characters. |
description |
The description of the Channel Group. Max length of 256 characters. |
grouping_rule[] |
Required. The grouping rules of channels. Maximum number of rules is 50. |
system_defined |
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 |
Optional. If true, this channel group will be used as the default channel group for reports. Only one channel group can be set as The Google Analytics predefined channel group is the primary by default. |
ChannelGroupFilter
A specific filter for a single dimension.
| Fields | |
|---|---|
field_name |
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 |
A filter for a string-type dimension that matches a particular pattern. |
in_list_filter |
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[] |
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 |
Required. The match type for the string filter. |
value |
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 |
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 |
A list of expressions to OR’ed together. It cannot contain ChannelGroupFilterExpressions with and_group or or_group. |
not_expression |
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 |
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[] |
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 |
Required. User-provided display name for the connected site tag. Must be less than 256 characters. |
tag_id |
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 |
Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} |
event_name |
Immutable. The event name for this conversion event. Examples: 'click', 'purchase' |
create_time |
Output only. Time when this conversion event was created in the property. |
deletable |
Output only. If set, this event can currently be deleted with DeleteConversionEvent. |
custom |
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 |
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 |
default_conversion_value |
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 |
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 |
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 |
Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units. |
coarse_value |
Required. A coarse grained conversion value. This value is not guaranteed to be unique. |
event_mappings[] |
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 |
If true, the SDK should lock to this conversion value for the current postback window. |
fine_value |
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 |
Required. Formats: - accounts/{account} - properties/{property} |
access_binding |
Required. The access binding to create. |
CreateAdSenseLinkRequest
Request message to be passed to CreateAdSenseLink method.
| Fields | |
|---|---|
parent |
Required. The property for which to create an AdSense Link. Format: properties/{propertyId} Example: properties/1234 |
adsense_link |
Required. The AdSense Link to create |
CreateAudienceRequest
Request message for CreateAudience RPC.
| Fields | |
|---|---|
parent |
Required. Example format: properties/1234 |
audience |
Required. The audience to create. |
CreateBigQueryLinkRequest
Request message for CreateBigQueryLink RPC.
| Fields | |
|---|---|
parent |
Required. Example format: properties/1234 |
bigquery_link |
Required. The BigQueryLink to create. |
CreateCalculatedMetricRequest
Request message for CreateCalculatedMetric RPC.
| Fields | |
|---|---|
parent |
Required. Format: properties/{property_id} Example: properties/1234 |
calculated_metric_id |
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 |
Required. The CalculatedMetric to create. |
CreateChannelGroupRequest
Request message for CreateChannelGroup RPC.
| Fields | |
|---|---|
parent |
Required. The property for which to create a ChannelGroup. Example format: properties/1234 |
channel_group |
Required. The ChannelGroup to create. |
CreateConnectedSiteTagRequest
Request message for CreateConnectedSiteTag RPC.
| Fields | |
|---|---|
property |
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 |
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 |
Required. The conversion event to create. |
parent |
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 |
Required. Example format: properties/1234 |
custom_dimension |
Required. The CustomDimension to create. |
CreateCustomMetricRequest
Request message for CreateCustomMetric RPC.
| Fields | |
|---|---|
parent |
Required. Example format: properties/1234 |
custom_metric |
Required. The CustomMetric to create. |
CreateDataStreamRequest
Request message for CreateDataStream RPC.
| Fields | |
|---|---|
parent |
Required. Example format: properties/1234 |
data_stream |
Required. The DataStream to create. |
CreateDisplayVideo360AdvertiserLinkProposalRequest
Request message for CreateDisplayVideo360AdvertiserLinkProposal RPC.
| Fields | |
|---|---|
parent |
Required. Example format: properties/1234 |
display_video_360_advertiser_link_proposal |
Required. The DisplayVideo360AdvertiserLinkProposal to create. |
CreateDisplayVideo360AdvertiserLinkRequest
Request message for CreateDisplayVideo360AdvertiserLink RPC.
| Fields | |
|---|---|
parent |
Required. Example format: properties/1234 |
display_video_360_advertiser_link |
Required. The DisplayVideo360AdvertiserLink to create. |
CreateEventCreateRuleRequest
Request message for CreateEventCreateRule RPC.
| Fields | |
|---|---|
parent |
Required. Example format: properties/123/dataStreams/456 |
event_create_rule |
Required. The EventCreateRule to create. |
CreateEventEditRuleRequest
Request message for CreateEventEditRule RPC.
| Fields | |
|---|---|
parent |
Required. Example format: properties/123/dataStreams/456 |
event_edit_rule |
Required. The EventEditRule to create. |
CreateExpandedDataSetRequest
Request message for CreateExpandedDataSet RPC.
| Fields | |
|---|---|
parent |
Required. Example format: properties/1234 |
expanded_data_set |
Required. The ExpandedDataSet to create. |
CreateFirebaseLinkRequest
Request message for CreateFirebaseLink RPC
| Fields | |
|---|---|
parent |
Required. Format: properties/{property_id} Example: |
firebase_link |
Required. The Firebase link to create. |
CreateGoogleAdsLinkRequest
Request message for CreateGoogleAdsLink RPC
| Fields | |
|---|---|
parent |
Required. Example format: properties/1234 |
google_ads_link |
Required. The GoogleAdsLink to create. |
CreateKeyEventRequest
Request message for CreateKeyEvent RPC
| Fields | |
|---|---|
key_event |
Required. The Key Event to create. |
parent |
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 |
Required. The parent resource where this secret will be created. Format: properties/{property}/dataStreams/{dataStream} |
measurement_protocol_secret |
Required. The measurement protocol secret to create. |
CreatePropertyRequest
Request message for CreateProperty RPC.
| Fields | |
|---|---|
property |
Required. The property to create. Note: the supplied property must specify its parent. |
CreateReportingDataAnnotationRequest
Request message for CreateReportingDataAnnotation RPC.
| Fields | |
|---|---|
parent |
Required. The property for which to create a Reporting Data Annotation. Format: properties/property_id Example: properties/123 |
reporting_data_annotation |
Required. The Reporting Data Annotation to create. |
CreateRollupPropertyRequest
Request message for CreateRollupProperty RPC.
| Fields | |
|---|---|
rollup_property |
Required. The roll-up property to create. |
source_properties[] |
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 |
The created roll-up property. |
rollup_property_source_links[] |
The created roll-up property source links. |
CreateRollupPropertySourceLinkRequest
Request message for CreateRollupPropertySourceLink RPC.
| Fields | |
|---|---|
parent |
Required. Format: properties/{property_id} Example: properties/1234 |
rollup_property_source_link |
Required. The roll-up property source link to create. |
CreateSKAdNetworkConversionValueSchemaRequest
Request message for CreateSKAdNetworkConversionValueSchema RPC.
| Fields | |
|---|---|
parent |
Required. The parent resource where this schema will be created. Format: properties/{property}/dataStreams/{dataStream} |
skadnetwork_conversion_value_schema |
Required. SKAdNetwork conversion value schema to create. |
CreateSearchAds360LinkRequest
Request message for CreateSearchAds360Link RPC.
| Fields | |
|---|---|
parent |
Required. Example format: properties/1234 |
search_ads_360_link |
Required. The SearchAds360Link to create. |
CreateSubpropertyEventFilterRequest
Request message for CreateSubpropertyEventFilter RPC.
| Fields | |
|---|---|
parent |
Required. The ordinary property for which to create a subproperty event filter. Format: properties/property_id Example: properties/123 |
subproperty_event_filter |
Required. The subproperty event filter to create. |
CustomDimension
A definition for a CustomDimension.
| Fields | |
|---|---|
name |
Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} |
parameter_name |
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 |
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 |
Optional. Description for this custom dimension. Max length of 150 characters. |
scope |
Required. Immutable. The scope of this dimension. |
disallow_ads_personalization |
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 |
Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} |
parameter_name |
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 |
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 |
Optional. Description for this custom dimension. Max length of 150 characters. |
measurement_unit |
Required. The type for the custom metric's value. |
scope |
Required. Immutable. The scope of this custom metric. |
restricted_metric_type[] |
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 |
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 |
If enabled, any event parameter or user property values that look like an email will be redacted. |
query_parameter_redaction_enabled |
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[] |
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 |
Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings |
event_data_retention |
Required. The length of time that event-level data is retained. |
user_data_retention |
Required. The length of time that user-level data is retained. |
reset_user_data_on_new_activity |
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. Available for event data only. |
THIRTY_EIGHT_MONTHS |
The data retention time duration is 38 months. Available to 360 properties only. Available for event data only. |
FIFTY_MONTHS |
The data retention time duration is 50 months. Available to 360 properties only. Available for event data only. |
DataSharingSettings
A resource message representing data sharing settings of a Google Analytics account.
| Fields | |
|---|---|
name |
Output only. Resource name. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings" |
sharing_with_google_support_enabled |
Allows Google technical support representatives access to your Google Analytics data and account when necessary to provide service and find solutions to technical issues. This field maps to the "Technical support" field in the Google Analytics Admin UI. |
sharing_with_google_assigned_sales_enabled |
Allows Google access to your Google Analytics account data, including account usage and configuration data, product spending, and users associated with your Google Analytics account, so that Google can help you make the most of Google products, providing you with insights, offers, recommendations, and optimization tips across Google Analytics and other Google products for business. This field maps to the "Recommendations for your business" field in the Google Analytics Admin UI. |
sharing_with_google_any_sales_enabled |
Deprecated. This field is no longer used and always returns false. |
sharing_with_google_products_enabled |
Allows Google to use the data to improve other Google products or services. This fields maps to the "Google products & services" field in the Google Analytics Admin UI. |
sharing_with_others_enabled |
Enable features like predictions, modeled data, and benchmarking that can provide you with richer business insights when you contribute aggregated measurement data. The data you share (including information about the property from which it is shared) is aggregated and de-identified before being used to generate business insights. This field maps to the "Modeling contributions & business insights" field in the Google Analytics Admin UI. |
DataStream
A resource message representing a data stream.
| Fields | |
|---|---|
name |
Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" |
type |
Required. Immutable. The type of this DataStream resource. |
display_name |
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 |
Output only. Time when this stream was originally created. |
update_time |
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 |
Data specific to web streams. Must be populated if type is WEB_DATA_STREAM. |
android_app_stream_data |
Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM. |
ios_app_stream_data |
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 |
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 |
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 |
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 |
Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp" |
WebStreamData
Data specific to web streams.
| Fields | |
|---|---|
measurement_id |
Output only. Analytics Measurement ID. Example: "G-1A2BCD345E" |
firebase_app_id |
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 |
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 |
Required. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding} |
DeleteAccountRequest
Request message for DeleteAccount RPC.
| Fields | |
|---|---|
name |
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 |
Required. Unique identifier for the AdSense Link to be deleted. Format: properties/{propertyId}/adSenseLinks/{linkId} Example: properties/1234/adSenseLinks/5678 |
DeleteBigQueryLinkRequest
Request message for DeleteBigQueryLink RPC.
| Fields | |
|---|---|
name |
Required. The BigQueryLink to delete. Example format: properties/1234/bigQueryLinks/5678 |
DeleteCalculatedMetricRequest
Request message for DeleteCalculatedMetric RPC.
| Fields | |
|---|---|
name |
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 |
Required. The ChannelGroup to delete. Example format: properties/1234/channelGroups/5678 |
DeleteConnectedSiteTagRequest
Request message for DeleteConnectedSiteTag RPC.
| Fields | |
|---|---|
property |
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 |
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 |
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 |
Required. The name of the DataStream to delete. Example format: properties/1234/dataStreams/5678 |
DeleteDisplayVideo360AdvertiserLinkProposalRequest
Request message for DeleteDisplayVideo360AdvertiserLinkProposal RPC.
| Fields | |
|---|---|
name |
Required. The name of the DisplayVideo360AdvertiserLinkProposal to delete. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678 |
DeleteDisplayVideo360AdvertiserLinkRequest
Request message for DeleteDisplayVideo360AdvertiserLink RPC.
| Fields | |
|---|---|
name |
Required. The name of the DisplayVideo360AdvertiserLink to delete. Example format: properties/1234/displayVideo360AdvertiserLinks/5678 |
DeleteEventCreateRuleRequest
Request message for DeleteEventCreateRule RPC.
| Fields | |
|---|---|
name |
Required. Example format: properties/123/dataStreams/456/eventCreateRules/789 |
DeleteEventEditRuleRequest
Request message for DeleteEventEditRule RPC.
| Fields | |
|---|---|
name |
Required. Example format: properties/123/dataStreams/456/eventEditRules/789 |
DeleteExpandedDataSetRequest
Request message for DeleteExpandedDataSet RPC.
| Fields | |
|---|---|
name |
Required. Example format: properties/1234/expandedDataSets/5678 |
DeleteFirebaseLinkRequest
Request message for DeleteFirebaseLink RPC
| Fields | |
|---|---|
name |
Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: |
DeleteGoogleAdsLinkRequest
Request message for DeleteGoogleAdsLink RPC.
| Fields | |
|---|---|
name |
Required. Example format: properties/1234/googleAdsLinks/5678 |
DeleteKeyEventRequest
Request message for DeleteKeyEvent RPC
| Fields | |
|---|---|
name |
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 |
Required. The name of the MeasurementProtocolSecret to delete. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} |
DeletePropertyRequest
Request message for DeleteProperty RPC.
| Fields | |
|---|---|
name |
Required. The name of the Property to soft-delete. Format: properties/{property_id} Example: "properties/1000" |
DeleteReportingDataAnnotationRequest
Request message for DeleteReportingDataAnnotation RPC.
| Fields | |
|---|---|
name |
Required. Resource name of the Reporting Data Annotation to delete. Format: properties/property_id/reportingDataAnnotations/reporting_data_annotation Example: properties/123/reportingDataAnnotations/456 |
DeleteRollupPropertySourceLinkRequest
Request message for DeleteRollupPropertySourceLink RPC.
| Fields | |
|---|---|
name |
Required. Format: properties/{property_id}/rollupPropertySourceLinks/{rollup_property_source_link_id} Example: properties/1234/rollupPropertySourceLinks/5678 |
DeleteSKAdNetworkConversionValueSchemaRequest
Request message for DeleteSKAdNetworkConversionValueSchema RPC.
| Fields | |
|---|---|
name |
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 |
Required. The name of the SearchAds360Link to delete. Example format: properties/1234/SearchAds360Links/5678 |
DeleteSubpropertyEventFilterRequest
Request message for DeleteSubpropertyEventFilter RPC.
| Fields | |
|---|---|
name |
Required. Resource name of the subproperty event filter to delete. Format: properties/property_id/subpropertyEventFilters/subproperty_event_filter Example: properties/123/subpropertyEventFilters/456 |
DisplayVideo360AdvertiserLink
A link between a Google Analytics property and a Display & Video 360 advertiser.
| Fields | |
|---|---|
name |
Output only. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID |
advertiser_id |
Immutable. The Display & Video 360 Advertiser's advertiser ID. |
advertiser_display_name |
Output only. The display name of the Display & Video 360 Advertiser. |
ads_personalization_enabled |
Enables personalized advertising features with this integration. If this field is not set on create/update, it will be defaulted to true. |
campaign_data_sharing_enabled |
Immutable. Enables the import of campaign data from Display & Video 360 into the Google Analytics property. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true. |
cost_data_sharing_enabled |
Immutable. Enables the import of cost data from Display & Video 360 into the Google Analytics property. This can only be enabled if |
DisplayVideo360AdvertiserLinkProposal
A proposal for a link between a Google Analytics 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 |
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 |
Immutable. The Display & Video 360 Advertiser's advertiser ID. |
link_proposal_status_details |
Output only. The status information for this link proposal. |
advertiser_display_name |
Output only. The display name of the Display & Video Advertiser. Only populated for proposals that originated from Display & Video 360. |
validation_email |
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 |
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 |
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 |
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 |
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 |
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 |
If enabled, capture scroll events each time a visitor gets to the bottom of a page. |
outbound_clicks_enabled |
If enabled, capture an outbound click event each time a visitor clicks a link that leads them away from your domain. |
site_search_enabled |
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 |
If enabled, capture video play, progress, and complete events as visitors view embedded videos on your site. |
file_downloads_enabled |
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 |
If enabled, capture a page view event each time the website changes the browser history state. |
form_interactions_enabled |
If enabled, capture a form interaction event each time a visitor interacts with a form on your website. False by default. |
search_query_parameter |
Required. URL query parameters to interpret as site search parameters. Max length is 1024 characters. Must not be empty. |
uri_query_parameter |
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 |
Output only. Resource name for this EventCreateRule resource. Format: properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule} |
destination_event |
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[] |
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 |
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[] |
Parameter mutations define parameter behavior on the new event, and are applied in order. A maximum of 20 mutations can be applied. |
EventEditRule
An Event Edit 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 Create rules, Event Edit Rules are applied in their defined order.
Event Edit rules can't be used to modify an event created from an Event Create rule.
| Fields | |
|---|---|
name |
Identifier. Resource name for this EventEditRule resource. Format: properties/{property}/dataStreams/{data_stream}/eventEditRules/{event_edit_rule} |
display_name |
Required. The display name of this event edit rule. Maximum of 255 characters. |
event_conditions[] |
Required. Conditions on the source event must match for this rule to be applied. Must have at least one condition, and can have up to 10 max. |
parameter_mutations[] |
Required. Parameter mutations define parameter behavior on the new event, and are applied in order. A maximum of 20 mutations can be applied. |
processing_order |
Output only. The order for which this rule will be processed. Rules with an order value lower than this will be processed before this rule, rules with an order value higher than this will be processed after this rule. New event edit rules will be assigned an order value at the end of the order. This value does not apply to event create rules. |
EventMapping
Event setting conditions to match an event.
| Fields | |
|---|---|
event_name |
Required. Name of the Google Analytics event. It must always be set. The max allowed display name length is 40 UTF-16 code units. |
min_event_count |
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 |
The maximum number of times the event occurred. If not set, maximum event count won't be checked. |
min_event_value |
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 |
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 an ExpandedDataSet.
| Fields | |
|---|---|
name |
Output only. The resource name for this ExpandedDataSet resource. Format: properties/{property_id}/expandedDataSets/{expanded_data_set} |
display_name |
Required. The display name of the ExpandedDataSet. Max 200 chars. |
description |
Optional. The description of the ExpandedDataSet. Max 50 chars. |
dimension_names[] |
Immutable. The list of dimensions included in the ExpandedDataSet. See the API Dimensions for the list of dimension names. |
metric_names[] |
Immutable. The list of metrics included in the ExpandedDataSet. See the API Metrics for the list of dimension names. |
dimension_filter_expression |
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 |
data_collection_start_time |
Output only. Time when expanded data set began (or will begin) collecing data. |
ExpandedDataSetFilter
A specific filter for a single dimension
| Fields | |
|---|---|
field_name |
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 |
A filter for a string-type dimension that matches a particular pattern. |
in_list_filter |
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[] |
Required. The list of possible string values to match against. Must be non-empty. |
case_sensitive |
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 |
Required. The match type for the string filter. |
value |
Required. The string value to be matched against. |
case_sensitive |
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 |
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 |
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 |
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[] |
A list of ExpandedDataSet filter expressions. |
FetchAutomatedGa4ConfigurationOptOutRequest
Request for fetching the opt out status for the automated GA4 setup process.
| Fields | |
|---|---|
property |
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 |
The opt out status for the UA property. |
FetchConnectedGa4PropertyRequest
Request for looking up GA4 property connected to a UA property.
| Fields | |
|---|---|
property |
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 |
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 |
FirebaseLink
A link between a Google Analytics property and a Firebase project.
| Fields | |
|---|---|
name |
Output only. Example format: properties/1234/firebaseLinks/5678 |
project |
Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234' |
create_time |
Output only. Time when this FirebaseLink was originally created. |
GetAccessBindingRequest
Request message for GetAccessBinding RPC.
| Fields | |
|---|---|
name |
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 |
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 |
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 |
Required. The name of the attribution settings to retrieve. Format: properties/{property}/attributionSettings |
GetAudienceRequest
Request message for GetAudience RPC.
| Fields | |
|---|---|
name |
Required. The name of the Audience to get. Example format: properties/1234/audiences/5678 |
GetBigQueryLinkRequest
Request message for GetBigQueryLink RPC.
| Fields | |
|---|---|
name |
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 |
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 |
Required. The ChannelGroup to get. Example format: properties/1234/channelGroups/5678 |
GetConversionEventRequest
Request message for GetConversionEvent RPC
| Fields | |
|---|---|
name |
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 |
Required. The name of the CustomDimension to get. Example format: properties/1234/customDimensions/5678 |
GetCustomMetricRequest
Request message for GetCustomMetric RPC.
| Fields | |
|---|---|
name |
Required. The name of the CustomMetric to get. Example format: properties/1234/customMetrics/5678 |
GetDataRedactionSettingsRequest
Request message for GetDataRedactionSettings RPC.
| Fields | |
|---|---|
name |
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 |
Required. The name of the settings to lookup. Format: properties/{property}/dataRetentionSettings Example: "properties/1000/dataRetentionSettings" |
GetDataSharingSettingsRequest
Request message for GetDataSharingSettings RPC.
| Fields | |
|---|---|
name |
Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: |
GetDataStreamRequest
Request message for GetDataStream RPC.
| Fields | |
|---|---|
name |
Required. The name of the DataStream to get. Example format: properties/1234/dataStreams/5678 |
GetDisplayVideo360AdvertiserLinkProposalRequest
Request message for GetDisplayVideo360AdvertiserLinkProposal RPC.
| Fields | |
|---|---|
name |
Required. The name of the DisplayVideo360AdvertiserLinkProposal to get. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678 |
GetDisplayVideo360AdvertiserLinkRequest
Request message for GetDisplayVideo360AdvertiserLink RPC.
| Fields | |
|---|---|
name |
Required. The name of the DisplayVideo360AdvertiserLink to get. Example format: properties/1234/displayVideo360AdvertiserLink/5678 |
GetEnhancedMeasurementSettingsRequest
Request message for GetEnhancedMeasurementSettings RPC.
| Fields | |
|---|---|
name |
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 |
Required. The name of the EventCreateRule to get. Example format: properties/123/dataStreams/456/eventCreateRules/789 |
GetEventEditRuleRequest
Request message for GetEventEditRule RPC.
| Fields | |
|---|---|
name |
Required. The name of the EventEditRule to get. Example format: properties/123/dataStreams/456/eventEditRules/789 |
GetExpandedDataSetRequest
Request message for GetExpandedDataSet RPC.
| Fields | |
|---|---|
name |
Required. The name of the ExpandedDataSet to get. Example format: properties/1234/expandedDataSets/5678 |
GetGlobalSiteTagRequest
Request message for GetGlobalSiteTag RPC.
| Fields | |
|---|---|
name |
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: |
GetGoogleSignalsSettingsRequest
Request message for GetGoogleSignalsSettings RPC
| Fields | |
|---|---|
name |
Required. The name of the google signals settings to retrieve. Format: properties/{property}/googleSignalsSettings |
GetKeyEventRequest
Request message for GetKeyEvent RPC
| Fields | |
|---|---|
name |
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 |
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 |
Required. The name of the property to lookup. Format: properties/{property_id} Example: "properties/1000" |
GetReportingDataAnnotationRequest
Request message for GetReportingDataAnnotation RPC.
| Fields | |
|---|---|
name |
Required. Resource name of the Reporting Data Annotation to lookup. Format: properties/property_id/reportingDataAnnotations/reportingDataAnnotation Example: properties/123/reportingDataAnnotations/456 |
GetRollupPropertySourceLinkRequest
Request message for GetRollupPropertySourceLink RPC.
| Fields | |
|---|---|
name |
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 |
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 |
Required. The name of the SearchAds360Link to get. Example format: properties/1234/SearchAds360Link/5678 |
GetSubpropertyEventFilterRequest
Request message for GetSubpropertyEventFilter RPC.
| Fields | |
|---|---|
name |
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 |
Output only. Resource name for this GlobalSiteTag resource. Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag Example: "properties/123/dataStreams/456/globalSiteTag" |
snippet |
Immutable. JavaScript code snippet to be pasted as the first item into the head tag of every webpage to measure. |
GoogleAdsLink
A link between a Google Analytics property and a Google Ads account.
| Fields | |
|---|---|
name |
Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. |
customer_id |
Immutable. Google Ads customer ID. |
can_manage_clients |
Output only. If true, this link is for a Google Ads manager account. |
ads_personalization_enabled |
Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true. |
create_time |
Output only. Time when this link was originally created. |
update_time |
Output only. Time when this link was last updated. |
creator_email_address |
Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved. |
GoogleSignalsConsent
Consent field of the Google Signals settings.
| Enums | |
|---|---|
GOOGLE_SIGNALS_CONSENT_UNSPECIFIED |
Google Signals consent value defaults to GOOGLE_SIGNALS_CONSENT_UNSPECIFIED. This will be treated as GOOGLE_SIGNALS_CONSENT_NOT_CONSENTED. |
GOOGLE_SIGNALS_CONSENT_CONSENTED |
Terms of service have been accepted |
GOOGLE_SIGNALS_CONSENT_NOT_CONSENTED |
Terms of service have not been accepted |
GoogleSignalsSettings
Settings values for Google Signals. This is a singleton resource.
| Fields | |
|---|---|
name |
Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: "properties/1000/googleSignalsSettings" |
state |
Status of this setting. |
consent |
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 |
Required. Customer defined display name for the channel. |
expression |
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 |
Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event} |
event_name |
Immutable. The event name for this key event. Examples: 'click', 'purchase' |
create_time |
Output only. Time when this key event was created in the property. |
deletable |
Output only. If set to true, this event can be deleted. |
custom |
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 |
Required. The method by which Key Events will be counted across multiple events within a session. |
default_value |
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 |
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 |
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 | |
|---|---|
LINK_PROPOSAL_INITIATING_PRODUCT_UNSPECIFIED |
Unspecified product. |
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 | |
|---|---|
LINK_PROPOSAL_STATE_UNSPECIFIED |
Unspecified state |
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 | |
|---|---|
link_proposal_initiating_product |
Output only. The source of this proposal. |
requestor_email |
Output only. The email address of the user that proposed this linkage. |
link_proposal_state |
Output only. The state of this proposal. |
ListAccessBindingsRequest
Request message for ListAccessBindings RPC.
| Fields | |
|---|---|
parent |
Required. Formats: - accounts/{account} - properties/{property} |
page_size |
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 |
A page token, received from a previous |
ListAccessBindingsResponse
Response message for ListAccessBindings RPC.
| Fields | |
|---|---|
access_bindings[] |
List of AccessBindings. These will be ordered stably, but in an arbitrary order. |
next_page_token |
A token, which can be sent as |
ListAccountSummariesRequest
Request message for ListAccountSummaries RPC.
| Fields | |
|---|---|
page_size |
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 |
A page token, received from a previous |
ListAccountSummariesResponse
Response message for ListAccountSummaries RPC.
| Fields | |
|---|---|
account_summaries[] |
Account summaries of all accounts the caller has access to. |
next_page_token |
A token, which can be sent as |
ListAccountsRequest
Request message for ListAccounts RPC.
| Fields | |
|---|---|
page_size |
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 |
A page token, received from a previous |
show_deleted |
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[] |
Results that were accessible to the caller. |
next_page_token |
A token, which can be sent as |
ListAdSenseLinksRequest
Request message to be passed to ListAdSenseLinks method.
| Fields | |
|---|---|
parent |
Required. Resource name of the parent property. Format: properties/{propertyId} Example: properties/1234 |
page_size |
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 |
A page token received from a previous When paginating, all other parameters provided to |
ListAdSenseLinksResponse
Response message for ListAdSenseLinks method.
| Fields | |
|---|---|
adsense_links[] |
List of AdSenseLinks. |
next_page_token |
A token, which can be sent as |
ListAudiencesRequest
Request message for ListAudiences RPC.
| Fields | |
|---|---|
parent |
Required. Example format: properties/1234 |
page_size |
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 |
A page token, received from a previous When paginating, all other parameters provided to |
ListAudiencesResponse
Response message for ListAudiences RPC.
| Fields | |
|---|---|
audiences[] |
List of Audiences. |
next_page_token |
A token, which can be sent as |
ListBigQueryLinksRequest
Request message for ListBigQueryLinks RPC.
| Fields | |
|---|---|
parent |
Required. The name of the property to list BigQuery links under. Format: properties/{property_id} Example: properties/1234 |
page_size |
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 |
A page token, received from a previous |
ListBigQueryLinksResponse
Response message for ListBigQueryLinks RPC
| Fields | |
|---|---|
bigquery_links[] |
List of BigQueryLinks. |
next_page_token |
A token, which can be sent as |
ListCalculatedMetricsRequest
Request message for ListCalculatedMetrics RPC.
| Fields | |
|---|---|
parent |
Required. Example format: properties/1234 |
page_size |
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 |
Optional. A page token, received from a previous When paginating, all other parameters provided to |
ListCalculatedMetricsResponse
Response message for ListCalculatedMetrics RPC.
| Fields | |
|---|---|
calculated_metrics[] |
List of CalculatedMetrics. |
next_page_token |
A token, which can be sent as |
ListChannelGroupsRequest
Request message for ListChannelGroups RPC.
| Fields | |
|---|---|
parent |
Required. The property for which to list ChannelGroups. Example format: properties/1234 |
page_size |
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 |
A page token, received from a previous When paginating, all other parameters provided to |
ListChannelGroupsResponse
Response message for ListChannelGroups RPC.
| Fields | |
|---|---|
channel_groups[] |
List of ChannelGroup. These will be ordered stably, but in an arbitrary order. |
next_page_token |
A token, which can be sent as |
ListConnectedSiteTagsRequest
Request message for ListConnectedSiteTags RPC.
| Fields | |
|---|---|
property |
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: |
ListConnectedSiteTagsResponse
Response message for ListConnectedSiteTags RPC.
| Fields | |
|---|---|
connected_site_tags[] |
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 |
Required. The resource name of the parent property. Example: 'properties/123' |
page_size |
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 |
A page token, received from a previous |
ListConversionEventsResponse
Response message for ListConversionEvents RPC.
| Fields | |
|---|---|
conversion_events[] |
The requested conversion events |
next_page_token |
A token, which can be sent as |
ListCustomDimensionsRequest
Request message for ListCustomDimensions RPC.
| Fields | |
|---|---|
parent |
Required. Example format: properties/1234 |
page_size |
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 |
A page token, received from a previous When paginating, all other parameters provided to |
ListCustomDimensionsResponse
Response message for ListCustomDimensions RPC.
| Fields | |
|---|---|
custom_dimensions[] |
List of CustomDimensions. |
next_page_token |
A token, which can be sent as |
ListCustomMetricsRequest
Request message for ListCustomMetrics RPC.
| Fields | |
|---|---|
parent |
Required. Example format: properties/1234 |
page_size |
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 |
A page token, received from a previous When paginating, all other parameters provided to |
ListCustomMetricsResponse
Response message for ListCustomMetrics RPC.
| Fields | |
|---|---|
custom_metrics[] |
List of CustomMetrics. |
next_page_token |
A token, which can be sent as |
ListDataStreamsRequest
Request message for ListDataStreams RPC.
| Fields | |
|---|---|
parent |
Required. Example format: properties/1234 |
page_size |
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 |
A page token, received from a previous When paginating, all other parameters provided to |
ListDataStreamsResponse
Response message for ListDataStreams RPC.
| Fields | |
|---|---|
data_streams[] |
List of DataStreams. |
next_page_token |
A token, which can be sent as |
ListDisplayVideo360AdvertiserLinkProposalsRequest
Request message for ListDisplayVideo360AdvertiserLinkProposals RPC.
| Fields | |
|---|---|
parent |
Required. Example format: properties/1234 |
page_size |
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 |
A page token, received from a previous When paginating, all other parameters provided to |
ListDisplayVideo360AdvertiserLinkProposalsResponse
Response message for ListDisplayVideo360AdvertiserLinkProposals RPC.
| Fields | |
|---|---|
display_video_360_advertiser_link_proposals[] |
List of DisplayVideo360AdvertiserLinkProposals. |
next_page_token |
A token, which can be sent as |
ListDisplayVideo360AdvertiserLinksRequest
Request message for ListDisplayVideo360AdvertiserLinks RPC.
| Fields | |
|---|---|
parent |
Required. Example format: properties/1234 |
page_size |
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 |
A page token, received from a previous When paginating, all other parameters provided to |
ListDisplayVideo360AdvertiserLinksResponse
Response message for ListDisplayVideo360AdvertiserLinks RPC.
| Fields | |
|---|---|
display_video_360_advertiser_links[] |
List of DisplayVideo360AdvertiserLinks. |
next_page_token |
A token, which can be sent as |
ListEventCreateRulesRequest
Request message for ListEventCreateRules RPC.
| Fields | |
|---|---|
parent |
Required. Example format: properties/123/dataStreams/456 |
page_size |
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 |
A page token, received from a previous When paginating, all other parameters provided to |
ListEventCreateRulesResponse
Response message for ListEventCreateRules RPC.
| Fields | |
|---|---|
event_create_rules[] |
List of EventCreateRules. These will be ordered stably, but in an arbitrary order. |
next_page_token |
A token, which can be sent as |
ListEventEditRulesRequest
Request message for ListEventEditRules RPC.
| Fields | |
|---|---|
parent |
Required. Example format: properties/123/dataStreams/456 |
page_size |
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 |
Optional. A page token, received from a previous When paginating, all other parameters provided to |
ListEventEditRulesResponse
Response message for ListEventEditRules RPC.
| Fields | |
|---|---|
event_edit_rules[] |
List of EventEditRules. These will be ordered stably, but in an arbitrary order. |
next_page_token |
A token, which can be sent as |
ListExpandedDataSetsRequest
Request message for ListExpandedDataSets RPC.
| Fields | |
|---|---|
parent |
Required. Example format: properties/1234 |
page_size |
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 |
A page token, received from a previous When paginating, all other parameters provided to |
ListExpandedDataSetsResponse
Response message for ListExpandedDataSets RPC.
| Fields | |
|---|---|
expanded_data_sets[] |
List of ExpandedDataSet. These will be ordered stably, but in an arbitrary order. |
next_page_token |
A token, which can be sent as |
ListFirebaseLinksRequest
Request message for ListFirebaseLinks RPC
| Fields | |
|---|---|
parent |
Required. Format: properties/{property_id} Example: |
page_size |
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 |
A page token, received from a previous |
ListFirebaseLinksResponse
Response message for ListFirebaseLinks RPC
| Fields | |
|---|---|
firebase_links[] |
List of FirebaseLinks. This will have at most one value. |
next_page_token |
A token, which can be sent as |
ListGoogleAdsLinksRequest
Request message for ListGoogleAdsLinks RPC.
| Fields | |
|---|---|
parent |
Required. Example format: properties/1234 |
page_size |
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 |
A page token, received from a previous When paginating, all other parameters provided to |
ListGoogleAdsLinksResponse
Response message for ListGoogleAdsLinks RPC.
| Fields | |
|---|---|
google_ads_links[] |
List of GoogleAdsLinks. |
next_page_token |
A token, which can be sent as |
ListKeyEventsRequest
Request message for ListKeyEvents RPC
| Fields | |
|---|---|
parent |
Required. The resource name of the parent property. Example: 'properties/123' |
page_size |
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 |
A page token, received from a previous |
ListKeyEventsResponse
Response message for ListKeyEvents RPC.
| Fields | |
|---|---|
key_events[] |
The requested Key Events |
next_page_token |
A token, which can be sent as |
ListMeasurementProtocolSecretsRequest
Request message for ListMeasurementProtocolSecret RPC
| Fields | |
|---|---|
parent |
Required. The resource name of the parent stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets |
page_size |
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 |
A page token, received from a previous |
ListMeasurementProtocolSecretsResponse
Response message for ListMeasurementProtocolSecret RPC
| Fields | |
|---|---|
measurement_protocol_secrets[] |
A list of secrets for the parent stream specified in the request. |
next_page_token |
A token, which can be sent as |
ListPropertiesRequest
Request message for ListProperties RPC.
| Fields | |
|---|---|
filter |
Required. An expression for filtering the results of the request. Fields eligible for filtering are: |
page_size |
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 |
A page token, received from a previous |
show_deleted |
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[] |
Results that matched the filter criteria and were accessible to the caller. |
next_page_token |
A token, which can be sent as |
ListReportingDataAnnotationsRequest
Request message for ListReportingDataAnnotation RPC.
| Fields | |
|---|---|
parent |
Required. Resource name of the property. Format: properties/property_id Example: properties/123 |
filter |
Optional. Filter that restricts which reporting data annotations under the parent property are listed. Supported fields are:
Additionally, this API provides the following helper functions:
Supported operations:
Examples:
|
page_size |
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 |
Optional. A page token, received from a previous |
ListReportingDataAnnotationsResponse
Response message for ListReportingDataAnnotation RPC.
| Fields | |
|---|---|
reporting_data_annotations[] |
List of Reporting Data Annotations. |
next_page_token |
A token, which can be sent as |
ListRollupPropertySourceLinksRequest
Request message for ListRollupPropertySourceLinks RPC.
| Fields | |
|---|---|
parent |
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 |
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 |
Optional. A page token, received from a previous |
ListRollupPropertySourceLinksResponse
Response message for ListRollupPropertySourceLinks RPC.
| Fields | |
|---|---|
rollup_property_source_links[] |
List of RollupPropertySourceLinks. |
next_page_token |
A token, which can be sent as |
ListSKAdNetworkConversionValueSchemasRequest
Request message for ListSKAdNetworkConversionValueSchemas RPC
| Fields | |
|---|---|
parent |
Required. The DataStream resource to list schemas for. Format: properties/{property_id}/dataStreams/{dataStream} Example: properties/1234/dataStreams/5678 |
page_size |
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 |
A page token, received from a previous |
ListSKAdNetworkConversionValueSchemasResponse
Response message for ListSKAdNetworkConversionValueSchemas RPC
| Fields | |
|---|---|
skadnetwork_conversion_value_schemas[] |
List of SKAdNetworkConversionValueSchemas. This will have at most one value. |
next_page_token |
A token, which can be sent as |
ListSearchAds360LinksRequest
Request message for ListSearchAds360Links RPC.
| Fields | |
|---|---|
parent |
Required. Example format: properties/1234 |
page_size |
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 |
A page token, received from a previous When paginating, all other parameters provided to |
ListSearchAds360LinksResponse
Response message for ListSearchAds360Links RPC.
| Fields | |
|---|---|
search_ads_360_links[] |
List of SearchAds360Links. |
next_page_token |
A token, which can be sent as |
ListSubpropertyEventFiltersRequest
Request message for ListSubpropertyEventFilters RPC.
| Fields | |
|---|---|
parent |
Required. Resource name of the ordinary property. Format: properties/property_id Example: properties/123 |
page_size |
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 |
Optional. A page token, received from a previous |
ListSubpropertyEventFiltersResponse
Response message for ListSubpropertyEventFilter RPC.
| Fields | |
|---|---|
subproperty_event_filters[] |
List of subproperty event filters. |
next_page_token |
A token, which can be sent as |
MatchingCondition
Defines a condition for when an Event Edit or Event Creation rule applies to an event.
| Fields | |
|---|---|
field |
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 |
Required. The type of comparison to be applied to the value. |
value |
Required. The value being compared against for this condition. The runtime implementation may perform type coercion of this value to evaluate this condition based on the type of the parameter value. |
negated |
Whether or not the result of the comparison should be negated. For example, if |
ComparisonType
Comparison type for matching condition
| Enums | |
|---|---|
COMPARISON_TYPE_UNSPECIFIED |
Unknown |
EQUALS |
Equals, case sensitive |
EQUALS_CASE_INSENSITIVE |
Equals, case insensitive |
CONTAINS |
Contains, case sensitive |
CONTAINS_CASE_INSENSITIVE |
Contains, case insensitive |
STARTS_WITH |
Starts with, case sensitive |
STARTS_WITH_CASE_INSENSITIVE |
Starts with, case insensitive |
ENDS_WITH |
Ends with, case sensitive |
ENDS_WITH_CASE_INSENSITIVE |
Ends with, case insensitive |
GREATER_THAN |
Greater than |
GREATER_THAN_OR_EQUAL |
Greater than or equal |
LESS_THAN |
Less than |
LESS_THAN_OR_EQUAL |
Less than or equal |
REGULAR_EXPRESSION |
regular expression. Only supported for web streams. |
REGULAR_EXPRESSION_CASE_INSENSITIVE |
regular expression, case insensitive. Only supported for web streams. |
MeasurementProtocolSecret
A secret value used for sending hits to Measurement Protocol.
| Fields | |
|---|---|
name |
Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} |
display_name |
Required. Human-readable display name for this secret. |
secret_value |
Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property. |
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 |
Integer value |
double_value |
Double value |
ParameterMutation
Defines an event parameter to mutate.
| Fields | |
|---|---|
parameter |
Required. The name of the parameter to mutate. This value must: * be less than 40 characters. * be unique across across all mutations within the rule * consist only of letters, digits or _ (underscores) For event edit rules, the name may also be set to 'event_name' to modify the event_name in place. |
parameter_value |
Required. The value mutation to perform. * Must be less than 100 characters. * To specify a constant value for the param, use the value's string. * To copy value from another parameter, use syntax like "[[other_parameter]]" For more details, see this help center article. |
PostbackWindow
Settings for a SKAdNetwork conversion postback window.
| Fields | |
|---|---|
conversion_values[] |
Ordering of the repeated field will be used to prioritize the conversion value settings. Lower indexed entries are prioritized higher. The first conversion value setting that evaluates to true will be selected. It must have at least one entry if enable_postback_window_settings is set to true. It can have maximum of 128 entries. |
postback_window_settings_enabled |
If enable_postback_window_settings is true, conversion_values must be populated and will be used for determining when and how to set the Conversion Value on a client device and exporting schema to linked Ads accounts. If false, the settings are not used, but are retained in case they may be used in the future. This must always be true for postback_window_one. |
Property
A resource message representing a Google Analytics property.
| Fields | |
|---|---|
name |
Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" |
property_type |
Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. |
create_time |
Output only. Time when the entity was originally created. |
update_time |
Output only. Time when entity payload fields were last updated. |
parent |
Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101" |
display_name |
Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units. |
industry_category |
Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK |
time_zone |
Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes. NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: "America/Los_Angeles" |
currency_code |
The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY" |
service_level |
Output only. The Google Analytics service level that applies to this property. |
delete_time |
Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can. |
expire_time |
Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted. |
account |
Immutable. The resource name of the parent account Format: accounts/{account_id} Example: "accounts/123" |
PropertySummary
A virtual resource representing metadata for a Google Analytics property.
| Fields | |
|---|---|
property |
Resource name of property referred to by this property summary Format: properties/{property_id} Example: "properties/1000" |
display_name |
Display name for the property referred to in this property summary. |
property_type |
The property's property type. |
parent |
Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/200" |
PropertyType
Types of Property resources.
| Enums | |
|---|---|
PROPERTY_TYPE_UNSPECIFIED |
Unknown or unspecified property type |
PROPERTY_TYPE_ORDINARY |
Ordinary Google Analytics property |
PROPERTY_TYPE_SUBPROPERTY |
Google Analytics subproperty |
PROPERTY_TYPE_ROLLUP |
Google Analytics rollup property |
ProvisionAccountTicketRequest
Request message for ProvisionAccountTicket RPC.
| Fields | |
|---|---|
account |
The account to create. |
redirect_uri |
Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in Cloud Console as a Redirect URI. |
ProvisionAccountTicketResponse
Response message for ProvisionAccountTicket RPC.
| Fields | |
|---|---|
account_ticket_id |
The param to be passed in the ToS link. |
ProvisionSubpropertyRequest
Request message for CreateSubproperty RPC.
| Fields | |
|---|---|
subproperty |
Required. The subproperty to create. |
subproperty_event_filter |
Optional. The subproperty event filter to create on an ordinary property. |
ProvisionSubpropertyResponse
Response message for ProvisionSubproperty RPC.
| Fields | |
|---|---|
subproperty |
The created subproperty. |
subproperty_event_filter |
The created subproperty event filter. |
ReorderEventEditRulesRequest
Request message for ReorderEventEditRules RPC.
| Fields | |
|---|---|
parent |
Required. Example format: properties/123/dataStreams/456 |
event_edit_rules[] |
Required. EventEditRule resource names for the specified data stream, in the needed processing order. All EventEditRules for the stream must be present in the list. |
ReportingDataAnnotation
A Reporting Data Annotation is a comment connected to certain dates for reporting data.
| Fields | |
|---|---|
name |
Required. Identifier. Resource name of this Reporting Data Annotation. Format: 'properties/{property_id}/reportingDataAnnotations/{reporting_data_annotation}' Format: 'properties/123/reportingDataAnnotations/456' |
title |
Required. Human-readable title for this Reporting Data Annotation. |
description |
Optional. Description for this Reporting Data Annotation. |
color |
Required. The color used for display of this Reporting Data Annotation. |
system_generated |
Output only. If true, this annotation was generated by the Google Analytics system. System-generated annotations cannot be updated or deleted. |
Union field target. Target for this Reporting Data Annotation target can be only one of the following: |
|
annotation_date |
If set, the Reporting Data Annotation is for a specific date represented by this field. The date must be a valid date with year, month and day set. The date may be in the past, present, or future. |
annotation_date_range |
If set, the Reporting Data Annotation is for a range of dates represented by this field. |
Color
Colors that may be used for this Reporting Data Annotation
| Enums | |
|---|---|
COLOR_UNSPECIFIED |
Color unknown or not specified. |
PURPLE |
Purple color. |
BROWN |
Brown color. |
BLUE |
Blue color. |
GREEN |
Green color. |
RED |
Red color. |
CYAN |
Cyan color. |
ORANGE |
Orange color. (Only used for system-generated annotations) |
DateRange
Represents a Reporting Data Annotation's date range, both start and end dates are inclusive. Time zones are based on the parent property.
| Fields | |
|---|---|
start_date |
Required. The start date for this range. Must be a valid date with year, month, and day set. The date may be in the past, present, or future. |
end_date |
Required. The end date for this range. Must be a valid date with year, month, and day set. This date must be greater than or equal to the start date. |
RollupPropertySourceLink
A link that references a source property under the parent rollup property.
| Fields | |
|---|---|
name |
Output only. Resource name of this RollupPropertySourceLink. Format: 'properties/{property_id}/rollupPropertySourceLinks/{rollup_property_source_link}' Format: 'properties/123/rollupPropertySourceLinks/456' |
source_property |
Immutable. Resource name of the source property. Format: properties/{property_id} Example: "properties/789" |
RunAccessReportRequest
The request for a Data Access Record Report.
| Fields | |
|---|---|
entity |
The Data Access Report supports requesting at the property level or account level. If requested at the account level, Data Access Reports include all access for all properties under that account. To request at the property level, entity should be for example 'properties/123' if "123" is your Google Analytics property ID. To request at the account level, entity should be for example 'accounts/1234' if "1234" is your Google Analytics Account ID. |
dimensions[] |
The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions. |
metrics[] |
The metrics requested and displayed in the response. Requests are allowed up to 10 metrics. |
date_ranges[] |
Date ranges of access records to read. If multiple date ranges are requested, each response row will contain a zero based date range index. If two date ranges overlap, the access records for the overlapping days is included in the response rows for both date ranges. Requests are allowed up to 2 date ranges. |
dimension_filter |
Dimension filters let you restrict report response to specific dimension values which match the filter. For example, filtering on access records of a single user. To learn more, see Fundamentals of Dimension Filters for examples. Metrics cannot be used in this filter. |
metric_filter |
Metric filters allow you to restrict report response to specific metric values which match the filter. Metric filters are applied after aggregating the report's rows, similar to SQL having-clause. Dimensions cannot be used in this filter. |
offset |
The row count of the start row. The first row is counted as row 0. If offset is unspecified, it is treated as 0. If offset is zero, then this method will return the first page of results with To learn more about this pagination parameter, see Pagination. |
limit |
The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. The API may return fewer rows than the requested To learn more about this pagination parameter, see Pagination. |
time_zone |
This request's time zone if specified. If unspecified, the property's time zone is used. The request's time zone is used to interpret the start & end dates of the report. Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example "America/New_York" or "Asia/Tokyo". |
order_bys[] |
Specifies how rows are ordered in the response. |
return_entity_quota |
Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in AccessQuota. For account-level requests, this field must be false. |
include_all_users |
Optional. Determines whether to include users who have never made an API call in the response. If true, all users with access to the specified property or account are included in the response, regardless of whether they have made an API call or not. If false, only the users who have made an API call will be included. |
expand_groups |
Optional. Decides whether to return the users within user groups. This field works only when include_all_users is set to true. If true, it will return all users with access to the specified property or account. If false, only the users with direct access will be returned. |
RunAccessReportResponse
The customized Data Access Record Report response.
| Fields | |
|---|---|
dimension_headers[] |
The header for a column in the report that corresponds to a specific dimension. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows. |
metric_headers[] |
The header for a column in the report that corresponds to a specific metric. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows. |
rows[] |
Rows of dimension value combinations and metric values in the report. |
row_count |
The total number of rows in the query result. To learn more about this pagination parameter, see Pagination. |
quota |
The quota state for this Analytics property including this request. This field doesn't work with account-level requests. |
SKAdNetworkConversionValueSchema
SKAdNetwork conversion value schema of an iOS stream.
| Fields | |
|---|---|
name |
Output only. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema |
postback_window_one |
Required. The conversion value settings for the first postback window. These differ from values for postback window two and three in that they contain a "Fine" grained conversion value (a numeric value). Conversion values for this postback window must be set. The other windows are optional and may inherit this window's settings if unset or disabled. |
postback_window_two |
The conversion value settings for the second postback window. This field should only be configured if there is a need to define different conversion values for this postback window. If enable_postback_window_settings is set to false for this postback window, the values from postback_window_one will be used. |
postback_window_three |
The conversion value settings for the third postback window. This field should only be set if the user chose to define different conversion values for this postback window. It is allowed to configure window 3 without setting window 2. In case window 1 & 2 settings are set and enable_postback_window_settings for this postback window is set to false, the schema will inherit settings from postback_window_two. |
apply_conversion_values |
If enabled, the GA SDK will set conversion values using this schema definition, and schema will be exported to any Google Ads accounts linked to this property. If disabled, the GA SDK will not automatically set conversion values, and also the schema will not be exported to Ads. |
SearchAds360Link
A link between a Google Analytics property and a Search Ads 360 entity.
| Fields | |
|---|---|
name |
Output only. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID |
advertiser_id |
Immutable. This field represents the Advertiser ID of the Search Ads 360 Advertiser. that has been linked. |
campaign_data_sharing_enabled |
Immutable. Enables the import of campaign data from Search Ads 360 into the Google Analytics property. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. |
cost_data_sharing_enabled |
Immutable. Enables the import of cost data from Search Ads 360 to the Google Analytics property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. |
advertiser_display_name |
Output only. The display name of the Search Ads 360 Advertiser. Allows users to easily identify the linked resource. |
ads_personalization_enabled |
Enables personalized advertising features with this integration. If this field is not set on create, it will be defaulted to true. |
site_stats_sharing_enabled |
Enables export of site stats with this integration. If this field is not set on create, it will be defaulted to true. |
SearchChangeHistoryEventsRequest
Request message for SearchChangeHistoryEvents RPC.
| Fields | |
|---|---|
account |
Required. The account resource for which to return change history resources. Format: accounts/{account} Example: |
property |
Optional. Resource name for a child property. If set, only return changes made to this property or its child resources. Format: properties/{propertyId} Example: |
resource_type[] |
Optional. If set, only return changes if they are for a resource that matches at least one of these types. |
action[] |
Optional. If set, only return changes that match one or more of these types of actions. |
actor_email[] |
Optional. If set, only return changes if they are made by a user in this list. |
earliest_change_time |
Optional. If set, only return changes made after this time (inclusive). |
latest_change_time |
Optional. If set, only return changes made before this time (inclusive). |
page_size |
Optional. The maximum number of ChangeHistoryEvent items to return. If unspecified, at most 50 items will be returned. The maximum value is 200 (higher values will be coerced to the maximum). Note that the service may return a page with fewer items than this value specifies (potentially even zero), and that there still may be additional pages. If you want a particular number of items, you'll need to continue requesting additional pages using |
page_token |
Optional. A page token, received from a previous |
SearchChangeHistoryEventsResponse
Response message for SearchAccounts RPC.
| Fields | |
|---|---|
change_history_events[] |
Results that were accessible to the caller. |
next_page_token |
A token, which can be sent as |
ServiceLevel
Various levels of service for Google Analytics.
| Enums | |
|---|---|
SERVICE_LEVEL_UNSPECIFIED |
Service level not specified or invalid. |
GOOGLE_ANALYTICS_STANDARD |
The standard version of Google Analytics. |
GOOGLE_ANALYTICS_360 |
The paid, premium version of Google Analytics. |
SetAutomatedGa4ConfigurationOptOutRequest
Request for setting the opt out status for the automated GA4 setup process.
| Fields | |
|---|---|
property |
Required. The UA property to set 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 |
opt_out |
The status to set. |
SetAutomatedGa4ConfigurationOptOutResponse
This type has no fields.
Response message for setting the opt out status for the automated GA4 setup process.
SubpropertyEventFilter
A resource message representing a Google Analytics subproperty event filter.
| Fields | |
|---|---|
name |
Output only. Format: properties/{ordinary_property_id}/subpropertyEventFilters/{sub_property_event_filter} Example: properties/1234/subpropertyEventFilters/5678 |
filter_clauses[] |
Required. Unordered list. Filter clauses that define the SubpropertyEventFilter. All clauses are AND'ed together to determine what data is sent to the subproperty. |
apply_to_property |
Immutable. Resource name of the Subproperty that uses this filter. |
SubpropertyEventFilterClause
A clause for defining a filter. A filter may be inclusive (events satisfying the filter clause are included in the subproperty's data) or exclusive (events satisfying the filter clause are excluded from the subproperty's data).
| Fields | |
|---|---|
filter_clause_type |
Required. The type for the filter clause. |
filter_expression |
Required. The logical expression for what events are sent to the subproperty. |
FilterClauseType
Specifies whether this is an include or exclude filter clause.
| Enums | |
|---|---|
FILTER_CLAUSE_TYPE_UNSPECIFIED |
Filter clause type unknown or not specified. |
INCLUDE |
Events will be included in the Sub property if the filter clause is met. |
EXCLUDE |
Events will be excluded from the Sub property if the filter clause is met. |
SubpropertyEventFilterCondition
A specific filter expression
| Fields | |
|---|---|
field_name |
Required. The field that is being filtered. |
Union field
|
|
null_filter |
A filter for null values. |
string_filter |
A filter for a string-type dimension that matches a particular pattern. |
StringFilter
A filter for a string-type dimension that matches a particular pattern.
| Fields | |
|---|---|
match_type |
Required. The match type for the string filter. |
value |
Required. The string value used for the matching. |
case_sensitive |
Optional. If true, the string value is case sensitive. If false, the match is case-insensitive. |
MatchType
How the filter will be used to determine a match.
| Enums | |
|---|---|
MATCH_TYPE_UNSPECIFIED |
Match type unknown or not specified. |
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. |
PARTIAL_REGEXP |
Partial regular expression matches with the string value. |
SubpropertyEventFilterExpression
A logical expression of Subproperty event filters.
| Fields | |
|---|---|
Union field expr. The expression applied to a filter. expr can be only one of the following: |
|
or_group |
A list of expressions to OR’ed together. Must only contain not_expression or filter_condition expressions. |
not_expression |
A filter expression to be NOT'ed (inverted, complemented). It can only include a filter. This cannot be set on the top level SubpropertyEventFilterExpression. |
filter_condition |
Creates a filter that matches a specific event. This cannot be set on the top level SubpropertyEventFilterExpression. |
SubpropertyEventFilterExpressionList
A list of Subproperty event filter expressions.
| Fields | |
|---|---|
filter_expressions[] |
Required. Unordered list. A list of Subproperty event filter expressions |
UpdateAccessBindingRequest
Request message for UpdateAccessBinding RPC.
| Fields | |
|---|---|
access_binding |
Required. The access binding to update. |
UpdateAccountRequest
Request message for UpdateAccount RPC.
| Fields | |
|---|---|
account |
Required. The account to update. The account's |
update_mask |
Required. The list of fields to be updated. Field names must be in snake case (for example, "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. |
UpdateAttributionSettingsRequest
Request message for UpdateAttributionSettings RPC
| Fields | |
|---|---|
attribution_settings |
Required. The attribution settings to update. The |
update_mask |
Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. |
UpdateAudienceRequest
Request message for UpdateAudience RPC.
| Fields | |
|---|---|
audience |
Required. The audience to update. The audience's |
update_mask |
Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. |
UpdateBigQueryLinkRequest
Request message for UpdateBigQueryLink RPC.
| Fields | |
|---|---|
bigquery_link |
Required. The settings to update. The |
update_mask |
Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. |
UpdateCalculatedMetricRequest
Request message for UpdateCalculatedMetric RPC.
| Fields | |
|---|---|
calculated_metric |
Required. The CalculatedMetric to update |
update_mask |
Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. |
UpdateChannelGroupRequest
Request message for UpdateChannelGroup RPC.
| Fields | |
|---|---|
channel_group |
Required. The ChannelGroup to update. The resource's |
update_mask |
Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. |
UpdateConversionEventRequest
Request message for UpdateConversionEvent RPC
| Fields | |
|---|---|
conversion_event |
Required. The conversion event to update. The |
update_mask |
Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. |
UpdateCustomDimensionRequest
Request message for UpdateCustomDimension RPC.
| Fields | |
|---|---|
custom_dimension |
The CustomDimension to update |
update_mask |
Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. |
UpdateCustomMetricRequest
Request message for UpdateCustomMetric RPC.
| Fields | |
|---|---|
custom_metric |
The CustomMetric to update |
update_mask |
Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. |
UpdateDataRedactionSettingsRequest
Request message for UpdateDataRedactionSettings RPC.
| Fields | |
|---|---|
data_redaction_settings |
Required. The settings to update. The |
update_mask |
Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. |
UpdateDataRetentionSettingsRequest
Request message for UpdateDataRetentionSettings RPC.
| Fields | |
|---|---|
data_retention_settings |
Required. The settings to update. The |
update_mask |
Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. |
UpdateDataStreamRequest
Request message for UpdateDataStream RPC.
| Fields | |
|---|---|
data_stream |
The DataStream to update |
update_mask |
Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. |
UpdateDisplayVideo360AdvertiserLinkRequest
Request message for UpdateDisplayVideo360AdvertiserLink RPC.
| Fields | |
|---|---|
display_video_360_advertiser_link |
The DisplayVideo360AdvertiserLink to update |
update_mask |
Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. |
UpdateEnhancedMeasurementSettingsRequest
Request message for UpdateEnhancedMeasurementSettings RPC.
| Fields | |
|---|---|
enhanced_measurement_settings |
Required. The settings to update. The |
update_mask |
Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. |
UpdateEventCreateRuleRequest
Request message for UpdateEventCreateRule RPC.
| Fields | |
|---|---|
event_create_rule |
Required. The EventCreateRule to update. The resource's |
update_mask |
Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. |
UpdateEventEditRuleRequest
Request message for UpdateEventEditRule RPC.
| Fields | |
|---|---|
event_edit_rule |
Required. The EventEditRule to update. The resource's |
update_mask |
Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. |
UpdateExpandedDataSetRequest
Request message for UpdateExpandedDataSet RPC.
| Fields | |
|---|---|
expanded_data_set |
Required. The ExpandedDataSet to update. The resource's |
update_mask |
Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. |
UpdateGoogleAdsLinkRequest
Request message for UpdateGoogleAdsLink RPC
| Fields | |
|---|---|
google_ads_link |
The GoogleAdsLink to update |
update_mask |
Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. |
UpdateGoogleSignalsSettingsRequest
Request message for UpdateGoogleSignalsSettings RPC
| Fields | |
|---|---|
google_signals_settings |
Required. The settings to update. The |
update_mask |
Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. |
UpdateKeyEventRequest
Request message for UpdateKeyEvent RPC
| Fields | |
|---|---|
key_event |
Required. The Key Event to update. The |
update_mask |
Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. |
UpdateMeasurementProtocolSecretRequest
Request message for UpdateMeasurementProtocolSecret RPC
| Fields | |
|---|---|
measurement_protocol_secret |
Required. The measurement protocol secret to update. |
update_mask |
Required. The list of fields to be updated. Omitted fields will not be updated. |
UpdatePropertyRequest
Request message for UpdateProperty RPC.
| Fields | |
|---|---|
property |
Required. The property to update. The property's |
update_mask |
Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. |
UpdateReportingDataAnnotationRequest
Request message for UpdateReportingDataAnnotation RPC.
| Fields | |
|---|---|
reporting_data_annotation |
Required. The Reporting Data Annotation to update. |
update_mask |
Optional. The list of fields to update. Field names must be in snake case (for example, "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. |
UpdateSKAdNetworkConversionValueSchemaRequest
Request message for UpdateSKAdNetworkConversionValueSchema RPC.
| Fields | |
|---|---|
skadnetwork_conversion_value_schema |
Required. SKAdNetwork conversion value schema to update. |
update_mask |
Required. The list of fields to be updated. Omitted fields will not be updated. |
UpdateSearchAds360LinkRequest
Request message for UpdateSearchAds360Link RPC.
| Fields | |
|---|---|
search_ads_360_link |
The SearchAds360Link to update |
update_mask |
Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. |
UpdateSubpropertyEventFilterRequest
Request message for UpdateSubpropertyEventFilter RPC.
| Fields | |
|---|---|
subproperty_event_filter |
Required. The subproperty event filter to update. |
update_mask |
Required. The list of fields to update. Field names must be in snake case (for example, "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. |