Package google.analytics.admin.v1alpha

索引

AnalyticsAdminService

Google Analytics Admin API 的服务接口。

AcknowledgeUserDataCollection

rpc AcknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest) returns (AcknowledgeUserDataCollectionResponse)

确认指定媒体资源的用户数据收集条款。

必须先完成此确认(在 Google Analytics 界面中或通过此 API),然后才能创建 MeasurementProtocolSecret 资源。

授权范围

需要以下 OAuth 范围:

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

rpc ApproveDisplayVideo360AdvertiserLinkProposal(ApproveDisplayVideo360AdvertiserLinkProposalRequest) returns (ApproveDisplayVideo360AdvertiserLinkProposalResponse)

批准 DisplayVideo360AdvertiserLinkProposal。系统将删除 DisplayVideo360AdvertiserLinkProposal,并创建新的 DisplayVideo360AdvertiserLink。

授权范围

需要以下 OAuth 范围:

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

rpc ArchiveAudience(ArchiveAudienceRequest) returns (Empty)

归档媒体资源中的受众群体。

授权范围

需要以下 OAuth 范围:

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

rpc ArchiveCustomDimension(ArchiveCustomDimensionRequest) returns (Empty)

归档媒体资源中的 CustomDimension。

授权范围

需要以下 OAuth 范围:

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

rpc ArchiveCustomMetric(ArchiveCustomMetricRequest) returns (Empty)

归档媒体资源中的 CustomMetric。

授权范围

需要以下 OAuth 范围:

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

rpc BatchCreateAccessBindings(BatchCreateAccessBindingsRequest) returns (BatchCreateAccessBindingsResponse)

创建有关账号或媒体资源的多个访问权限绑定的信息。

此方法是事务性的。如果无法创建任何 AccessBinding,则不会创建任何 AccessBinding。

授权范围

需要以下 OAuth 范围:

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

rpc BatchDeleteAccessBindings(BatchDeleteAccessBindingsRequest) returns (Empty)

删除有关多位用户与账号或媒体资源之间的关联的信息。

授权范围

需要以下 OAuth 范围:

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

rpc BatchGetAccessBindings(BatchGetAccessBindingsRequest) returns (BatchGetAccessBindingsResponse)

获取有关账号或媒体资源的多个访问权限绑定的信息。

授权范围

需要以下 OAuth 范围之一:

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

rpc BatchUpdateAccessBindings(BatchUpdateAccessBindingsRequest) returns (BatchUpdateAccessBindingsResponse)

更新了有关账号或媒体资源的多个访问权限绑定的信息。

授权范围

需要以下 OAuth 范围:

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

rpc CancelDisplayVideo360AdvertiserLinkProposal(CancelDisplayVideo360AdvertiserLinkProposalRequest) returns (DisplayVideo360AdvertiserLinkProposal)

取消 DisplayVideo360AdvertiserLinkProposal。取消可能意味着:- 拒绝从 Display & Video 360 发起的提案 - 撤消从 Google Analytics 发起的提案取消后,提案最终会被自动删除。

授权范围

需要以下 OAuth 范围:

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

rpc CreateAccessBinding(CreateAccessBindingRequest) returns (AccessBinding)

在账号或媒体资源上创建访问权限绑定。

授权范围

需要以下 OAuth 范围:

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

rpc CreateAudience(CreateAudienceRequest) returns (Audience)

创建受众群体。

授权范围

需要以下 OAuth 范围:

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

rpc CreateCalculatedMetric(CreateCalculatedMetricRequest) returns (CalculatedMetric)

创建 CalculatedMetric。

授权范围

需要以下 OAuth 范围:

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

rpc CreateChannelGroup(CreateChannelGroupRequest) returns (ChannelGroup)

创建 ChannelGroup。

授权范围

需要以下 OAuth 范围:

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

rpc CreateConversionEvent(CreateConversionEventRequest) returns (ConversionEvent)

已弃用:请改用 CreateKeyEvent。使用指定的属性创建转化事件。

授权范围

需要以下 OAuth 范围:

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

rpc CreateCustomDimension(CreateCustomDimensionRequest) returns (CustomDimension)

创建 CustomDimension。

授权范围

需要以下 OAuth 范围:

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

rpc CreateCustomMetric(CreateCustomMetricRequest) returns (CustomMetric)

创建 CustomMetric。

授权范围

需要以下 OAuth 范围:

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

rpc CreateDataStream(CreateDataStreamRequest) returns (DataStream)

创建 DataStream。

授权范围

需要以下 OAuth 范围:

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

rpc CreateDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest) returns (DisplayVideo360AdvertiserLinkProposal)

创建 DisplayVideo360AdvertiserLinkProposal。

授权范围

需要以下 OAuth 范围:

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

rpc CreateEventCreateRule(CreateEventCreateRuleRequest) returns (EventCreateRule)

创建 EventCreateRule。

授权范围

需要以下 OAuth 范围:

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

rpc CreateEventEditRule(CreateEventEditRuleRequest) returns (EventEditRule)

创建 EventEditRule。

授权范围

需要以下 OAuth 范围:

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

rpc CreateExpandedDataSet(CreateExpandedDataSetRequest) returns (ExpandedDataSet)

创建 ExpandedDataSet。

授权范围

需要以下 OAuth 范围:

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

rpc CreateKeyEvent(CreateKeyEventRequest) returns (KeyEvent)

创建关键事件。

授权范围

需要以下 OAuth 范围:

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

rpc CreateMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret)

创建 Measurement Protocol Secret。

授权范围

需要以下 OAuth 范围:

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

rpc CreateProperty(CreatePropertyRequest) returns (Property)

创建具有指定位置和属性的 Google Analytics 媒体资源。

授权范围

需要以下 OAuth 范围:

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

rpc CreateReportingDataAnnotation(CreateReportingDataAnnotationRequest) returns (ReportingDataAnnotation)

创建报告数据注释。

授权范围

需要以下 OAuth 范围:

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

rpc CreateRollupProperty(CreateRollupPropertyRequest) returns (CreateRollupPropertyResponse)

创建总览媒体资源和所有总览媒体资源来源链接。

授权范围

需要以下 OAuth 范围:

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

rpc CreateSKAdNetworkConversionValueSchema(CreateSKAdNetworkConversionValueSchemaRequest) returns (SKAdNetworkConversionValueSchema)

创建 SKAdNetworkConversionValueSchema。

授权范围

需要以下 OAuth 范围:

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

rpc CreateSubpropertyEventFilter(CreateSubpropertyEventFilterRequest) returns (SubpropertyEventFilter)

创建子媒体资源事件过滤器。

授权范围

需要以下 OAuth 范围:

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

rpc DeleteAccessBinding(DeleteAccessBindingRequest) returns (Empty)

删除账号或媒体资源上的访问权限绑定。

授权范围

需要以下 OAuth 范围:

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

rpc DeleteAccount(DeleteAccountRequest) returns (Empty)

将目标账号标记为已软删除(即“已放入回收站”),并返回该账号。

此 API 没有用于恢复软删除账号的方法。不过,您可以使用回收站界面恢复这些文件。

如果未在到期时间之前恢复这些账号,相应账号和所有子资源(例如媒体资源、GoogleAdsLinks、数据流、AccessBindings)将被永久清除。https://support.google.com/analytics/answer/6154772

如果找不到目标,则返回错误。

授权范围

需要以下 OAuth 范围:

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

rpc DeleteCalculatedMetric(DeleteCalculatedMetricRequest) returns (Empty)

删除媒体资源中的 CalculatedMetric。

授权范围

需要以下 OAuth 范围:

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

rpc DeleteChannelGroup(DeleteChannelGroupRequest) returns (Empty)

删除媒体资源中的 ChannelGroup。

授权范围

需要以下 OAuth 范围:

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

rpc DeleteConversionEvent(DeleteConversionEventRequest) returns (Empty)

已弃用:请改用 DeleteKeyEvent。删除媒体资源中的转化事件。

授权范围

需要以下 OAuth 范围:

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

rpc DeleteDataStream(DeleteDataStreamRequest) returns (Empty)

删除媒体资源中的数据流。

授权范围

需要以下 OAuth 范围:

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

rpc DeleteDisplayVideo360AdvertiserLinkProposal(DeleteDisplayVideo360AdvertiserLinkProposalRequest) returns (Empty)

删除媒体资源中的 DisplayVideo360AdvertiserLinkProposal。此方法只能用于已取消的提案。

授权范围

需要以下 OAuth 范围:

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

rpc DeleteEventCreateRule(DeleteEventCreateRuleRequest) returns (Empty)

删除 EventCreateRule。

授权范围

需要以下 OAuth 范围:

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

rpc DeleteEventEditRule(DeleteEventEditRuleRequest) returns (Empty)

删除 EventEditRule。

授权范围

需要以下 OAuth 范围:

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

rpc DeleteExpandedDataSet(DeleteExpandedDataSetRequest) returns (Empty)

删除媒体资源中的 ExpandedDataSet。

授权范围

需要以下 OAuth 范围:

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

rpc DeleteKeyEvent(DeleteKeyEventRequest) returns (Empty)

删除关键事件。

授权范围

需要以下 OAuth 范围:

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

rpc DeleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest) returns (Empty)

删除目标 MeasurementProtocolSecret。

授权范围

需要以下 OAuth 范围:

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

rpc DeleteProperty(DeletePropertyRequest) returns (Property)

将目标媒体资源标记为已软删除(即“已放入回收站”),然后返回该媒体资源。

此 API 没有用于恢复软删除的属性的方法。不过,您可以使用回收站界面恢复这些文件。

如果未在失效时间之前恢复媒体资源,相应媒体资源和所有子资源(例如 GoogleAdsLinks、Streams、AccessBindings)将被永久清除。https://support.google.com/analytics/answer/6154772

如果找不到目标,则返回错误。

授权范围

需要以下 OAuth 范围:

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

rpc DeleteReportingDataAnnotation(DeleteReportingDataAnnotationRequest) returns (Empty)

删除报告数据注释。

授权范围

需要以下 OAuth 范围:

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

rpc DeleteSKAdNetworkConversionValueSchema(DeleteSKAdNetworkConversionValueSchemaRequest) returns (Empty)

删除目标 SKAdNetworkConversionValueSchema。

授权范围

需要以下 OAuth 范围:

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

rpc DeleteSubpropertyEventFilter(DeleteSubpropertyEventFilterRequest) returns (Empty)

删除子媒体资源事件过滤器。

授权范围

需要以下 OAuth 范围:

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

rpc GetAccessBinding(GetAccessBindingRequest) returns (AccessBinding)

获取有关访问权限绑定的信息。

授权范围

需要以下 OAuth 范围之一:

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

rpc GetAccount(GetAccountRequest) returns (Account)

查找单个账号。

授权范围

需要以下 OAuth 范围之一:

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

rpc GetAttributionSettings(GetAttributionSettingsRequest) returns (AttributionSettings)

查找 AttributionSettings 单例。

授权范围

需要以下 OAuth 范围之一:

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

rpc GetAudience(GetAudienceRequest) returns (Audience)

查找单个受众群体。系统可能不支持 2020 年之前创建的受众群体。默认受众群体不会显示过滤条件定义。

授权范围

需要以下 OAuth 范围之一:

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

rpc GetCalculatedMetric(GetCalculatedMetricRequest) returns (CalculatedMetric)

查找单个 CalculatedMetric。

授权范围

需要以下 OAuth 范围之一:

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

rpc GetChannelGroup(GetChannelGroupRequest) returns (ChannelGroup)

查找单个 ChannelGroup。

授权范围

需要以下 OAuth 范围之一:

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

rpc GetConversionEvent(GetConversionEventRequest) returns (ConversionEvent)

已弃用:请改用 GetKeyEvent。检索单个转化事件。

授权范围

需要以下 OAuth 范围之一:

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

rpc GetCustomDimension(GetCustomDimensionRequest) returns (CustomDimension)

单个 CustomDimension 的查找。

授权范围

需要以下 OAuth 范围之一:

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

rpc GetCustomMetric(GetCustomMetricRequest) returns (CustomMetric)

查找单个 CustomMetric。

授权范围

需要以下 OAuth 范围之一:

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

rpc GetDataRedactionSettings(GetDataRedactionSettingsRequest) returns (DataRedactionSettings)

查找单个 DataRedactionSettings。

授权范围

需要以下 OAuth 范围之一:

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

rpc GetDataRetentionSettings(GetDataRetentionSettingsRequest) returns (DataRetentionSettings)

返回相应媒体资源的单例数据保留设置。

授权范围

需要以下 OAuth 范围之一:

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

rpc GetDataSharingSettings(GetDataSharingSettingsRequest) returns (DataSharingSettings)

获取账号的数据共享设置。数据共享设置是单例。

授权范围

需要以下 OAuth 范围之一:

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

rpc GetDataStream(GetDataStreamRequest) returns (DataStream)

查找单个 DataStream。

授权范围

需要以下 OAuth 范围之一:

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

rpc GetDisplayVideo360AdvertiserLinkProposal(GetDisplayVideo360AdvertiserLinkProposalRequest) returns (DisplayVideo360AdvertiserLinkProposal)

查找单个 DisplayVideo360AdvertiserLinkProposal。

授权范围

需要以下 OAuth 范围之一:

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

rpc GetEnhancedMeasurementSettings(GetEnhancedMeasurementSettingsRequest) returns (EnhancedMeasurementSettings)

返回相应数据流的增强型衡量设置。请注意,数据流必须启用增强型衡量功能,这些设置才能生效。

授权范围

需要以下 OAuth 范围之一:

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

rpc GetEventCreateRule(GetEventCreateRuleRequest) returns (EventCreateRule)

查找单个 EventCreateRule。

授权范围

需要以下 OAuth 范围之一:

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

rpc GetEventEditRule(GetEventEditRuleRequest) returns (EventEditRule)

查找单个 EventEditRule。

授权范围

需要以下 OAuth 范围之一:

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

rpc GetExpandedDataSet(GetExpandedDataSetRequest) returns (ExpandedDataSet)

查找单个 ExpandedDataSet。

授权范围

需要以下 OAuth 范围之一:

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

rpc GetGlobalSiteTag(GetGlobalSiteTagRequest) returns (GlobalSiteTag)

返回指定网站数据流的网站代码。网站代码是不可变的单例。

授权范围

需要以下 OAuth 范围之一:

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

rpc GetGoogleSignalsSettings(GetGoogleSignalsSettingsRequest) returns (GoogleSignalsSettings)

查找媒体资源的 Google 信号设置。

授权范围

需要以下 OAuth 范围之一:

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

rpc GetKeyEvent(GetKeyEventRequest) returns (KeyEvent)

检索单个关键事件。

授权范围

需要以下 OAuth 范围之一:

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

rpc GetMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret)

查找单个 MeasurementProtocolSecret。

授权范围

需要以下 OAuth 范围之一:

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

rpc GetProperty(GetPropertyRequest) returns (Property)

查找单个 Google Analytics 媒体资源。

授权范围

需要以下 OAuth 范围之一:

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

rpc GetReportingDataAnnotation(GetReportingDataAnnotationRequest) returns (ReportingDataAnnotation)

查找单个报告数据注释。

授权范围

需要以下 OAuth 范围之一:

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

rpc GetReportingIdentitySettings(GetReportingIdentitySettingsRequest) returns (ReportingIdentitySettings)

返回相应媒体资源的报告身份设置。

授权范围

需要以下 OAuth 范围之一:

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

rpc GetSKAdNetworkConversionValueSchema(GetSKAdNetworkConversionValueSchemaRequest) returns (SKAdNetworkConversionValueSchema)

查找单个 SKAdNetworkConversionValueSchema。

授权范围

需要以下 OAuth 范围之一:

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

rpc GetSubpropertyEventFilter(GetSubpropertyEventFilterRequest) returns (SubpropertyEventFilter)

查找单个子媒体资源事件过滤器。

授权范围

需要以下 OAuth 范围之一:

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

rpc GetSubpropertySyncConfig(GetSubpropertySyncConfigRequest) returns (SubpropertySyncConfig)

查找单个 SubpropertySyncConfig

授权范围

需要以下 OAuth 范围之一:

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

rpc ListAccessBindings(ListAccessBindingsRequest) returns (ListAccessBindingsResponse)

列出账号或媒体资源的所有访问权限绑定。

授权范围

需要以下 OAuth 范围之一:

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

rpc ListAccountSummaries(ListAccountSummariesRequest) returns (ListAccountSummariesResponse)

返回调用者可访问的所有账号的摘要。

授权范围

需要以下 OAuth 范围之一:

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

rpc ListAccounts(ListAccountsRequest) returns (ListAccountsResponse)

返回调用方可访问的所有账号。

请注意,这些账号目前可能没有 GA 媒体资源。默认情况下,系统会排除软删除(即“已放入回收站”)的账号。如果未找到任何相关账号,则返回空列表。

授权范围

需要以下 OAuth 范围之一:

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

rpc ListAudiences(ListAudiencesRequest) returns (ListAudiencesResponse)

列出媒体资源中的受众群体。系统可能不支持 2020 年之前创建的受众群体。默认受众群体不会显示过滤条件定义。

授权范围

需要以下 OAuth 范围之一:

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

rpc ListCalculatedMetrics(ListCalculatedMetricsRequest) returns (ListCalculatedMetricsResponse)

列出媒体资源中的 CalculatedMetric。

授权范围

需要以下 OAuth 范围之一:

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

rpc ListChannelGroups(ListChannelGroupsRequest) returns (ListChannelGroupsResponse)

列出媒体资源上的 ChannelGroup。

授权范围

需要以下 OAuth 范围之一:

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

rpc ListConversionEvents(ListConversionEventsRequest) returns (ListConversionEventsResponse)

已弃用:请改用 ListKeyEvents。返回指定父媒体资源中的转化事件列表。

如果未找到任何转化事件,则返回空列表。

授权范围

需要以下 OAuth 范围之一:

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

rpc ListCustomDimensions(ListCustomDimensionsRequest) returns (ListCustomDimensionsResponse)

列出媒体资源中的 CustomDimension。

授权范围

需要以下 OAuth 范围之一:

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

rpc ListCustomMetrics(ListCustomMetricsRequest) returns (ListCustomMetricsResponse)

列出媒体资源中的 CustomMetrics。

授权范围

需要以下 OAuth 范围之一:

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

rpc ListDataStreams(ListDataStreamsRequest) returns (ListDataStreamsResponse)

列出媒体资源中的 DataStream。

授权范围

需要以下 OAuth 范围之一:

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

rpc ListDisplayVideo360AdvertiserLinkProposals(ListDisplayVideo360AdvertiserLinkProposalsRequest) returns (ListDisplayVideo360AdvertiserLinkProposalsResponse)

列出媒体资源中的 DisplayVideo360AdvertiserLinkProposals。

授权范围

需要以下 OAuth 范围之一:

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

rpc ListEventCreateRules(ListEventCreateRulesRequest) returns (ListEventCreateRulesResponse)

列出网站数据流中的 EventCreateRule。

授权范围

需要以下 OAuth 范围之一:

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

rpc ListEventEditRules(ListEventEditRulesRequest) returns (ListEventEditRulesResponse)

列出网站数据流中的 EventEditRule。

授权范围

需要以下 OAuth 范围之一:

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

rpc ListExpandedDataSets(ListExpandedDataSetsRequest) returns (ListExpandedDataSetsResponse)

列出媒体资源中的 ExpandedDataSet。

授权范围

需要以下 OAuth 范围之一:

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

rpc ListKeyEvents(ListKeyEventsRequest) returns (ListKeyEventsResponse)

返回指定父媒体资源中的关键事件列表。如果未找到任何键事件,则返回空列表。

授权范围

需要以下 OAuth 范围之一:

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

rpc ListMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest) returns (ListMeasurementProtocolSecretsResponse)

返回指定父媒体资源下的子级 MeasurementProtocolSecrets。

授权范围

需要以下 OAuth 范围之一:

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

rpc ListProperties(ListPropertiesRequest) returns (ListPropertiesResponse)

返回指定父账号下的子媒体资源。

如果调用方没有访问权限,则会排除相应媒体资源。默认情况下,系统会排除软删除(即“已放入回收站”)的媒体资源。如果未找到相关属性,则返回空列表。

授权范围

需要以下 OAuth 范围之一:

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

rpc ListReportingDataAnnotations(ListReportingDataAnnotationsRequest) returns (ListReportingDataAnnotationsResponse)

列出媒体资源上的所有报告数据注释。

授权范围

需要以下 OAuth 范围之一:

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

rpc ListSKAdNetworkConversionValueSchemas(ListSKAdNetworkConversionValueSchemasRequest) returns (ListSKAdNetworkConversionValueSchemasResponse)

列出数据流中的 SKAdNetworkConversionValueSchema。媒体资源最多只能有一个 SKAdNetworkConversionValueSchema。

授权范围

需要以下 OAuth 范围之一:

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

rpc ListSubpropertyEventFilters(ListSubpropertyEventFiltersRequest) returns (ListSubpropertyEventFiltersResponse)

列出媒体资源中的所有子媒体资源事件过滤器。

授权范围

需要以下 OAuth 范围之一:

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

rpc ListSubpropertySyncConfigs(ListSubpropertySyncConfigsRequest) returns (ListSubpropertySyncConfigsResponse)

列出媒体资源的所有 SubpropertySyncConfig 资源。

授权范围

需要以下 OAuth 范围之一:

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

rpc ProvisionAccountTicket(ProvisionAccountTicketRequest) returns (ProvisionAccountTicketResponse)

请求创建账号的工单。

授权范围

需要以下 OAuth 范围:

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

rpc ProvisionSubproperty(ProvisionSubpropertyRequest) returns (ProvisionSubpropertyResponse)

创建子媒体资源和适用于所创建子媒体资源的子媒体资源事件过滤器。

授权范围

需要以下 OAuth 范围:

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

rpc ReorderEventEditRules(ReorderEventEditRulesRequest) returns (Empty)

更改指定信息流中事件编辑规则的处理顺序。

授权范围

需要以下 OAuth 范围:

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

rpc RunAccessReport(RunAccessReportRequest) returns (RunAccessReportResponse)

返回数据访问记录的自定义报告。该报告会记录用户每次读取 Google Analytics 报告数据的时间。访问记录最长可保留 2 年。

您可以为媒体资源请求数据访问报告。您可以为任何媒体资源请求报告,但与配额无关的维度只能在 Google Analytics 360 媒体资源中请求。此方法仅适用于管理员。

这些数据访问记录包括 Google Analytics 界面报告、Google Analytics 界面探索、Google Analytics Data API,以及可以通过关联从 Google Analytics 检索数据的其他产品(例如 Firebase 和 AdMob)。这些记录不包括媒体资源配置更改,例如添加数据流或更改媒体资源的时区。如需了解配置更改历史记录,请参阅 searchChangeHistoryEvents

如需对此 API 提供反馈,请填写 Google Analytics 访问报告反馈表单。

授权范围

需要以下 OAuth 范围之一:

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

rpc SearchChangeHistoryEvents(SearchChangeHistoryEventsRequest) returns (SearchChangeHistoryEventsResponse)

根据指定的过滤条件,搜索账号或其子账号的所有更改。

仅返回 API 支持的更改子集。界面可能会返回其他更改。

授权范围

需要以下 OAuth 范围:

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

rpc SubmitUserDeletion(SubmitUserDeletionRequest) returns (SubmitUserDeletionResponse)

提交针对媒体资源的删除用户数据请求。

授权范围

需要以下 OAuth 范围:

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

rpc UpdateAccessBinding(UpdateAccessBindingRequest) returns (AccessBinding)

更新账号或媒体资源的访问权限绑定。

授权范围

需要以下 OAuth 范围:

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

rpc UpdateAccount(UpdateAccountRequest) returns (Account)

更新账号。

授权范围

需要以下 OAuth 范围:

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

rpc UpdateAttributionSettings(UpdateAttributionSettingsRequest) returns (AttributionSettings)

更新媒体资源的归因设置。

授权范围

需要以下 OAuth 范围:

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

rpc UpdateAudience(UpdateAudienceRequest) returns (Audience)

更新媒体资源中的受众群体。

授权范围

需要以下 OAuth 范围:

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

rpc UpdateCalculatedMetric(UpdateCalculatedMetricRequest) returns (CalculatedMetric)

更新媒体资源中的 CalculatedMetric。

授权范围

需要以下 OAuth 范围:

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

rpc UpdateChannelGroup(UpdateChannelGroupRequest) returns (ChannelGroup)

更新 ChannelGroup。

授权范围

需要以下 OAuth 范围:

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

rpc UpdateConversionEvent(UpdateConversionEventRequest) returns (ConversionEvent)

已弃用:请改用 UpdateKeyEvent。更新具有指定属性的转化事件。

授权范围

需要以下 OAuth 范围:

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

rpc UpdateCustomDimension(UpdateCustomDimensionRequest) returns (CustomDimension)

更新媒体资源中的 CustomDimension。

授权范围

需要以下 OAuth 范围:

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

rpc UpdateCustomMetric(UpdateCustomMetricRequest) returns (CustomMetric)

更新媒体资源中的 CustomMetric。

授权范围

需要以下 OAuth 范围:

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

rpc UpdateDataRedactionSettings(UpdateDataRedactionSettingsRequest) returns (DataRedactionSettings)

更新媒体资源中的 DataRedactionSettings。

授权范围

需要以下 OAuth 范围:

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

rpc UpdateDataRetentionSettings(UpdateDataRetentionSettingsRequest) returns (DataRetentionSettings)

更新相应媒体资源的单例数据保留设置。

授权范围

需要以下 OAuth 范围:

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

rpc UpdateDataStream(UpdateDataStreamRequest) returns (DataStream)

更新媒体资源中的 DataStream。

授权范围

需要以下 OAuth 范围:

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

rpc UpdateEnhancedMeasurementSettings(UpdateEnhancedMeasurementSettingsRequest) returns (EnhancedMeasurementSettings)

更新相应数据流的增强型衡量设置。请注意,数据流必须启用增强型衡量功能,这些设置才能生效。

授权范围

需要以下 OAuth 范围:

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

rpc UpdateEventCreateRule(UpdateEventCreateRuleRequest) returns (EventCreateRule)

更新 EventCreateRule。

授权范围

需要以下 OAuth 范围:

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

rpc UpdateEventEditRule(UpdateEventEditRuleRequest) returns (EventEditRule)

更新 EventEditRule。

授权范围

需要以下 OAuth 范围:

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

rpc UpdateExpandedDataSet(UpdateExpandedDataSetRequest) returns (ExpandedDataSet)

更新媒体资源中的 ExpandedDataSet。

授权范围

需要以下 OAuth 范围:

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

rpc UpdateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest) returns (GoogleSignalsSettings)

更新媒体资源的 Google 信号设置。

授权范围

需要以下 OAuth 范围:

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

rpc UpdateKeyEvent(UpdateKeyEventRequest) returns (KeyEvent)

更新关键事件。

授权范围

需要以下 OAuth 范围:

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

rpc UpdateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret)

更新 Measurement Protocol 密钥。

授权范围

需要以下 OAuth 范围:

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

rpc UpdateProperty(UpdatePropertyRequest) returns (Property)

更新媒体资源。

授权范围

需要以下 OAuth 范围:

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

rpc UpdateReportingDataAnnotation(UpdateReportingDataAnnotationRequest) returns (ReportingDataAnnotation)

更新报告数据注释。

授权范围

需要以下 OAuth 范围:

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

rpc UpdateSKAdNetworkConversionValueSchema(UpdateSKAdNetworkConversionValueSchemaRequest) returns (SKAdNetworkConversionValueSchema)

更新 SKAdNetworkConversionValueSchema。

授权范围

需要以下 OAuth 范围:

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

rpc UpdateSubpropertyEventFilter(UpdateSubpropertyEventFilterRequest) returns (SubpropertyEventFilter)

更新子媒体资源事件过滤器。

授权范围

需要以下 OAuth 范围:

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

rpc UpdateSubpropertySyncConfig(UpdateSubpropertySyncConfigRequest) returns (SubpropertySyncConfig)

更新 SubpropertySyncConfig

授权范围

需要以下 OAuth 范围:

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

AccessBetweenFilter

表示结果必须介于两个数字之间(含这两个数字)。

字段
from_value

NumericValue

以相应数字开头。

to_value

NumericValue

以该数字结尾。

AccessBinding

用户与一组角色之间的绑定。

字段
name

string

仅限输出。相应绑定的资源名称。

格式:accounts/{account}/accessBindings/{access_binding} 或 properties/{property}/accessBindings/{access_binding}

示例:“accounts/100/accessBindings/200”

roles[]

string

要授予父级资源的角色的列表。

有效值:predefinedRoles/viewer、predefinedRoles/analyst、predefinedRoles/editor、predefinedRoles/admin、predefinedRoles/no-cost-data、predefinedRoles/no-revenue-data

对于用户,如果设置了空的角色列表,则会删除此 AccessBinding。

联合字段 access_target。要为其设置角色的目标。access_target 只能是下列其中一项:
user

string

如果已设置,则表示要设置角色的用户的电子邮件地址。格式:“someuser@gmail.com”

AccessDateRange

连续的日期范围:startDate、startDate + 1、...、endDate。

字段
start_date

string

查询的开始日期(含此日期),格式为 YYYY-MM-DD。不得晚于 endDate。系统也接受 NdaysAgoyesterdaytoday 格式,在这种情况下,系统会根据请求时区中的当前时间推断日期。

end_date

string

查询的结束日期(含此日期),格式为 YYYY-MM-DD。不得早于 startDate。系统也接受 NdaysAgoyesterdaytoday 格式,在这种情况下,系统会根据请求时区中的当前时间推断日期。

AccessDimension

“维度”是指数据的属性。例如,维度 userEmail 表示访问报告数据的用户的电子邮件地址。报告响应中的维度值是字符串。

字段
dimension_name

string

维度的 API 名称。如需查看此 API 支持的维度列表,请参阅数据访问架构

维度在 dimensionFilterorderBys 中按名称引用。

AccessDimensionHeader

描述报告中的维度列。报告中请求的维度会在行和 DimensionHeaders 中生成列条目。不过,仅在过滤条件或表达式中使用的维度不会在报告中生成列;相应地,这些维度也不会生成标题。

字段
dimension_name

string

维度的名称;例如“userEmail”。

AccessDimensionValue

维度值。

字段
value

string

维度值。例如,对于“国家/地区”维度,此值可能是“法国”。

AccessFilter

用于过滤维度或指标值的表达式。

字段
field_name

string

维度名称或指标名称。

联合字段 one_filter。为 Filter 指定一种过滤条件类型。one_filter 只能是下列其中一项:
string_filter

AccessStringFilter

与字符串相关的过滤条件。

in_list_filter

AccessInListFilter

用于过滤列表中的值的过滤条件。

numeric_filter

AccessNumericFilter

用于过滤数值或日期值的过滤条件。

between_filter

AccessBetweenFilter

用于过滤两个值的过滤条件。

AccessFilterExpression

表示维度或指标过滤条件。同一表达式中的字段必须全部为维度或全部为指标。

字段
联合字段 one_expression。为 FilterExpression 指定一种过滤条件表达式。one_expression 只能是下列其中一项:
and_group

AccessFilterExpressionList

and_group 中的每个 FilterExpression 之间都具有 AND 关系。

or_group

AccessFilterExpressionList

or_group 中的每个 FilterExpression 之间都是 OR 关系。

not_expression

AccessFilterExpression

FilterExpression 不是 not_expression。

access_filter

AccessFilter

一种基本过滤条件。在同一 FilterExpression 中,过滤条件的所有字段名称必须全部为维度或全部为指标。

AccessFilterExpressionList

过滤条件表达式列表。

字段
expressions[]

AccessFilterExpression

过滤条件表达式列表。

AccessInListFilter

结果需要采用字符串值列表的形式。

字段
values[]

string

字符串值列表。不得为空。

case_sensitive

bool

如果为 true,则字符串值区分大小写。

AccessMetric

报告的量化衡量标准。例如,指标 accessCount 是指数据访问记录的总数。

字段
metric_name

string

相应指标的 API 名称。如需查看此 API 支持的指标列表,请参阅数据访问架构

指标在 metricFilterorderBys 中按名称引用。

AccessMetricHeader

描述报告中的指标列。报告中请求的可见指标会在行和 MetricHeaders 中生成列条目。不过,如果指标仅在过滤条件或表达式中使用,则不会在报告中生成列;相应地,这些指标也不会生成标题。

字段
metric_name

string

指标的名称,例如“accessCount”。

AccessMetricValue

指标的值。

字段
value

string

衡量值。例如,此值可以是“13”。

AccessNumericFilter

用于过滤数值或日期值。

字段
operation

Operation

相应过滤条件的操作类型。

value

NumericValue

数值或日期值。

操作

应用于数字过滤器的操作。

枚举
OPERATION_UNSPECIFIED 未指定。
EQUAL 等于
LESS_THAN 小于
LESS_THAN_OR_EQUAL 小于或等于
GREATER_THAN 大于
GREATER_THAN_OR_EQUAL 大于或等于

AccessOrderBy

Order bys 定义了响应中各行的排序方式。例如,按访问次数降序对行进行排序是一种排序方式,而按国家/地区字符串对行进行排序则是另一种排序方式。

字段
desc

bool

如果为 true,则按降序排序。如果为 false 或未指定,则按升序排序。

联合字段 one_order_by。为 OrderBy 指定一种排序依据类型。one_order_by 只能是下列其中一项:
metric

MetricOrderBy

按指标值对结果进行排序。

dimension

DimensionOrderBy

按维度值对结果进行排序。

DimensionOrderBy

按维度值排序。

字段
dimension_name

string

请求中用于排序的维度名称。

order_type

OrderType

控制维度值排序的规则。

OrderType

用于对字符串维度值进行排序的规则。

枚举
ORDER_TYPE_UNSPECIFIED 未指定。
ALPHANUMERIC 按 Unicode 码位进行字母数字排序。例如,“2”<“A”<“X”<“b”<“z”。
CASE_INSENSITIVE_ALPHANUMERIC 按小写 Unicode 码位进行不区分大小写的字母数字排序。例如,“2”<“A”<“b”<“X”<“z”。
NUMERIC 维度值会在排序之前转换为数字。例如,在“数值”排序中,“25”小于“100”,而在 ALPHANUMERIC 排序中,“100”小于“25”。所有非数字维度值的排序值都低于所有数字值。

MetricOrderBy

按指标值排序。

字段
metric_name

string

请求中用于排序的指标名称。

AccessQuota

相应 Google Analytics 媒体资源的所有配额的当前状态。如果某个属性的任何配额用尽,则对该属性的所有请求都会返回“资源耗尽”错误。

字段
tokens_per_day

AccessQuotaStatus

每个媒体资源每天最多可以使用 25 万个令牌。大部分请求消耗的令牌数都少于 10 个。

tokens_per_hour

AccessQuotaStatus

每小时最多可使用 5 万个 token。一个 API 请求会消耗一定数量的令牌,该数量会从所有的小时配额、每日配额和每个项目的小时配额中扣除。

concurrent_requests

AccessQuotaStatus

媒体资源最多可使用 50 个并发请求。

server_errors_per_project_per_hour

AccessQuotaStatus

媒体资源和 Cloud 项目对每小时最多可以有 50 个服务器错误。

tokens_per_project_per_hour

AccessQuotaStatus

媒体资源每小时每个项目最多可以使用其令牌的 25%。也就是说,Analytics 360 媒体资源每个项目每小时可以使用 12,500 个令牌。一个 API 请求会消耗一定数量的令牌,该数量会从所有的小时配额、每日配额和每个项目的小时配额中扣除。

AccessQuotaStatus

特定配额组的当前状态。

字段
consumed

int32

相应请求消耗的配额。

remaining

int32

此请求后的剩余配额。

AccessRow

访问每行报告数据。

字段
dimension_values[]

AccessDimensionValue

维度值列表。这些值的顺序与请求中指定的顺序相同。

metric_values[]

AccessMetricValue

指标值列表。这些值的顺序与请求中指定的顺序相同。

AccessStringFilter

字符串的过滤条件。

字段
match_type

MatchType

相应过滤条件的匹配类型。

value

string

用于匹配的字符串值。

case_sensitive

bool

如果为 true,则字符串值区分大小写。

MatchType

字符串过滤器的匹配类型。

枚举
MATCH_TYPE_UNSPECIFIED 未指定
EXACT 字符串值完全匹配。
BEGINS_WITH 以字符串值开头。
ENDS_WITH 以字符串值结尾。
CONTAINS 包含字符串值。
FULL_REGEXP 正则表达式与字符串值的完全匹配。
PARTIAL_REGEXP 字符串值与正则表达式的部分匹配。

账号

表示 Google Analytics 账号的资源消息。

字段
name

string

仅限输出。相应账号的资源名称。格式:accounts/{account} 示例:“accounts/100”

create_time

Timestamp

仅限输出。相应账号的原始创建时间。

update_time

Timestamp

仅限输出。账号载荷字段的上次更新时间。

display_name

string

必需。相应账号的直观易懂的显示名称。

region_code

string

商家所在的国家/地区。必须是 Unicode CLDR 区域代码。

deleted

bool

仅限输出。指示相应账号是否处于软删除状态。除非明确要求,否则已删除的账号不会包含在列表结果中。

gmp_organization

string

仅限输出。Google Marketing Platform 组织资源的 URI。仅当此账号与 GMP 组织相关联时设置。格式:marketingplatformadmin.googleapis.com/organizations/{org_id}

AccountSummary

一种虚拟资源,用于表示账号及其所有子级 Google Analytics 媒体资源的概览。

字段
name

string

相应账号摘要的资源名称。格式:accountSummaries/{account_id} 示例:“accountSummaries/1000”

account

string

相应账号摘要所指账号的资源名称。格式:accounts/{account_id}。示例:“accounts/1000”

display_name

string

相应账号摘要中提及的账号的显示名称。

property_summaries[]

PropertySummary

相应账号的子账号的摘要列表。

AcknowledgeUserDataCollectionRequest

针对 AcknowledgeUserDataCollection RPC 的请求消息。

字段
property

string

必需。要确认用户数据收集的媒体资源。

acknowledgement

string

必需。一种确认,表明此方法的调用方了解用户数据收集条款。

此字段必须包含以下确切值:“我确认,我已进行了必要的隐私披露声明并获得了最终用户授权,可收集最终用户的数据并进行相关处理,包括将此类数据与 Google Analytics 从我的网站和/或应用媒体资源收集的访问信息相关联。”

AcknowledgeUserDataCollectionResponse

此类型没有字段。

针对 AcknowledgeUserDataCollection RPC 的响应消息。

ActionType

可能会更改资源的操作类型。

枚举
ACTION_TYPE_UNSPECIFIED 操作类型未知或未指定。
CREATED 相应资源是在此变更中创建的。
UPDATED 相应资源已在此变更中更新。
DELETED 相应资源已在此变更中删除。

ActorType

可对 Google Analytics 资源进行更改的不同类型的行为者。

枚举
ACTOR_TYPE_UNSPECIFIED 执行者类型未知或未指定。
USER actor_email 中指定的用户所做的更改。
SYSTEM 由 Google Analytics 系统做出的更改。
SUPPORT Google Analytics 支持团队员工所做的更改。

ApproveDisplayVideo360AdvertiserLinkProposalRequest

针对 ApproveDisplayVideo360AdvertiserLinkProposal RPC 的请求消息。

字段
name

string

必需。要批准的 DisplayVideo360AdvertiserLinkProposal 的名称。示例格式:properties/1234/displayVideo360AdvertiserLinkProposals/5678

ApproveDisplayVideo360AdvertiserLinkProposalResponse

针对 ApproveDisplayVideo360AdvertiserLinkProposal RPC 的响应消息。

字段

ArchiveAudienceRequest

针对 ArchiveAudience RPC 的请求消息。

字段
name

string

必需。示例格式:properties/1234/audiences/5678

ArchiveCustomDimensionRequest

针对 ArchiveCustomDimension RPC 的请求消息。

字段
name

string

必需。要归档的 CustomDimension 的名称。示例格式:properties/1234/customDimensions/5678

ArchiveCustomMetricRequest

针对 ArchiveCustomMetric RPC 的请求消息。

字段
name

string

必需。要归档的 CustomMetric 的名称。示例格式:properties/1234/customMetrics/5678

AttributionSettings

指定媒体资源所用的归因设置。这是单例资源。

字段
name

string

仅限输出。相应归因设置资源的资源名称。格式:properties/{property_id}/attributionSettings 示例:“properties/1000/attributionSettings”

acquisition_conversion_event_lookback_window

AcquisitionConversionEventLookbackWindow

必需。流量获取转化事件的回溯期配置。默认时间范围为 30 天。

other_conversion_event_lookback_window

OtherConversionEventLookbackWindow

必需。所有其他非流量获取转化事件的回溯期。默认时间范围为 90 天。

reporting_attribution_model

ReportingAttributionModel

必需。用于计算相应媒体资源报告中的转化功劳的报告归因模型。

归因模型的更改将同时应用于历史数据和未来数据。这些更改会体现在包含转化及收入数据的报告中。用户及会话数据不会受到影响。

ads_web_conversion_data_export_scope

AdsWebConversionDataExportScope

必需。导出到关联的 Google Ads 账号的数据的转化导出范围。

AcquisitionConversionEventLookbackWindow

在导致首次安装应用或首次访问网站的转化路径中,应考虑多长时间之前的事件。

枚举
ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_UNSPECIFIED 未指定回溯窗口大小。
ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_7_DAYS 7 天的回溯期。
ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_30_DAYS 30 天的回溯期。

AdsWebConversionDataExportScope

导出到关联的 Google Ads 账号的数据的转化导出范围。

枚举
ADS_WEB_CONVERSION_DATA_EXPORT_SCOPE_UNSPECIFIED 默认值。此值未使用。
NOT_SELECTED_YET 尚未选择任何数据导出范围。导出范围永远无法改回此值。
PAID_AND_ORGANIC_CHANNELS 付费渠道和自然渠道都有资格获得转化功劳,但只有分配给 Google Ads 渠道的功劳才会显示在您的 Google Ads 账号中。如需了解详情,请参阅付费和自然渠道
GOOGLE_PAID_CHANNELS 只有 Google Ads 付费渠道有资格获得转化功劳。如需了解详情,请参阅 Google 付费频道

OtherConversionEventLookbackWindow

对于首次应用安装/首次网站访问以外的所有转化,应考虑将多久之前的事件纳入转化路径中。

枚举
OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_UNSPECIFIED 未指定回溯窗口大小。
OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_30_DAYS 30 天的回溯期。
OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_60_DAYS 60 天的回溯期。
OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_90_DAYS 90 天的回溯期。

ReportingAttributionModel

用于计算相应媒体资源报告中的转化功劳的报告归因模型。

枚举
REPORTING_ATTRIBUTION_MODEL_UNSPECIFIED 报告归因模型未指定。
PAID_AND_ORGANIC_CHANNELS_DATA_DRIVEN 以数据为依据的归因模型会根据每个转化事件的数据来分配转化功劳。每个广告客户和每个转化事件的以数据为依据的归因模型都各不相同。之前为 CROSS_CHANNEL_DATA_DRIVEN
PAID_AND_ORGANIC_CHANNELS_LAST_CLICK 忽略直接流量,并将 100% 的转化价值归因于客户在转化前点击访问的最后一个渠道(对于 YouTube,则为感兴趣的完整观看)。之前为 CROSS_CHANNEL_LAST_CLICK
GOOGLE_PAID_CHANNELS_LAST_CLICK 此模型会将 100% 的转化价值归因于客户在转化前点击访问的最后一个 Google 付费渠道。之前为 ADS_PREFERRED_LAST_CLICK

受众群体

表示受众群体的资源消息。

字段
name

string

仅限输出。相应受众群体资源的资源名称。格式:properties/{propertyId}/audiences/{audienceId}

display_name

string

必需。受众群体的显示名称。

description

string

必需。受众群体的说明。

membership_duration_days

int32

必需。不可变。用户应在受众群体中保留的时长。不能设置为超过 540 天。

ads_personalization_enabled

bool

仅限输出。如果这是 NPA 受众群体,并且已从广告个性化中排除,则 GA 会自动将其设置为 false。

event_trigger

AudienceEventTrigger

可选。指定在用户加入受众群体时要记录的事件。如果未设置,则在用户加入受众群体时不会记录任何事件。

exclusion_duration_mode

AudienceExclusionDurationMode

不可变。指定排除过滤器生效后,符合排除条件的用户会被排除多长时间。它适用于所有 EXCLUDE 过滤条件子句,如果受众群体中没有 EXCLUDE 过滤条件子句,则系统会忽略此参数。

filter_clauses[]

AudienceFilterClause

必需。不可变。无序列表。用于定义受众群体的过滤条件子句。所有子句之间都将采用 AND 逻辑关系。

create_time

Timestamp

仅限输出。受众群的创建时间。

AudienceExclusionDurationMode

指定排除过滤器生效后,符合排除条件的用户会被排除多长时间。

枚举
AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED 未指定。
EXCLUDE_TEMPORARILY 在用户符合过滤条件子句的时段内,从受众群体中排除相应用户。
EXCLUDE_PERMANENTLY 从受众群体中排除曾满足过滤条件子句的用户。

AudienceDimensionOrMetricFilter

针对单个维度或指标的特定过滤条件。

字段
field_name

string

必需。不可变。要过滤的维度名称或指标名称。如果字段名称是指自定义维度或指标,则会在自定义维度或指标名称前面添加范围前缀。如需详细了解范围前缀或自定义维度/指标,请参阅 Google Analytics Data API 文档

at_any_point_in_time

bool

可选。指示此过滤条件是否需要动态评估。如果设置为 true,则只要用户曾符合条件,就会将其纳入受众群体(静态评估)。如果未设置或设置为 false,则系统会根据受众群体条件动态评估用户。也就是说,系统会在用户符合条件时将其添加到受众群体中,然后当用户不再符合条件时将其移除。

只有在受众群体范围为 ACROSS_ALL_SESSIONS 时,才能设置此属性。

in_any_n_day_period

int32

可选。如果设置,则指定评估数据的时间窗口(以天为单位)。如果未设置,则会根据生命周期数据(例如无限时间窗口)评估受众群体数据。

例如,如果设置为 1 天,则仅评估当天的数据。如果未设置 at_any_point_in_time 或将其设置为 false,则参考点为当前日期。

只有在受众群体范围为 ACROSS_ALL_SESSIONS 时才能设置,且不能超过 60 天。

联合字段 one_filter。上述过滤条件之一。one_filter 只能是下列其中一项:
string_filter

StringFilter

用于过滤与特定模式匹配的字符串类型维度的过滤条件。

in_list_filter

InListFilter

与特定选项列表匹配的字符串维度过滤条件。

numeric_filter

NumericFilter

针对维度或指标的数值或日期值的过滤条件。

between_filter

BetweenFilter

一种过滤条件,用于过滤维度或指标上介于特定值之间的数值或日期值。

BetweenFilter

一种过滤条件,用于过滤维度或指标上介于特定值之间的数值或日期值。

字段
from_value

NumericValue

必需。以该数字开头(含)。

to_value

NumericValue

必需。以相应数字结尾(含)。

InListFilter

与特定选项列表匹配的字符串维度过滤条件。

字段
values[]

string

必需。要匹配的可能字符串值列表。不得为空。

case_sensitive

bool

可选。如果为 true,则匹配区分大小写。如果为 false,则匹配不区分大小写。

NumericFilter

针对维度或指标的数值或日期值的过滤条件。

字段
operation

Operation

必需。应用于数字过滤器的操作。

value

NumericValue

必需。要匹配的数值或日期值。

操作

应用于数字过滤器的操作。

枚举
OPERATION_UNSPECIFIED 未指定。
EQUAL 相等。
LESS_THAN 小于。
GREATER_THAN 大于。

NumericValue

表示一个数字。

字段
联合字段 one_value。数值之一。one_value 只能是下列其中一项:
int64_value

int64

整数值。

double_value

double

双精度值。

StringFilter

用于过滤与特定模式匹配的字符串类型维度的过滤条件。

字段
match_type

MatchType

必需。字符串过滤器的匹配类型。

value

string

必需。要匹配的字符串值。

case_sensitive

bool

可选。如果为 true,则匹配区分大小写。如果为 false,则匹配不区分大小写。

MatchType

字符串过滤器的匹配类型。

枚举
MATCH_TYPE_UNSPECIFIED 未指定
EXACT 字符串值完全匹配。
BEGINS_WITH 以字符串值开头。
ENDS_WITH 以字符串值结尾。
CONTAINS 包含字符串值。
FULL_REGEXP 正则表达式与字符串值完全匹配。

AudienceEventFilter

与具有单个事件名称的事件相匹配的过滤条件。如果指定了事件参数,则只有同时符合单个事件名称和参数过滤表达式的事件子集才符合此事件过滤条件。

字段
event_name

string

必需。不可变。要进行匹配的事件的名称。

event_parameter_filter_expression

AudienceFilterExpression

可选。如果指定,此过滤条件会匹配同时符合单个事件名称和参数过滤条件表达式的事件。无法在参数过滤条件表达式中设置 AudienceEventFilter(例如,不支持嵌套的事件过滤条件)。这应是 dimension_or_metric_filter 或 not_expression 的单个 and_group;不支持 OR 的 AND。此外,如果其中包含“eventCount”的过滤条件,系统将仅考虑该过滤条件,而忽略所有其他过滤条件。

AudienceEventTrigger

指定在用户加入受众群体时要记录的事件。

字段
event_name

string

必需。将记录的事件名称。

log_condition

LogCondition

必需。何时记录相应事件。

LogCondition

确定何时记录事件。

枚举
LOG_CONDITION_UNSPECIFIED 未指定日志条件。
AUDIENCE_JOINED 仅当用户加入时才应记录此事件。
AUDIENCE_MEMBERSHIP_RENEWED 每当用户满足受众群体条件时,都应记录相应事件,即使该用户已经是相应受众群体的成员也是如此。

AudienceFilterClause

用于定义简单过滤条件或序列过滤条件的子句。过滤条件可以是包含性过滤条件(例如,满足过滤条件子句的用户会包含在受众群体中),也可以是排除性过滤条件(例如,满足过滤条件子句的用户会从受众群体中排除)。

字段
clause_type

AudienceClauseType

必需。指定这是包含过滤条件子句还是排除过滤条件子句。

联合字段 filter

filter 只能是下列其中一项:

simple_filter

AudienceSimpleFilter

用户必须满足的简单过滤条件,才能成为相应受众群体的成员。

sequence_filter

AudienceSequenceFilter

用户必须按特定顺序满足的过滤条件,才能成为相应受众群体的成员。

AudienceClauseType

指定这是包含过滤条件子句还是排除过滤条件子句。

枚举
AUDIENCE_CLAUSE_TYPE_UNSPECIFIED 未指定的子句类型。
INCLUDE 如果用户满足过滤条件子句,系统会将相应用户纳入受众群体。
EXCLUDE 如果满足过滤条件子句,系统会将用户从受众群体中排除。

AudienceFilterExpression

受众群体维度、指标或事件过滤条件的逻辑表达式。

字段
联合字段 expr。应用于过滤器的表达式。expr 只能是下列其中一项:
and_group

AudienceFilterExpressionList

要进行 AND 运算的表达式列表。只能包含带有 or_group 的 AudienceFilterExpressions。必须为顶级 AudienceFilterExpression 设置此属性。

or_group

AudienceFilterExpressionList

要使用 OR 运算符组合在一起的表达式列表。它不能包含具有 and_group 或 or_group 的 AudienceFilterExpressions。

not_expression

AudienceFilterExpression

要进行 NOT 运算(例如,取反、求补)的过滤条件表达式。它只能包含 dimension_or_metric_filter。无法在顶级 AudienceFilterExpression 上设置此属性。

dimension_or_metric_filter

AudienceDimensionOrMetricFilter

针对单个维度或指标的过滤条件。无法在顶级 AudienceFilterExpression 上设置此属性。

event_filter

AudienceEventFilter

创建一个与特定事件匹配的过滤条件。无法在顶级 AudienceFilterExpression 上设置此属性。

AudienceFilterExpressionList

受众群体过滤条件表达式的列表。

字段
filter_expressions[]

AudienceFilterExpression

受众群体过滤条件表达式的列表。

AudienceFilterScope

指定如何评估用户是否符合加入受众群体的条件。

枚举
AUDIENCE_FILTER_SCOPE_UNSPECIFIED 未指定范围。
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT 如果用户在一次事件中满足过滤条件,则会加入相应受众群体。
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION 如果用户在一个会话中满足过滤条件,则会加入相应受众群体。
AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS 如果任何会话中的任何事件满足过滤条件,用户就会加入相应受众群体。

AudienceSequenceFilter

定义必须按特定顺序发生的过滤条件,用户满足这些条件才能成为相应受众群体的成员。

字段
scope

AudienceFilterScope

必需。不可变。指定相应过滤器的范围。

sequence_maximum_duration

Duration

可选。定义整个序列必须在什么时间段内完成。

sequence_steps[]

AudienceSequenceStep

必需。一系列有序的步骤。用户必须完成每个步骤,才能加入序列过滤条件。

AudienceSequenceStep

用户必须按指定步骤顺序满足的条件,才能与相应序列匹配。

字段
scope

AudienceFilterScope

必需。不可变。指定相应步骤的范围。

immediately_follows

bool

可选。如果为 true,则满足此步骤的事件必须是满足上一步骤的事件之后的下一个事件。如果未设置或为 false,则此步骤间接后跟上一步骤;例如,上一步骤与此步骤之间可能存在事件。在第一步中,系统会忽略此参数。

constraint_duration

Duration

可选。如果设置了此值,则必须在上一作业步的 constraint_duration 内满足此作业步(例如,t[i] - t[i-1] <= constraint_duration)。如果未设置,则没有时长要求(时长实际上不受限制)。在第一步中,系统会忽略此参数。

filter_expression

AudienceFilterExpression

必需。不可变。每个步骤中受众群体维度、指标或事件过滤条件的逻辑表达式。

AudienceSimpleFilter

定义用户必须满足的简单过滤条件,才能成为相应受众群体的成员。

字段
scope

AudienceFilterScope

必需。不可变。指定相应过滤器的范围。

filter_expression

AudienceFilterExpression

必需。不可变。受众群体维度、指标或事件过滤条件的逻辑表达式。

BatchCreateAccessBindingsRequest

针对 BatchCreateAccessBindings RPC 的请求消息。

字段
parent

string

必需。拥有访问权限绑定的账号或媒体资源。CreateAccessBindingRequest 消息中的父字段必须为空或与此字段匹配。格式:- accounts/{account} - properties/{property}

requests[]

CreateAccessBindingRequest

必需。指定要创建的访问权限绑定的请求。一次最多可以创建 1,000 个访问权限绑定。

BatchCreateAccessBindingsResponse

针对 BatchCreateAccessBindings RPC 的响应消息。

字段
access_bindings[]

AccessBinding

创建的访问权限绑定。

BatchDeleteAccessBindingsRequest

针对 BatchDeleteAccessBindings RPC 的请求消息。

字段
parent

string

必需。拥有访问权限绑定的账号或媒体资源。DeleteAccessBindingRequest 消息中“names”字段的所有提供的值的父级都必须与此字段匹配。格式:- accounts/{account} - properties/{property}

requests[]

DeleteAccessBindingRequest

必需。指定要删除的访问权限绑定的请求。一次最多可以批量删除 1,000 个访问权限绑定。

BatchGetAccessBindingsRequest

针对 BatchGetAccessBindings RPC 的请求消息。

字段
parent

string

必需。拥有访问权限绑定的账号或媒体资源。“names”字段的所有提供的值的父级必须与此字段匹配。格式:- accounts/{account} - properties/{property}

names[]

string

必需。要检索的访问权限绑定的名称。一次最多可检索 1,000 个访问权限绑定。格式:- accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}

BatchGetAccessBindingsResponse

针对 BatchGetAccessBindings RPC 的响应消息。

字段
access_bindings[]

AccessBinding

请求的访问权限绑定。

BatchUpdateAccessBindingsRequest

针对 BatchUpdateAccessBindings RPC 的请求消息。

字段
parent

string

必需。拥有访问权限绑定的账号或媒体资源。UpdateAccessBindingRequest 消息中提供的所有 AccessBinding 的父级都必须与此字段匹配。格式:- accounts/{account} - properties/{property}

requests[]

UpdateAccessBindingRequest

必需。指定要更新的访问权限绑定的请求。一次最多可更新 1,000 个访问权限绑定。

BatchUpdateAccessBindingsResponse

针对 BatchUpdateAccessBindings RPC 的响应消息。

字段
access_bindings[]

AccessBinding

访问权限绑定已更新。

CalculatedMetric

计算指标的定义。

字段
name

string

仅限输出。相应 CalculatedMetric 的资源名称。格式:'properties/{property_id}/calculatedMetrics/{calculated_metric_id}'

description

string

可选。相应计算指标的说明。长度上限为 4096 个字符。

display_name

string

必需。相应计算指标的显示名称,如 Google Analytics 界面中所示。长度上限为 82 个字符。

calculated_metric_id

string

仅限输出。要用于计算指标的 ID。在界面中,此字段称为“API 名称”。

从外部 API 引用此计算指标时,会使用 calculated_metric_id。例如,“calcMetric:{calculated_metric_id}”。

metric_unit

MetricUnit

必需。计算型指标的值类型。

restricted_metric_type[]

RestrictedMetricType

仅限输出。相应指标包含的受限数据类型。

formula

string

必需。计算指标的定义。引用的唯一自定义指标数量上限为 5。公式支持以下运算:+(加法)、-(减法)、-(负数)、*(乘法)、/(除法)、()(括号)。任何有效的实数都可以接受,只要它们适合 Long(64 位整数)或 Double(64 位浮点数)。示例公式:“( customEvent:parameter_name + cartPurchaseQuantity ) / 2.0”

invalid_metric_reference

bool

仅限输出。如果为 true,则表示此计算指标具有无效的指标引用。任何使用将 invalid_metric_reference 设置为 true 的计算指标的查询都可能会失败、生成警告或生成意外结果。

MetricUnit

表示计算出的指标值的可能类型。

枚举
METRIC_UNIT_UNSPECIFIED MetricUnit 未指定或缺失。
STANDARD 此指标使用默认单位。
CURRENCY 此指标衡量的是币种。
FEET 此指标以英尺为单位。
MILES 此指标以英里为单位。
METERS 此指标以米为单位。
KILOMETERS 此指标以公里为单位。
MILLISECONDS 此指标以毫秒为单位。
SECONDS 此指标以秒为单位。
MINUTES 此指标以分钟为单位。
HOURS 此指标以小时为单位。

RestrictedMetricType

用于标记计算指标中的数据的标签,与限制对费用和/或收入指标的访问权限的用户角色搭配使用。

枚举
RESTRICTED_METRIC_TYPE_UNSPECIFIED 类型未知或未指定。
COST_DATA 指标报告费用数据。
REVENUE_DATA 报告收入数据的指标。

CancelDisplayVideo360AdvertiserLinkProposalRequest

针对 CancelDisplayVideo360AdvertiserLinkProposal RPC 的请求消息。

字段
name

string

必需。要取消的 DisplayVideo360AdvertiserLinkProposal 的名称。示例格式:properties/1234/displayVideo360AdvertiserLinkProposals/5678

ChangeHistoryChange

对单个 Google Analytics 资源所做更改的说明。

字段
resource

string

相应条目描述的资源的资源名称。

action

ActionType

更改相应资源的操作类型。

resource_before_change

ChangeHistoryResource

更改之前的资源内容。如果相应资源是在此更改中创建的,则此字段将缺失。

resource_after_change

ChangeHistoryResource

更改后的资源内容。如果相应资源在此更改中被删除,则此字段将缺失。

ChangeHistoryResource

资源在更改历史记录中的更改结果之前或之后的快照。

字段

联合字段 resource

resource 只能是下列其中一项:

account

Account

更改历史记录中账号资源的快照。

property

Property

更改历史记录中的媒体资源资源快照。

google_signals_settings

GoogleSignalsSettings

更改历史记录中的 GoogleSignalsSettings 资源快照。

conversion_event

ConversionEvent

更改历史记录中 ConversionEvent 资源的快照。

measurement_protocol_secret

MeasurementProtocolSecret

更改历史记录中 MeasurementProtocolSecret 资源的快照。

custom_dimension

CustomDimension

更改历史记录中 CustomDimension 资源的快照。

custom_metric

CustomMetric

更改历史记录中 CustomMetric 资源的快照。

data_retention_settings

DataRetentionSettings

变更历史记录中的数据保留设置资源快照。

data_stream

DataStream

变更历史记录中 DataStream 资源的快照。

attribution_settings

AttributionSettings

更改历史记录中的 AttributionSettings 资源快照。

expanded_data_set

ExpandedDataSet

更改历史记录中 ExpandedDataSet 资源的快照。

channel_group

ChannelGroup

更改历史记录中的 ChannelGroup 资源快照。

enhanced_measurement_settings

EnhancedMeasurementSettings

更改历史记录中 EnhancedMeasurementSettings 资源的快照。

data_redaction_settings

DataRedactionSettings

更改历史记录中 DataRedactionSettings 资源的快照。

skadnetwork_conversion_value_schema

SKAdNetworkConversionValueSchema

更改历史记录中 SKAdNetworkConversionValueSchema 资源的快照。

audience

Audience

更改历史记录中的 Audience 资源快照。

event_create_rule

EventCreateRule

更改历史记录中 EventCreateRule 资源的快照。

key_event

KeyEvent

更改历史记录中的 KeyEvent 资源快照。

calculated_metric

CalculatedMetric

更改历史记录中 CalculatedMetric 资源的快照。

reporting_data_annotation

ReportingDataAnnotation

更改历史记录中的 ReportingDataAnnotation 资源快照。

subproperty_sync_config

SubpropertySyncConfig

更改历史记录中的 SubpropertySyncConfig 资源快照。

reporting_identity_settings

ReportingIdentitySettings

更改历史记录中的 ReportingIdentitySettings 资源快照。

ChangeHistoryEvent

Google Analytics 账号或其子媒体资源中因同一原因而发生的一组变化。常见原因包括在 Google Analytics 界面中进行的更新、客户支持人员所做的更改,或 Google Analytics 系统自动进行的更改。

字段
id

string

相应更改历史记录事件的 ID。此 ID 在整个 Google Analytics 中是唯一的。

change_time

Timestamp

做出更改的时间。

actor_type

ActorType

进行相应更改的参与者类型。

user_actor_email

string

做出更改的 Google 账号的电子邮件地址。如果 actor 字段设置为 USER,则此字段将为有效的电子邮件地址;否则,此字段为空。已删除的 Google 账号会导致错误。

changes_filtered

bool

如果为 true,则表示返回的更改列表经过过滤,不代表相应事件中发生的所有更改。

changes[]

ChangeHistoryChange

相应更改历史记录事件中符合 SearchChangeHistoryEventsRequest 中指定过滤条件的更改列表。

ChangeHistoryResourceType

可从更改历史记录中返回其更改的资源类型。

枚举
CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED 资源类型未知或未指定。
ACCOUNT 账号资源
PROPERTY 媒体资源
GOOGLE_SIGNALS_SETTINGS GoogleSignalsSettings 资源
CONVERSION_EVENT ConversionEvent 资源
MEASUREMENT_PROTOCOL_SECRET MeasurementProtocolSecret 资源
CUSTOM_DIMENSION CustomDimension 资源
CUSTOM_METRIC CustomMetric 资源
DATA_RETENTION_SETTINGS DataRetentionSettings 资源
DATA_STREAM DataStream 资源
ATTRIBUTION_SETTINGS AttributionSettings 资源
EXPANDED_DATA_SET ExpandedDataSet 资源
CHANNEL_GROUP ChannelGroup 资源
ENHANCED_MEASUREMENT_SETTINGS EnhancedMeasurementSettings 资源
DATA_REDACTION_SETTINGS DataRedactionSettings 资源
SKADNETWORK_CONVERSION_VALUE_SCHEMA SKAdNetworkConversionValueSchema 资源
AUDIENCE 受众群体资源
EVENT_CREATE_RULE EventCreateRule 资源
KEY_EVENT KeyEvent 资源
CALCULATED_METRIC CalculatedMetric 资源
REPORTING_DATA_ANNOTATION ReportingDataAnnotation 资源
SUBPROPERTY_SYNC_CONFIG SubpropertySyncConfig 资源
REPORTING_IDENTITY_SETTINGS ReportingIdentitySettings 资源

ChannelGroup

表示渠道组的资源消息。

字段
name

string

仅限输出。相应频道组资源的资源名称。格式:properties/{property}/channelGroups/{channel_group}

display_name

string

必需。渠道组的显示名称。长度上限为 80 个字符。

description

string

渠道组的说明。长度上限为 256 个字符。

grouping_rule[]

GroupingRule

必需。渠道的分组规则。规则数量上限为 50。

system_defined

bool

仅限输出。如果为 true,则表示相应渠道组是 Google Analytics 预定义的默认渠道组。无法更新此渠道组的显示名称和分组规则。

primary

bool

可选。如果为 true,则此渠道组将用作报告的默认渠道组。任何时候都只能将一个频道组设置为 primary。如果为某个渠道组设置了 primary 字段,则会取消为之前的主要渠道组设置的该字段。

默认情况下,Google Analytics 预定义的渠道组是主要渠道组。

ChannelGroupFilter

针对单个维度的特定过滤条件。

字段
field_name

string

必需。不可变。要过滤的维度名称。

联合字段 value_filter。用于定义此过滤器的行为的 StringFilter 或 InListFilter。value_filter 只能是下列其中一项:
string_filter

StringFilter

用于过滤与特定模式匹配的字符串类型维度的过滤条件。

in_list_filter

InListFilter

与特定选项列表匹配的字符串维度过滤条件。

InListFilter

一种过滤条件,用于过滤与特定选项列表匹配的字符串维度。匹配项不区分大小写。

字段
values[]

string

必需。要匹配的可能字符串值列表。不得为空。

StringFilter

过滤条件为字段值是字符串。匹配项不区分大小写。

字段
match_type

MatchType

必需。字符串过滤器的匹配类型。

value

string

必需。要匹配的字符串值。

MatchType

过滤条件将如何用于确定是否匹配。

枚举
MATCH_TYPE_UNSPECIFIED 默认匹配类型。
EXACT 字符串值完全匹配。
BEGINS_WITH 以字符串值开头。
ENDS_WITH 以字符串值结尾。
CONTAINS 包含字符串值。
FULL_REGEXP 与字符串值完全匹配的正则表达式。
PARTIAL_REGEXP 与字符串值部分匹配的正则表达式。

ChannelGroupFilterExpression

渠道组维度过滤条件的逻辑表达式。

字段
联合字段 expr。应用于过滤器的表达式。expr 只能是下列其中一项:
and_group

ChannelGroupFilterExpressionList

要进行 AND 运算的表达式列表。只能包含带有 or_group 的 ChannelGroupFilterExpressions。必须为顶级 ChannelGroupFilterExpression 设置此属性。

or_group

ChannelGroupFilterExpressionList

要使用 OR 运算符组合在一起的表达式列表。它不能包含带有 and_group 或 or_group 的 ChannelGroupFilterExpressions。

not_expression

ChannelGroupFilterExpression

要进行 NOT 运算(即反转、求补)的过滤条件表达式。它只能包含 dimension_or_metric_filter。无法在顶级 ChannelGroupFilterExpression 上设置此属性。

filter

ChannelGroupFilter

针对单个维度的过滤条件。无法在顶级 ChannelGroupFilterExpression 上设置此属性。

ChannelGroupFilterExpressionList

渠道组过滤条件表达式的列表。

字段
filter_expressions[]

ChannelGroupFilterExpression

渠道组过滤条件表达式的列表。

CoarseValue

在满足 ConversionValues.event_mappings 条件时,在 updatePostbackConversionValue SDK 调用中设置的粗略转化价值。如需了解详情,请参阅 SKAdNetwork.CoarseConversionValue

枚举
COARSE_VALUE_UNSPECIFIED 未指定粗略值。
COARSE_VALUE_LOW 粗略价值为低。
COARSE_VALUE_MEDIUM 媒体的粗略价值。
COARSE_VALUE_HIGH 粗略值高。

ConversionEvent

Google Analytics 媒体资源中的转化事件。

字段
name

string

仅限输出。相应转化事件的资源名称。格式:properties/{property}/conversionEvents/{conversion_event}

event_name

string

不可变。相应转化事件的事件名称。示例:“点击”“购买”

create_time

Timestamp

仅限输出。相应转化事件在媒体资源中创建的时间。

deletable

bool

仅限输出。如果已设置,则目前可以使用 DeleteConversionEvent 删除此事件。

custom

bool

仅限输出。如果设置为 true,则表示相应转化事件是指自定义事件。如果设置为 false,则此转化事件是指 Google Analytics 中的默认事件。默认事件通常在 Google Analytics 中具有特殊含义。默认事件通常由 Google Analytics 系统为您创建,但在某些情况下,也可以由媒体资源管理员创建。自定义事件会纳入每个媒体资源可创建的自定义转化事件数量上限。

counting_method

ConversionCountingMethod

可选。在一次会话中,统计多次事件转化所用的方法。如果未提供此值,则会将其设置为 ONCE_PER_EVENT

default_conversion_value

DefaultConversionValue

可选。为转化事件定义默认价值/币种。

ConversionCountingMethod

在一次会话中,统计多次事件转化所用的方法。

枚举
CONVERSION_COUNTING_METHOD_UNSPECIFIED 未指定统计方法。
ONCE_PER_EVENT 每个事件实例都被视为一次转化。
ONCE_PER_SESSION 每个用户在每次会话中最多只能将一个事件实例视为一次转化。

DefaultConversionValue

为转化事件定义默认价值/币种。必须同时提供值和币种。

字段
value

double

此值将用于填充指定 event_name 的所有转化(其中事件“value”参数未设置)的值。

currency_code

string

如果具有相应 event_name 的转化事件未设置币种,系统会将此币种应用为默认币种。必须采用 ISO 4217 货币代码格式。如需了解详情,请参阅 https://en.wikipedia.org/wiki/ISO_4217

ConversionValues

SKAdNetwork 转化价值架构的回传时间范围的转化价值设置。

字段
display_name

string

SKAdNetwork 转化价值的显示名称。允许的显示名称长度上限为 50 个 UTF-16 代码单元。

coarse_value

CoarseValue

必需。粗略转化价值。

此值不能保证是唯一的。

event_mappings[]

EventMapping

实现此转化价值必须满足的事件条件。此列表中的条件之间存在 AND 关系。如果启用了回发窗口,则必须至少包含 1 个条目,最多包含 3 个条目。

lock_enabled

bool

如果为 true,SDK 应在当前回传时间范围内锁定为此转化价值。

fine_value

int32

精细转化价值。此属性仅适用于第一个回发窗口。其有效值为 [0,63],包括 0 和 63。必须为回传时间范围 1 设置此字段,但不得为回传时间范围 2 和 3 设置此字段。此值不能保证是唯一的。

如果第一个回传时间范围的配置被重复用于第二个或第三个回传时间范围,则此字段无效。

CreateAccessBindingRequest

针对 CreateAccessBinding RPC 的请求消息。

字段
parent

string

必需。格式:- accounts/{account} - properties/{property}

access_binding

AccessBinding

必需。要创建的访问权限绑定。

CreateAdSenseLinkRequest

要传递给 CreateAdSenseLink 方法的请求消息。

字段
parent

string

必需。要为其创建 AdSense 关联的媒体资源。格式:properties/{propertyId} 示例:properties/1234

CreateAudienceRequest

CreateAudience RPC 的请求消息。

字段
parent

string

必需。示例格式:properties/1234

audience

Audience

必需。要创建的受众群体。

CreateBigQueryLinkRequest

针对 CreateBigQueryLink RPC 的请求消息。

字段
parent

string

必需。示例格式:properties/1234

CreateCalculatedMetricRequest

针对 CreateCalculatedMetric RPC 的请求消息。

字段
parent

string

必需。格式:properties/{property_id} 示例:properties/1234

calculated_metric_id

string

必需。要用于计算指标的 ID,该 ID 将成为计算指标资源名称的最后一个组成部分。

此值应为 1-80 个字符,有效字符为 /[a-zA-Z0-9_]/,不允许使用空格。calculated_metric_id 在一个媒体资源的所有计算型指标中必须是唯一的。从外部 API(例如“calcMetric:{calculated_metric_id}”)引用此计算指标时,会使用 calculated_metric_id。

calculated_metric

CalculatedMetric

必需。要创建的 CalculatedMetric。

CreateChannelGroupRequest

针对 CreateChannelGroup RPC 的请求消息。

字段
parent

string

必需。要为其创建 ChannelGroup 的媒体资源。示例格式:properties/1234

channel_group

ChannelGroup

必需。要创建的 ChannelGroup。

CreateConversionEventRequest

CreateConversionEvent RPC 的请求消息

字段
conversion_event

ConversionEvent

必需。要创建的转化事件。

parent

string

必需。将创建相应转化事件的父媒体资源的资源名称。格式:properties/123

CreateCustomDimensionRequest

针对 CreateCustomDimension RPC 的请求消息。

字段
parent

string

必需。示例格式:properties/1234

custom_dimension

CustomDimension

必需。要创建的 CustomDimension。

CreateCustomMetricRequest

针对 CreateCustomMetric RPC 的请求消息。

字段
parent

string

必需。示例格式:properties/1234

custom_metric

CustomMetric

必需。要创建的 CustomMetric。

CreateDataStreamRequest

针对 CreateDataStream RPC 的请求消息。

字段
parent

string

必需。示例格式:properties/1234

data_stream

DataStream

必需。要创建的 DataStream。

CreateDisplayVideo360AdvertiserLinkProposalRequest

针对 CreateDisplayVideo360AdvertiserLinkProposal RPC 的请求消息。

字段
parent

string

必需。示例格式:properties/1234

CreateDisplayVideo360AdvertiserLinkRequest

针对 CreateDisplayVideo360AdvertiserLink RPC 的请求消息。

字段
parent

string

必需。示例格式:properties/1234

CreateEventCreateRuleRequest

CreateEventCreateRule RPC 的请求消息。

字段
parent

string

必需。示例格式:properties/123/dataStreams/456

event_create_rule

EventCreateRule

必需。要创建的 EventCreateRule。

CreateEventEditRuleRequest

针对 CreateEventEditRule RPC 的请求消息。

字段
parent

string

必需。示例格式:properties/123/dataStreams/456

event_edit_rule

EventEditRule

必需。要创建的 EventEditRule。

CreateExpandedDataSetRequest

针对 CreateExpandedDataSet RPC 的请求消息。

字段
parent

string

必需。示例格式:properties/1234

expanded_data_set

ExpandedDataSet

必需。要创建的 ExpandedDataSet。

CreateFirebaseLinkRequest

针对 CreateFirebaseLink RPC 的请求消息

字段
parent

string

必需。格式:properties/{property_id}

示例:properties/1234

CreateGoogleAdsLinkRequest

针对 CreateGoogleAdsLink RPC 的请求消息

字段
parent

string

必需。示例格式:properties/1234

CreateKeyEventRequest

针对 CreateKeyEvent RPC 的请求消息

字段
key_event

KeyEvent

必需。要创建的关键事件。

parent

string

必需。将创建相应键事件的父级属性的资源名称。格式:properties/123

CreateMeasurementProtocolSecretRequest

针对 CreateMeasurementProtocolSecret RPC 的请求消息

字段
parent

string

必需。将创建相应 Secret 的父资源。格式:properties/{property}/dataStreams/{dataStream}

measurement_protocol_secret

MeasurementProtocolSecret

必需。要创建的 Measurement Protocol Secret。

CreatePropertyRequest

针对 CreateProperty RPC 的请求消息。

字段
property

Property

必需。要创建的媒体资源。注意:所提供的属性必须指定其父级。

CreateReportingDataAnnotationRequest

针对 CreateReportingDataAnnotation RPC 的请求消息。

字段
parent

string

必需。要为其创建报告数据注释的媒体资源。格式:properties/property_id 示例:properties/123

reporting_data_annotation

ReportingDataAnnotation

必需。要创建的报告数据注释。

CreateRollupPropertyRequest

针对 CreateRollupProperty RPC 的请求消息。

字段
rollup_property

Property

必需。要创建的总览媒体资源。

source_properties[]

string

可选。将作为所创建的总览媒体资源来源的媒体资源的资源名称。

CreateRollupPropertyResponse

针对 CreateRollupProperty RPC 的响应消息。

字段
rollup_property

Property

创建的总览媒体资源。

CreateRollupPropertySourceLinkRequest

针对 CreateRollupPropertySourceLink RPC 的请求消息。

字段
parent

string

必需。格式:properties/{property_id} 示例:properties/1234

CreateSKAdNetworkConversionValueSchemaRequest

针对 CreateSKAdNetworkConversionValueSchema RPC 的请求消息。

字段
parent

string

必需。将创建相应架构的父资源。格式:properties/{property}/dataStreams/{dataStream}

skadnetwork_conversion_value_schema

SKAdNetworkConversionValueSchema

必需。要创建的 SKAdNetwork 转化价值架构。

CreateSearchAds360LinkRequest

针对 CreateSearchAds360Link RPC 的请求消息。

字段
parent

string

必需。示例格式:properties/1234

CreateSubpropertyEventFilterRequest

针对 CreateSubpropertyEventFilter RPC 的请求消息。

字段
parent

string

必需。要为其创建子媒体资源事件过滤器的常规媒体资源。格式:properties/property_id 示例:properties/123

subproperty_event_filter

SubpropertyEventFilter

必需。要创建的子媒体资源事件过滤器。

CustomDimension

CustomDimension 的定义。

字段
name

string

仅限输出。相应 CustomDimension 资源的资源名称。格式:properties/{property}/customDimensions/{customDimension}

parameter_name

string

必需。不可变。相应自定义维度的标记参数名称。

如果这是用户级范围的维度,则这是用户属性名称。如果这是事件级范围的维度,则这是事件参数名称。

如果这是商品级范围的维度,则这是在电子商务 items 数组中找到的参数名称。

只能包含字母数字字符和下划线,且必须以字母开头。用户级范围的维度的长度上限为 24 个字符,事件级范围的维度的长度上限为 40 个字符。

display_name

string

必需。相应自定义维度在 Google Analytics 界面中显示的名称。最长 82 个字符,字母数字字符加空格和下划线,以字母开头。旧版系统生成的显示名称可能包含方括号,但此字段的更新绝不允许包含方括号。

description

string

可选。相应自定义维度的说明。长度上限为 150 个字符。

scope

DimensionScope

必需。不可变。相应维度的范围。

disallow_ads_personalization

bool

可选。如果设置为 true,则将相应维度设置为 NPA,并将其从广告个性化中排除。

目前仅支持用户级范围的自定义维度。

DimensionScope

相应维度的有效范围值。

枚举
DIMENSION_SCOPE_UNSPECIFIED 范围未知或未指定。
EVENT 限定于事件的维度。
USER 用户级范围的维度。
ITEM 范围限定为电子商务商品的维度

CustomMetric

自定义指标的定义。

字段
name

string

仅限输出。相应 CustomMetric 资源的资源名称。格式:properties/{property}/customMetrics/{customMetric}

parameter_name

string

必需。不可变。相应自定义指标的标记名称。

如果这是事件级范围的指标,则这是事件参数名称。

只能包含字母数字字符和下划线,且必须以字母开头。事件级范围的指标的长度上限为 40 个字符。

display_name

string

必需。相应自定义指标在 Google Analytics 界面中显示的名称。最长 82 个字符,字母数字字符加空格和下划线,以字母开头。旧版系统生成的显示名称可能包含方括号,但此字段的更新绝不允许包含方括号。

description

string

可选。相应自定义维度的说明。长度上限为 150 个字符。

measurement_unit

MeasurementUnit

必需。自定义指标的值的类型。

scope

MetricScope

必需。不可变。相应自定义指标的范围。

restricted_metric_type[]

RestrictedMetricType

可选。相应指标可能包含的受限数据类型。对于具有 CURRENCY 衡量单位的指标,此属性是必需的。对于具有非 CURRENCY 衡量单位的指标,该值必须为空。

MeasurementUnit

表示自定义指标值的可能类型。

货币表示形式将来可能会发生变化,从而需要进行重大 API 更改。

枚举
MEASUREMENT_UNIT_UNSPECIFIED 未指定或缺少 MeasurementUnit。
STANDARD 此指标使用默认单位。
CURRENCY 此指标衡量的是币种。
FEET 此指标以英尺为单位。
METERS 此指标以米为单位。
KILOMETERS 此指标以公里为单位。
MILES 此指标以英里为单位。
MILLISECONDS 此指标以毫秒为单位。
SECONDS 此指标以秒为单位。
MINUTES 此指标以分钟为单位。
HOURS 此指标以小时为单位。

MetricScope

相应指标的范围。

枚举
METRIC_SCOPE_UNSPECIFIED 范围未知或未指定。
EVENT 限定于事件的指标。

RestrictedMetricType

用于将相应自定义指标中的数据标记为应仅限特定用户访问的数据的标签。

枚举
RESTRICTED_METRIC_TYPE_UNSPECIFIED 类型未知或未指定。
COST_DATA 指标报告费用数据。
REVENUE_DATA 报告收入数据的指标。

DataRedactionSettings

客户端数据隐去设置。Web 数据流下的单例资源。

字段
name

string

仅限输出。相应数据编辑设置资源的名称。格式:properties/{property_id}/dataStreams/{data_stream}/dataRedactionSettings 示例:“properties/1000/dataStreams/2000/dataRedactionSettings”

email_redaction_enabled

bool

如果启用,系统会隐去任何看起来像电子邮件地址的事件参数或用户属性值。

query_parameter_redaction_enabled

bool

如果查询参数位于配置的查询参数集中,查询参数修订会移除该查询参数的键和值部分。

如果启用,系统将针对相应媒体资源运行网址查询替换逻辑。系统会对 query_parameter_keys 中定义的任何查询参数进行编辑。

query_parameter_keys[]

string

如果网址中存在这些查询参数键,则对其应用隐去逻辑。查询参数匹配不区分大小写。

如果 query_parameter_replacement_enabled 为 true,则必须包含至少一个元素。键不能包含逗号。

DataRetentionSettings

数据保留的设置值。这是单例资源。

字段
name

string

仅限输出。相应 DataRetentionSetting 资源的资源名称。格式:properties/{property}/dataRetentionSettings

event_data_retention

RetentionDuration

必需。事件级数据的保留时长。

user_data_retention

RetentionDuration

必需。用户级数据的保留期限。

reset_user_data_on_new_activity

bool

如果为 true,则每当用户有新的事件发生,系统就会重置该用户的标识符的保留期限。

RetentionDuration

数据保留时长的有效值。

枚举
RETENTION_DURATION_UNSPECIFIED 未指定数据保留时间时长。
TWO_MONTHS 数据保留时长为 2 个月。
FOURTEEN_MONTHS 数据保留时长为 14 个月。
TWENTY_SIX_MONTHS 数据保留时间为 26 个月。仅适用于 360 媒体资源。仅适用于事件数据。
THIRTY_EIGHT_MONTHS 数据保留时长为 38 个月。仅适用于 360 媒体资源。仅适用于事件数据。
FIFTY_MONTHS 数据保留时长为 50 个月。仅适用于 360 媒体资源。仅适用于事件数据。

DataSharingSettings

一种资源消息,用于表示 Google Analytics 账号的数据共享设置。

字段
name

string

仅限输出。资源名称。格式:accounts/{account}/dataSharingSettings 示例:“accounts/1000/dataSharingSettings”

sharing_with_google_support_enabled

bool

允许 Google 技术支持服务代表在必要时访问您的 Google Analytics 数据和账号,以提供服务和寻找技术问题的解决办法。

此字段对应于 Google Analytics 管理界面中的“技术支持”字段。

sharing_with_google_assigned_sales_enabled

bool

允许 Google 访问您的 Google Analytics 账号数据,包括账号使用情况和配置数据、产品支出以及与您的 Google Analytics 账号关联的用户,以便 Google 帮助您充分利用各种 Google 产品,并为您提供有关 Google Analytics 和其他 Google 商业产品的数据洞见、优惠、建议和优化提示。

此字段会映射到 Google Analytics 管理界面中的“业务建议”字段。

sharing_with_google_any_sales_enabled
(deprecated)

bool

已弃用。此字段不再使用,并且始终返回 false。

sharing_with_google_products_enabled

bool

允许 Google 使用这些数据来改进其他 Google 产品或服务。

此字段对应于 Google Analytics 管理界面中的“Google 产品和服务”字段。

sharing_with_others_enabled

bool

如果选择贡献汇总的衡量数据,即可启用预测、模型估算和基准化分析等功能,获得更丰富的业务数据洞见。您共享的数据(包括数据共享来源媒体资源的有关信息)将会进行汇总和去标识化处理,然后才会用于生成业务数据洞见。

此字段对应于 Google Analytics 管理界面中的“根据模型估算贡献数据和业务数据洞见”字段。

DataStream

表示数据流的资源消息。

字段
name

string

仅限输出。相应数据流的资源名称。格式:properties/{property_id}/dataStreams/{stream_id} 示例:“properties/1000/dataStreams/2000”

type

DataStreamType

必需。不可变。相应 DataStream 资源的类型。

display_name

string

数据源的直观易懂的显示名称。

对于网站数据流,此参数是必需的。

允许的显示名称长度上限为 255 个 UTF-16 代码单元。

create_time

Timestamp

仅限输出。相应数据流最初创建的时间。

update_time

Timestamp

仅限输出。数据流载荷字段的上次更新时间。

联合字段 stream_data。特定数据流类型的数据。将设置的消息与此流的类型相对应。stream_data 只能是下列其中一项:
web_stream_data

WebStreamData

特定于网站数据流的数据。如果类型为 WEB_DATA_STREAM,则必须填充此字段。

android_app_stream_data

AndroidAppStreamData

Android 应用数据流的特定数据。如果类型为 ANDROID_APP_DATA_STREAM,则必须填充此字段。

ios_app_stream_data

IosAppStreamData

特定于 iOS 应用数据流的数据。如果类型为 IOS_APP_DATA_STREAM,则必须填充此字段。

AndroidAppStreamData

Android 应用数据流的特定数据。

字段
firebase_app_id

string

仅限输出。相应 Android 应用在 Firebase 中的 ID(如有)。如果 Android 应用被删除并重新创建,此 ID 可能会发生变化。

package_name

string

不可变。正在衡量的应用的软件包名称。示例:“com.example.myandroidapp”

DataStreamType

数据流的类型。

枚举
DATA_STREAM_TYPE_UNSPECIFIED 类型未知或未指定。
WEB_DATA_STREAM 网站数据流。
ANDROID_APP_DATA_STREAM Android 应用数据流。
IOS_APP_DATA_STREAM iOS 应用数据流。

IosAppStreamData

特定于 iOS 应用数据流的数据。

字段
firebase_app_id

string

仅限输出。相应 iOS 应用在 Firebase 中的 ID(如有)。如果 iOS 应用被删除并重新创建,此 ID 可能会发生变化。

bundle_id

string

必需。不可变。应用的 Apple App Store 软件包 ID。示例:“com.example.myiosapp”

WebStreamData

特定于网站数据流的数据。

字段
measurement_id

string

仅限输出。Google Analytics 衡量 ID。

示例:“G-1A2BCD345E”

firebase_app_id

string

仅限输出。相应 Web 应用在 Firebase 中的 ID(如有)。如果删除并重新创建 Web 应用,此 ID 可能会发生变化。

default_uri

string

所衡量 Web 应用的域名,或为空。示例:“http://www.google.com”“https://www.google.com”

DeleteAccessBindingRequest

针对 DeleteAccessBinding RPC 的请求消息。

字段
name

string

必需。格式:- accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}

DeleteAccountRequest

针对 DeleteAccount RPC 的请求消息。

字段
name

string

必需。要软删除的账号的名称。格式:accounts/{account} 示例:“accounts/100”

DeleteAdSenseLinkRequest

要传递给 DeleteAdSenseLink 方法的请求消息。

字段
name

string

必需。要删除的 AdSense 关联的唯一标识符。格式:properties/{propertyId}/adSenseLinks/{linkId} 示例:properties/1234/adSenseLinks/5678

DeleteBigQueryLinkRequest

针对 DeleteBigQueryLink RPC 的请求消息。

字段
name

string

必需。要删除的 BigQueryLink。示例格式:properties/1234/bigQueryLinks/5678

DeleteCalculatedMetricRequest

针对 DeleteCalculatedMetric RPC 的请求消息。

字段
name

string

必需。要删除的 CalculatedMetric 的名称。格式:properties/{property_id}/calculatedMetrics/{calculated_metric_id} 示例:properties/1234/calculatedMetrics/Metric01

DeleteChannelGroupRequest

针对 DeleteChannelGroup RPC 的请求消息。

字段
name

string

必需。要删除的 ChannelGroup。示例格式:properties/1234/channelGroups/5678

DeleteConversionEventRequest

针对 DeleteConversionEvent RPC 的请求消息

字段
name

string

必需。要删除的转化事件的资源名称。格式:properties/{property}/conversionEvents/{conversion_event} 示例:“properties/123/conversionEvents/456”

DeleteDataStreamRequest

针对 DeleteDataStream RPC 的请求消息。

字段
name

string

必需。要删除的 DataStream 的名称。示例格式:properties/1234/dataStreams/5678

DeleteDisplayVideo360AdvertiserLinkProposalRequest

针对 DeleteDisplayVideo360AdvertiserLinkProposal RPC 的请求消息。

字段
name

string

必需。要删除的 DisplayVideo360AdvertiserLinkProposal 的名称。示例格式:properties/1234/displayVideo360AdvertiserLinkProposals/5678

DeleteDisplayVideo360AdvertiserLinkRequest

针对 DeleteDisplayVideo360AdvertiserLink RPC 的请求消息。

字段
name

string

必需。要删除的 DisplayVideo360AdvertiserLink 的名称。示例格式:properties/1234/displayVideo360AdvertiserLinks/5678

DeleteEventCreateRuleRequest

针对 DeleteEventCreateRule RPC 的请求消息。

字段
name

string

必需。示例格式:properties/123/dataStreams/456/eventCreateRules/789

DeleteEventEditRuleRequest

针对 DeleteEventEditRule RPC 的请求消息。

字段
name

string

必需。示例格式:properties/123/dataStreams/456/eventEditRules/789

DeleteExpandedDataSetRequest

针对 DeleteExpandedDataSet RPC 的请求消息。

字段
name

string

必需。示例格式:properties/1234/expandedDataSets/5678

DeleteFirebaseLinkRequest

针对 DeleteFirebaseLink RPC 的请求消息

字段
name

string

必需。格式:properties/{property_id}/firebaseLinks/{firebase_link_id}

示例:properties/1234/firebaseLinks/5678

DeleteGoogleAdsLinkRequest

针对 DeleteGoogleAdsLink RPC 的请求消息。

字段
name

string

必需。示例格式:properties/1234/googleAdsLinks/5678

DeleteKeyEventRequest

针对 DeleteKeyEvent RPC 的请求消息

字段
name

string

必需。要删除的关键事件的资源名称。格式:properties/{property}/keyEvents/{key_event} 示例:“properties/123/keyEvents/456”

DeleteMeasurementProtocolSecretRequest

针对 DeleteMeasurementProtocolSecret RPC 的请求消息

字段
name

string

必需。要删除的 MeasurementProtocolSecret 的名称。格式:properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

DeletePropertyRequest

针对 DeleteProperty RPC 的请求消息。

字段
name

string

必需。要软删除的媒体资源的名称。格式:properties/{property_id} 示例:“properties/1000”

DeleteReportingDataAnnotationRequest

针对 DeleteReportingDataAnnotation RPC 的请求消息。

字段
name

string

必需。要删除的报告数据注释的资源名称。格式:properties/property_id/reportingDataAnnotations/reporting_data_annotation 示例:properties/123/reportingDataAnnotations/456

DeleteRollupPropertySourceLinkRequest

针对 DeleteRollupPropertySourceLink RPC 的请求消息。

字段
name

string

必需。格式:properties/{property_id}/rollupPropertySourceLinks/{rollup_property_source_link_id} 示例:properties/1234/rollupPropertySourceLinks/5678

DeleteSKAdNetworkConversionValueSchemaRequest

用于 DeleteSKAdNetworkConversionValueSchema RPC 的请求消息。

字段
name

string

必需。要删除的 SKAdNetworkConversionValueSchema 的名称。格式:properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema/{skadnetwork_conversion_value_schema}

DeleteSearchAds360LinkRequest

针对 DeleteSearchAds360Link RPC 的请求消息。

字段
name

string

必需。要删除的 SearchAds360Link 的名称。示例格式:properties/1234/SearchAds360Links/5678

DeleteSubpropertyEventFilterRequest

针对 DeleteSubpropertyEventFilter RPC 的请求消息。

字段
name

string

必需。要删除的子媒体资源事件过滤器的资源名称。格式:properties/property_id/subpropertyEventFilters/subproperty_event_filter 示例:properties/123/subpropertyEventFilters/456

DisplayVideo360AdvertiserLinkProposal

Google Analytics 媒体资源与 Display & Video 360 广告客户之间的关联提案。

提案在获得批准后会转换为 DisplayVideo360AdvertiserLink。Google Analytics 管理员负责批准入站提案,而 Display & Video 360 管理员负责批准出站提案。

字段
name

string

仅限输出。相应 DisplayVideo360AdvertiserLinkProposal 资源的资源名称。格式:properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId}

注意:proposalId 不是 Display & Video 360 广告客户 ID

advertiser_id

string

不可变。Display & Video 360 广告客户的广告客户 ID。

advertiser_display_name

string

仅限输出。Display & Video 广告客户的显示名称。仅针对源自 Display & Video 360 的提案填充。

validation_email

string

仅限输入。如果提案要发送给 Display & Video 360,则此字段必须设置为目标广告客户的管理员的电子邮件地址。此电子邮件用于验证 Google Analytics 管理员是否知道 Display & Video 360 广告客户中至少有一位管理员。这不会将提案审批限制为仅限单个用户。Display & Video 360 广告客户中的任何管理员都可以批准该提案。

ads_personalization_enabled

BoolValue

不可变。通过此集成启用个性化广告功能。如果未在创建时设置此字段,则默认设置为 true。

campaign_data_sharing_enabled

BoolValue

不可变。启用从 Display & Video 360 导入广告系列数据的功能。如果未在创建时设置此字段,则默认设置为 true。

cost_data_sharing_enabled

BoolValue

不可变。启用从 Display & Video 360 导入费用数据。只有在启用 campaign_data_sharing_enabled 时,才能启用此功能。如果未在创建时设置此字段,则默认设置为 true。

EnhancedMeasurementSettings

Web 数据流下的单例资源,用于配置对其他网站互动和内容的衡量。

字段
name

string

仅限输出。增强型衡量设置的资源名称。格式:properties/{property_id}/dataStreams/{data_stream}/enhancedMeasurementSettings 示例:“properties/1000/dataStreams/2000/enhancedMeasurementSettings”

stream_enabled

bool

指示是否使用增强型衡量设置自动衡量相应网站数据流中的互动和内容。

更改此值不会影响设置本身,但会决定是否遵循这些设置。

scrolls_enabled

bool

如果启用,则每次访问者滚动到网页底部时捕获滚动事件。

outbound_clicks_enabled

bool

如果启用,则每次访问者点击会将他们带离您的网域的链接时,即记录一次出站点击事件。

site_search_enabled

bool

如果启用,则每次访问者在您的网站上执行搜索时捕获数据视图搜索结果事件(基于查询参数)。

video_engagement_enabled

bool

如果启用,则在访问者观看您网站上嵌入的视频时,记录视频播放、视频播放进度和视频完整播放事件。

file_downloads_enabled

bool

如果启用,则每次用户点击带有常用的文档、压缩文件、应用、视频或音频扩展名的链接时,即记录一次文件下载事件。

page_changes_enabled

bool

如果启用,则每当网站更改浏览器历史记录状态时,即会捕获网页浏览事件。

form_interactions_enabled

bool

如果启用,则每次访问者与您网站上的表单进行互动时,即记录一次表单互动事件。默认值为 false。

search_query_parameter

string

必需。要解读为网站搜索参数的网址查询参数。长度上限为 1024 个字符。值不能为空。

uri_query_parameter

string

其他网址查询参数。长度上限为 1024 个字符。

EventCreateRule

“创建事件”规则用于定义条件,当源事件符合这些条件时,系统会创建全新的事件。可以定义源事件中参数的其他变动。

与事件修改规则不同,事件创建规则没有明确的顺序。它们将独立运行。

“活动修改”规则和“活动创建”规则不能用于修改根据“活动创建”规则创建的活动。

字段
name

string

仅限输出。相应 EventCreateRule 资源的资源名称。格式:properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}

destination_event

string

必需。要创建的新事件的名称。

此值必须符合以下条件:* 不超过 40 个字符 * 仅包含字母、数字或 _(下划线)* 以字母开头

event_conditions[]

MatchingCondition

必需。必须至少有一个条件,最多可以有 10 个条件。源事件的条件必须匹配,此规则才能应用。

source_copy_parameters

bool

如果为 true,则将源参数复制到新事件。如果为 false 或未设置,则不会从源事件中复制所有非内部参数。参数突变是在复制参数后应用的。

parameter_mutations[]

ParameterMutation

参数变异定义了新事件的参数行为,并按顺序应用。最多可应用 20 个突变。

EventEditRule

事件修改规则用于定义触发条件,当源事件符合这些条件时,系统会创建全新的事件。可以定义源事件中参数的其他变动。

与“创建事件”规则不同,“编辑事件”规则会按其定义的顺序应用。

事件修改规则无法用于修改根据事件创建规则创建的事件。

字段
name

string

标识符。相应 EventEditRule 资源的资源名称。Format: properties/{property}/dataStreams/{data_stream}/eventEditRules/{event_edit_rule}

display_name

string

必需。相应事件修改规则的显示名称。最多 255 个字符。

event_conditions[]

MatchingCondition

必需。源事件的条件必须匹配,此规则才会生效。必须至少包含一个条件,最多可以包含 10 个条件。

parameter_mutations[]

ParameterMutation

必需。参数变异定义了新事件的参数行为,并按顺序应用。最多可应用 20 个突变。

processing_order

int64

仅限输出。将处理相应规则的订单。订单值低于此值的规则将在相应规则之前处理,订单值高于此值的规则将在相应规则之后处理。新的事件修改规则将分配到顺序末尾。

此值不适用于事件创建规则。

EventMapping

用于匹配事件的事件设置条件。

字段
event_name

string

必需。Google Analytics 事件的名称。必须始终设置。允许的显示名称长度上限为 40 个 UTF-16 代码单元。

min_event_count

int64

必须设置以下四个最小值/最大值中的至少一个。系统会将设置的值进行 AND 运算,以确定事件是否符合条件。事件发生的最少次数。如果未设置,则不会检查最小事件数。

max_event_count

int64

相应事件发生的最大次数。如果未设置,则不会检查事件数量上限。

min_event_value

double

因相应活动而产生的最低收入。收入币种将在媒体资源一级定义。如果未设置,则不会检查最低事件价值。

max_event_value

double

因相应事件而产生的最高收入。收入币种将在媒体资源一级定义。如果未设置,则不会检查事件价值上限。

ExpandedDataSet

表示 ExpandedDataSet 的资源消息。

字段
name

string

仅限输出。相应 ExpandedDataSet 资源的资源名称。格式:properties/{property_id}/expandedDataSets/{expanded_data_set}

display_name

string

必需。ExpandedDataSet 的显示名称。最多 200 个字符。

description

string

可选。ExpandedDataSet 的说明。最多 50 个字符。

dimension_names[]

string

不可变。ExpandedDataSet 中包含的维度列表。如需查看维度名称列表,请参阅 API 维度

metric_names[]

string

不可变。ExpandedDataSet 中包含的指标列表。如需查看维度名称列表,请参阅 API 指标

dimension_filter_expression

ExpandedDataSetFilterExpression

不可变。应用于 ExpandedDataSet 中所含维度的 ExpandedDataSet 过滤条件的逻辑表达式。此过滤条件用于减少行数,从而降低遇到 other 行的几率。

data_collection_start_time

Timestamp

仅限输出。扩展数据集开始(或将要开始)收集数据的时间。

ExpandedDataSetFilter

单个维度的特定过滤条件

字段
field_name

string

必需。要过滤的维度名称。

联合字段 one_filter。上述过滤条件之一。one_filter 只能是下列其中一项:
string_filter

StringFilter

用于过滤与特定模式匹配的字符串类型维度的过滤条件。

in_list_filter

InListFilter

与特定选项列表匹配的字符串维度过滤条件。

InListFilter

与特定选项列表匹配的字符串维度过滤条件。

字段
values[]

string

必需。要匹配的可能字符串值列表。不得为空。

case_sensitive

bool

可选。如果为 true,则匹配区分大小写。如果为 false,则匹配不区分大小写。必须为 true。

StringFilter

用于过滤与特定模式匹配的字符串类型维度的过滤条件。

字段
match_type

MatchType

必需。字符串过滤器的匹配类型。

value

string

必需。要匹配的字符串值。

case_sensitive

bool

可选。如果为 true,则匹配区分大小写。如果为 false,则匹配不区分大小写。当 match_type 为 EXACT 时,必须为 true。当 match_type 为 CONTAINS 时,必须为 false。

MatchType

字符串过滤器的匹配类型。

枚举
MATCH_TYPE_UNSPECIFIED 未指定
EXACT 字符串值完全匹配。
CONTAINS 包含字符串值。

ExpandedDataSetFilterExpression

EnhancedDataSet 维度过滤条件的逻辑表达式。

字段
联合字段 expr。应用于过滤器的表达式。expr 只能是下列其中一项:
and_group

ExpandedDataSetFilterExpressionList

要进行 AND 运算的表达式列表。它必须包含一个 ExpandedDataSetFilterExpression,其中包含 not_expression 或 dimension_filter。必须为顶级 ExpandedDataSetFilterExpression 设置此属性。

not_expression

ExpandedDataSetFilterExpression

要进行 NOT 运算(即取反、求补)的过滤条件表达式。必须包含 dimension_filter。无法在顶级 ExpandedDataSetFilterExpression 上设置此属性。

filter

ExpandedDataSetFilter

针对单个维度的过滤条件。无法在顶级 ExpandedDataSetFilterExpression 上设置此属性。

ExpandedDataSetFilterExpressionList

ExpandedDataSet 过滤条件表达式的列表。

字段
filter_expressions[]

ExpandedDataSetFilterExpression

ExpandedDataSet 过滤条件表达式的列表。

GetAccessBindingRequest

针对 GetAccessBinding RPC 的请求消息。

字段
name

string

必需。要检索的访问权限绑定的名称。格式:- accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}

GetAccountRequest

针对 GetAccount RPC 的请求消息。

字段
name

string

必需。要查找的账号的名称。格式:accounts/{account} 示例:“accounts/100”

GetAdSenseLinkRequest

要传递给 GetAdSenseLink 方法的请求消息。

字段
name

string

必需。所请求的 AdSense 链接的唯一标识符。格式:properties/{propertyId}/adSenseLinks/{linkId} 示例:properties/1234/adSenseLinks/5678

GetAttributionSettingsRequest

针对 GetAttributionSettings RPC 的请求消息。

字段
name

string

必需。要检索的提供方信息设置的名称。格式:properties/{property}/attributionSettings

GetAudienceRequest

针对 GetAudience RPC 的请求消息。

字段
name

string

必需。要获取的受众群体的名称。示例格式:properties/1234/audiences/5678

GetBigQueryLinkRequest

针对 GetBigQueryLink RPC 的请求消息。

字段
name

string

必需。要查找的 BigQuery 关联的名称。格式:properties/{property_id}/bigQueryLinks/{bigquery_link_id} 示例:properties/123/bigQueryLinks/456

GetCalculatedMetricRequest

针对 GetCalculatedMetric RPC 的请求消息。

字段
name

string

必需。要获取的 CalculatedMetric 的名称。格式:properties/{property_id}/calculatedMetrics/{calculated_metric_id} 示例:properties/1234/calculatedMetrics/Metric01

GetChannelGroupRequest

针对 GetChannelGroup RPC 的请求消息。

字段
name

string

必需。要获取的 ChannelGroup。示例格式:properties/1234/channelGroups/5678

GetConversionEventRequest

针对 GetConversionEvent RPC 的请求消息

字段
name

string

必需。要检索的转化事件的资源名称。格式:properties/{property}/conversionEvents/{conversion_event} 示例:“properties/123/conversionEvents/456”

GetCustomDimensionRequest

针对 GetCustomDimension RPC 的请求消息。

字段
name

string

必需。要获取的 CustomDimension 的名称。示例格式:properties/1234/customDimensions/5678

GetCustomMetricRequest

针对 GetCustomMetric RPC 的请求消息。

字段
name

string

必需。要获取的 CustomMetric 的名称。示例格式:properties/1234/customMetrics/5678

GetDataRedactionSettingsRequest

GetDataRedactionSettings RPC 的请求消息。

字段
name

string

必需。要查找的设置的名称。格式:properties/{property}/dataStreams/{data_stream}/dataRedactionSettings 示例:“properties/1000/dataStreams/2000/dataRedactionSettings”

GetDataRetentionSettingsRequest

针对 GetDataRetentionSettings RPC 的请求消息。

字段
name

string

必需。要查找的设置的名称。格式:properties/{property}/dataRetentionSettings 示例:“properties/1000/dataRetentionSettings”

GetDataSharingSettingsRequest

针对 GetDataSharingSettings RPC 的请求消息。

字段
name

string

必需。要查找的设置的名称。格式:accounts/{account}/dataSharingSettings

示例:accounts/1000/dataSharingSettings

GetDataStreamRequest

针对 GetDataStream RPC 的请求消息。

字段
name

string

必需。要获取的 DataStream 的名称。示例格式:properties/1234/dataStreams/5678

GetDisplayVideo360AdvertiserLinkProposalRequest

针对 GetDisplayVideo360AdvertiserLinkProposal RPC 的请求消息。

字段
name

string

必需。要获取的 DisplayVideo360AdvertiserLinkProposal 的名称。示例格式:properties/1234/displayVideo360AdvertiserLinkProposals/5678

GetDisplayVideo360AdvertiserLinkRequest

针对 GetDisplayVideo360AdvertiserLink RPC 的请求消息。

字段
name

string

必需。要获取的 DisplayVideo360AdvertiserLink 的名称。示例格式:properties/1234/displayVideo360AdvertiserLink/5678

GetEnhancedMeasurementSettingsRequest

针对 GetEnhancedMeasurementSettings RPC 的请求消息。

字段
name

string

必需。要查找的设置的名称。格式:properties/{property}/dataStreams/{data_stream}/enhancedMeasurementSettings 示例:“properties/1000/dataStreams/2000/enhancedMeasurementSettings”

GetEventCreateRuleRequest

针对 GetEventCreateRule RPC 的请求消息。

字段
name

string

必需。要获取的 EventCreateRule 的名称。示例格式:properties/123/dataStreams/456/eventCreateRules/789

GetEventEditRuleRequest

针对 GetEventEditRule RPC 的请求消息。

字段
name

string

必需。要获取的 EventEditRule 的名称。示例格式:properties/123/dataStreams/456/eventEditRules/789

GetExpandedDataSetRequest

针对 GetExpandedDataSet RPC 的请求消息。

字段
name

string

必需。要获取的 ExpandedDataSet 的名称。示例格式:properties/1234/expandedDataSets/5678

GetGlobalSiteTagRequest

针对 GetGlobalSiteTag RPC 的请求消息。

字段
name

string

必需。要查找的网站代码的名称。请注意,网站标记是单例,没有唯一 ID。格式:properties/{property_id}/dataStreams/{stream_id}/globalSiteTag

示例:properties/123/dataStreams/456/globalSiteTag

GetGoogleSignalsSettingsRequest

针对 GetGoogleSignalsSettings RPC 的请求消息

字段
name

string

必需。要检索的 Google 信号设置的名称。格式:properties/{property}/googleSignalsSettings

GetKeyEventRequest

针对 GetKeyEvent RPC 的请求消息

字段
name

string

必需。要检索的关键事件的资源名称。格式:properties/{property}/keyEvents/{key_event} 示例:“properties/123/keyEvents/456”

GetMeasurementProtocolSecretRequest

针对 GetMeasurementProtocolSecret RPC 的请求消息。

字段
name

string

必需。要查找的衡量协议 Secret 的名称。格式:properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

GetPropertyRequest

针对 GetProperty RPC 的请求消息。

字段
name

string

必需。要查找的媒体资源的名称。格式:properties/{property_id} 示例:“properties/1000”

GetReportingDataAnnotationRequest

针对 GetReportingDataAnnotation RPC 的请求消息。

字段
name

string

必需。要查找的报告数据注释的资源名称。格式:properties/property_id/reportingDataAnnotations/reportingDataAnnotation 示例:properties/123/reportingDataAnnotations/456

GetReportingIdentitySettingsRequest

针对 GetReportingIdentitySettings RPC 的请求消息。

字段
name

string

必需。要查找的设置的名称。格式:properties/{property}/reportingIdentitySettings 示例:“properties/1000/reportingIdentitySettings”

GetRollupPropertySourceLinkRequest

针对 GetRollupPropertySourceLink RPC 的请求消息。

字段
name

string

必需。要查找的总览媒体资源来源链接的名称。格式:properties/{property_id}/rollupPropertySourceLinks/{rollup_property_source_link_id} 示例:properties/123/rollupPropertySourceLinks/456

GetSKAdNetworkConversionValueSchemaRequest

针对 GetSKAdNetworkConversionValueSchema RPC 的请求消息。

字段
name

string

必需。要查找的 SKAdNetwork 转化价值架构的资源名称。格式:properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema/{skadnetwork_conversion_value_schema}

GetSearchAds360LinkRequest

针对 GetSearchAds360Link RPC 的请求消息。

字段
name

string

必需。要获取的 SearchAds360Link 的名称。示例格式:properties/1234/SearchAds360Link/5678

GetSubpropertyEventFilterRequest

针对 GetSubpropertyEventFilter RPC 的请求消息。

字段
name

string

必需。要查找的子媒体资源事件过滤器的资源名称。格式:properties/property_id/subpropertyEventFilters/subproperty_event_filter 示例:properties/123/subpropertyEventFilters/456

GetSubpropertySyncConfigRequest

针对 GetSubpropertySyncConfig RPC 的请求消息。

字段
name

string

必需。要查找的 SubpropertySyncConfig 的资源名称。格式:properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} 示例:properties/1234/subpropertySyncConfigs/5678

GlobalSiteTag

一种只读资源,包含用于将数据从网站发送到 DataStream 的标记。仅适用于网站 DataStream 资源。

字段
name

string

仅限输出。相应 GlobalSiteTag 资源的资源名称。格式:properties/{property_id}/dataStreams/{stream_id}/globalSiteTag 示例:“properties/123/dataStreams/456/globalSiteTag”

snippet

string

不可变。要粘贴到每个待衡量网页的 head 标记中作为第一项内容的 JavaScript 代码段。

GoogleSignalsConsent

“Google 信号”设置中的“意见征求”字段。

枚举

GoogleSignalsSettings

Google 信号的设置值。这是单例资源。

字段
name

string

仅限输出。相应设置的资源名称。格式:properties/{property_id}/googleSignalsSettings 示例:“properties/1000/googleSignalsSettings”

state

GoogleSignalsState

相应设置的状态。

consent

GoogleSignalsConsent

仅限输出。接受服务条款。

GoogleSignalsState

Google 信号设置的状态。

枚举
GOOGLE_SIGNALS_STATE_UNSPECIFIED Google 信号状态默认为 GOOGLE_SIGNALS_STATE_UNSPECIFIED,表示用户尚未做出明确选择。
GOOGLE_SIGNALS_ENABLED Google 信号已启用。
GOOGLE_SIGNALS_DISABLED Google 信号已停用。

GroupingRule

用于控制如何将流量分组到一个渠道的规则。

字段
display_name

string

必需。渠道的客户定义显示名。

expression

ChannelGroupFilterExpression

必需。用于定义分组规则的过滤条件表达式。

IndustryCategory

为此媒体资源选择的类别,用于行业基准比较。

枚举
INDUSTRY_CATEGORY_UNSPECIFIED 未指定行业类别
AUTOMOTIVE 汽车
BUSINESS_AND_INDUSTRIAL_MARKETS 工商业市场
FINANCE 金融
HEALTHCARE 医疗保健
TECHNOLOGY 技术
TRAVEL 旅游
OTHER 其他
ARTS_AND_ENTERTAINMENT 艺术与娱乐
BEAUTY_AND_FITNESS 美容健身
BOOKS_AND_LITERATURE 图书与文学
FOOD_AND_DRINK 食品和饮料
GAMES 游戏
HOBBIES_AND_LEISURE 爱好与休闲
HOME_AND_GARDEN 家居园艺
INTERNET_AND_TELECOM 互联网与电信
LAW_AND_GOVERNMENT 法律和政府
NEWS 新闻
ONLINE_COMMUNITIES 在线社区
PEOPLE_AND_SOCIETY 人与社会
PETS_AND_ANIMALS 宠物与动物
REAL_ESTATE 房地产
REFERENCE 参考
SCIENCE 科学
SPORTS 体育
JOBS_AND_EDUCATION 招聘与培训
SHOPPING 购物

KeyEvent

Google Analytics 媒体资源中的关键事件。

字段
name

string

仅限输出。相应关键事件的资源名称。格式:properties/{property}/keyEvents/{key_event}

event_name

string

不可变。相应关键事件的事件名称。示例:“点击”“购买”

create_time

Timestamp

仅限输出。相应关键事件在媒体资源中创建的时间。

deletable

bool

仅限输出。如果设置为 true,则可以删除相应活动。

custom

bool

仅限输出。如果设置为 true,则此关键事件是指自定义事件。如果设置为 false,则此关键事件是指 Google Analytics 中的默认事件。默认事件通常在 Google Analytics 中具有特殊含义。默认事件通常由 Google Analytics 系统为您创建,但在某些情况下也可以由媒体资源管理员创建。自定义事件会占用每个媒体资源可创建的自定义关键事件数量上限。

counting_method

CountingMethod

必需。在会话中,统计多个事件的关键事件的方法。

default_value

DefaultValue

可选。为关键事件定义默认价值/币种。

CountingMethod

在会话中,统计多个事件的关键事件的方法。

枚举
COUNTING_METHOD_UNSPECIFIED 未指定统计方法。
ONCE_PER_EVENT 每个 Event 实例都被视为关键事件。
ONCE_PER_SESSION 每个用户在每次会话中最多只能将一个事件实例视为关键事件。

DefaultValue

为关键事件定义默认价值/币种。

字段
numeric_value

double

必需。系统将使用此值来填充此关键事件(由 event_name 指定)的所有实例中未设置的“value”参数。

currency_code

string

必需。如果此关键事件(由 event_name 指定)的某次发生没有设置币种,系统会将此币种应用为默认币种。必须采用 ISO 4217 货币代码格式。

如需了解详情,请参阅 https://en.wikipedia.org/wiki/ISO_4217

LinkProposalInitiatingProduct

指明用户是从哪个产品中发起链接建议的。

枚举
GOOGLE_ANALYTICS 此提案由 Google Analytics 用户创建。
LINKED_PRODUCT 此提案是由关联产品(而非 Google Analytics)的用户创建的。

LinkProposalState

链接提案资源的状态。

枚举
AWAITING_REVIEW_FROM_GOOGLE_ANALYTICS 此提案正在等待 Google Analytics 用户的审核。此提案会在一段时间后自动失效。
AWAITING_REVIEW_FROM_LINKED_PRODUCT 此提案正在等待关联产品的用户审核。此提案会在一段时间后自动失效。
WITHDRAWN 此提案已被发起产品中的管理员撤回。此提案将在一段时间后自动删除。
DECLINED 此提案已被接收产品的管理员拒绝。此提案将在一段时间后自动删除。
EXPIRED 由于接收产品上的管理员未做出回应,此提案已过期。此提案将在一段时间后自动删除。
OBSOLETE 此提案已过时,因为已直接创建指向此提案所指定外部产品资源的链接。此提案将在一段时间后自动删除。

LinkProposalStatusDetails

链接提案的状态信息。

字段
requestor_email

string

仅限输出。提出此关联建议的用户的电子邮件地址。

ListAccessBindingsRequest

针对 ListAccessBindings RPC 的请求消息。

字段
parent

string

必需。格式:- accounts/{account} - properties/{property}

page_size

int32

要返回的访问权限绑定的数量上限。服务返回的值可能小于此值。如果未指定,则最多返回 200 个访问权限绑定。最大值为 500;大于 500 的值会强制转换为 500。

page_token

string

从之前的 ListAccessBindings 调用接收的页面令牌。利用其进行后续页面检索。进行分页时,提供给 ListAccessBindings 的所有其他参数必须与提供页面令牌的调用相一致。

ListAccessBindingsResponse

针对 ListAccessBindings RPC 的响应消息。

字段
access_bindings[]

AccessBinding

AccessBinding 的列表。这些元素将按稳定但任意的顺序排序。

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListAccountSummariesRequest

针对 ListAccountSummaries RPC 的请求消息。

字段
page_size

int32

要返回的 AccountSummary 资源数量上限。即使有其他网页,服务返回的值也可能小于此值。如果未指定,则最多返回 50 个资源。最大值为 200;(更高的值将被强制转换为最大值)

page_token

string

从之前的 ListAccountSummaries 调用接收的页面令牌。利用其进行后续页面检索。进行分页时,提供给 ListAccountSummaries 的所有其他参数必须与提供页面令牌的调用相一致。

ListAccountSummariesResponse

针对 ListAccountSummaries RPC 的响应消息。

字段
account_summaries[]

AccountSummary

调用者有权访问的所有账号的账号摘要。

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListAccountsRequest

针对 ListAccounts RPC 的请求消息。

字段
page_size

int32

要返回的资源数量上限。即使有其他网页,服务返回的值也可能小于此值。如果未指定,则最多返回 50 个资源。最大值为 200;(更高的值将被强制转换为最大值)

page_token

string

从之前的 ListAccounts 调用接收的页面令牌。利用其进行后续页面检索。进行分页时,提供给 ListAccounts 的所有其他参数必须与提供页面令牌的调用相一致。

show_deleted

bool

是否在结果中包含已软删除(即“已放入回收站”)的账号。您可以检查账号,以确定其是否已被删除。

ListAccountsResponse

针对 ListAccounts RPC 的请求消息。

字段
accounts[]

Account

调用者可访问的结果。

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListAdSenseLinksRequest

要传递给 ListAdSenseLinks 方法的请求消息。

字段
parent

string

必需。父级媒体资源的资源名称。格式:properties/{propertyId} 示例:properties/1234

page_size

int32

要返回的资源数量上限。如果未指定,则最多返回 50 个资源。最大值为 200(如果值高于此值,系统会强制转换为最大值)。

page_token

string

从之前的 ListAdSenseLinks 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时,提供给 ListAdSenseLinks 的所有其他参数必须与提供页面令牌的调用匹配。

ListAdSenseLinksResponse

针对 ListAdSenseLinks 方法的响应消息。

字段
next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListAudiencesRequest

针对 ListAudiences RPC 的请求消息。

字段
parent

string

必需。示例格式:properties/1234

page_size

int32

要返回的资源数量上限。如果未指定,则最多返回 50 个资源。最大值为 200(如果值高于此值,系统会强制转换为最大值)。

page_token

string

从之前的 ListAudiences 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时,提供给 ListAudiences 的所有其他参数必须与提供页面令牌的调用匹配。

ListAudiencesResponse

针对 ListAudiences RPC 的响应消息。

字段
audiences[]

Audience

受众群体列表。

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListBigQueryLinksRequest

针对 ListBigQueryLinks RPC 的请求消息。

字段
parent

string

必需。要列出 BigQuery 关联的媒体资源的名称。格式:properties/{property_id} 示例:properties/1234

page_size

int32

要返回的资源数量上限。即使有其他网页,服务返回的值也可能小于此值。如果未指定,则最多返回 50 个资源。最大值为 200;(更高的值将被强制转换为最大值)

page_token

string

从之前的 ListBigQueryLinks 调用接收的页面令牌。利用其进行后续页面检索。进行分页时,提供给 ListBigQueryLinks 的所有其他参数必须与提供页面令牌的调用相一致。

ListBigQueryLinksResponse

针对 ListBigQueryLinks RPC 的响应消息

字段
next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListCalculatedMetricsRequest

针对 ListCalculatedMetrics RPC 的请求消息。

字段
parent

string

必需。示例格式:properties/1234

page_size

int32

可选。要返回的资源数量上限。如果未指定,则最多返回 50 个资源。最大值为 200(如果值高于此值,系统会强制转换为最大值)。

page_token

string

可选。从之前的 ListCalculatedMetrics 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时,提供给 ListCalculatedMetrics 的所有其他参数必须与提供页面令牌的调用匹配。

ListCalculatedMetricsResponse

针对 ListCalculatedMetrics RPC 的响应消息。

字段
calculated_metrics[]

CalculatedMetric

CalculatedMetrics 的列表。

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListChannelGroupsRequest

针对 ListChannelGroups RPC 的请求消息。

字段
parent

string

必需。要列出 ChannelGroups 的媒体资源。示例格式:properties/1234

page_size

int32

要返回的资源数量上限。如果未指定,则最多返回 50 个资源。最大值为 200(如果值高于此值,系统会强制转换为最大值)。

page_token

string

从之前的 ListChannelGroups 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时,提供给 ListChannelGroups 的所有其他参数必须与提供页面令牌的调用匹配。

ListChannelGroupsResponse

针对 ListChannelGroups RPC 的响应消息。

字段
channel_groups[]

ChannelGroup

ChannelGroup 的列表。这些元素将按稳定但任意的顺序排序。

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListConversionEventsRequest

ListConversionEvents RPC 的请求消息

字段
parent

string

必需。父级房源的资源名称。示例:'properties/123'

page_size

int32

要返回的资源数量上限。如果未指定,则最多返回 50 个资源。最大值为 200;(更高的值将被强制转换为最大值)

page_token

string

从之前的 ListConversionEvents 调用接收的页面令牌。利用其进行后续页面检索。进行分页时,提供给 ListConversionEvents 的所有其他参数必须与提供页面令牌的调用相一致。

ListConversionEventsResponse

ListConversionEvents RPC 的响应消息。

字段
conversion_events[]

ConversionEvent

所请求的转化事件

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListCustomDimensionsRequest

针对 ListCustomDimensions RPC 的请求消息。

字段
parent

string

必需。示例格式:properties/1234

page_size

int32

要返回的资源数量上限。如果未指定,则最多返回 50 个资源。最大值为 200(如果值高于此值,系统会强制转换为最大值)。

page_token

string

从之前的 ListCustomDimensions 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时,提供给 ListCustomDimensions 的所有其他参数必须与提供页面令牌的调用匹配。

ListCustomDimensionsResponse

针对 ListCustomDimensions RPC 的响应消息。

字段
custom_dimensions[]

CustomDimension

CustomDimensions 的列表。

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListCustomMetricsRequest

针对 ListCustomMetrics RPC 的请求消息。

字段
parent

string

必需。示例格式:properties/1234

page_size

int32

要返回的资源数量上限。如果未指定,则最多返回 50 个资源。最大值为 200(如果值高于此值,系统会强制转换为最大值)。

page_token

string

从之前的 ListCustomMetrics 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时,提供给 ListCustomMetrics 的所有其他参数必须与提供页面令牌的调用匹配。

ListCustomMetricsResponse

针对 ListCustomMetrics RPC 的响应消息。

字段
custom_metrics[]

CustomMetric

CustomMetrics 的列表。

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListDataStreamsRequest

针对 ListDataStreams RPC 的请求消息。

字段
parent

string

必需。示例格式:properties/1234

page_size

int32

要返回的资源数量上限。如果未指定,则最多返回 50 个资源。最大值为 200(如果值高于此值,系统会强制转换为最大值)。

page_token

string

从之前的 ListDataStreams 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时,提供给 ListDataStreams 的所有其他参数必须与提供页面令牌的调用匹配。

ListDataStreamsResponse

针对 ListDataStreams RPC 的响应消息。

字段
data_streams[]

DataStream

DataStream 的列表。

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListDisplayVideo360AdvertiserLinkProposalsRequest

针对 ListDisplayVideo360AdvertiserLinkProposals RPC 的请求消息。

字段
parent

string

必需。示例格式:properties/1234

page_size

int32

要返回的资源数量上限。如果未指定,则最多返回 50 个资源。最大值为 200(如果值高于此值,系统会强制转换为最大值)。

page_token

string

从之前的 ListDisplayVideo360AdvertiserLinkProposals 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时,提供给 ListDisplayVideo360AdvertiserLinkProposals 的所有其他参数必须与提供页面令牌的调用匹配。

ListDisplayVideo360AdvertiserLinkProposalsResponse

针对 ListDisplayVideo360AdvertiserLinkProposals RPC 的响应消息。

字段
next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListDisplayVideo360AdvertiserLinksRequest

针对 ListDisplayVideo360AdvertiserLinks RPC 的请求消息。

字段
parent

string

必需。示例格式:properties/1234

page_size

int32

要返回的资源数量上限。如果未指定,则最多返回 50 个资源。最大值为 200(如果值高于此值,系统会强制转换为最大值)。

page_token

string

从之前的 ListDisplayVideo360AdvertiserLinks 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时,提供给 ListDisplayVideo360AdvertiserLinks 的所有其他参数必须与提供页面令牌的调用匹配。

ListDisplayVideo360AdvertiserLinksResponse

针对 ListDisplayVideo360AdvertiserLinks RPC 的响应消息。

字段
next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListEventCreateRulesRequest

针对 ListEventCreateRules RPC 的请求消息。

字段
parent

string

必需。示例格式:properties/123/dataStreams/456

page_size

int32

要返回的资源数量上限。如果未指定,则最多返回 50 个资源。最大值为 200(如果值高于此值,系统会强制转换为最大值)。

page_token

string

从之前的 ListEventCreateRules 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时,提供给 ListEventCreateRules 的所有其他参数必须与提供页面令牌的调用匹配。

ListEventCreateRulesResponse

针对 ListEventCreateRules RPC 的响应消息。

字段
event_create_rules[]

EventCreateRule

EventCreateRule 的列表。这些元素将按稳定但任意的顺序排序。

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListEventEditRulesRequest

针对 ListEventEditRules RPC 的请求消息。

字段
parent

string

必需。示例格式:properties/123/dataStreams/456

page_size

int32

可选。要返回的资源数量上限。如果未指定,则最多返回 50 个资源。最大值为 200(如果值高于此值,系统会强制转换为最大值)。

page_token

string

可选。从之前的 ListEventEditRules 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时,提供给 ListEventEditRules 的所有其他参数必须与提供页面令牌的调用匹配。

ListEventEditRulesResponse

针对 ListEventEditRules RPC 的响应消息。

字段
event_edit_rules[]

EventEditRule

EventEditRule 的列表。这些元素将按稳定但任意的顺序排序。

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListExpandedDataSetsRequest

针对 ListExpandedDataSets RPC 的请求消息。

字段
parent

string

必需。示例格式:properties/1234

page_size

int32

要返回的资源数量上限。如果未指定,则最多返回 50 个资源。最大值为 200(如果值高于此值,系统会强制转换为最大值)。

page_token

string

从之前的 ListExpandedDataSets 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时,提供给 ListExpandedDataSet 的所有其他参数必须与提供页面令牌的调用匹配。

ListExpandedDataSetsResponse

针对 ListExpandedDataSets RPC 的响应消息。

字段
expanded_data_sets[]

ExpandedDataSet

ExpandedDataSet 的列表。这些元素将按稳定但任意的顺序排序。

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListFirebaseLinksRequest

针对 ListFirebaseLinks RPC 的请求消息

字段
parent

string

必需。格式:properties/{property_id}

示例:properties/1234

page_size

int32

要返回的资源数量上限。即使有其他网页,服务返回的值也可能小于此值。如果未指定,则最多返回 50 个资源。最大值为 200;(更高的值将被强制转换为最大值)

page_token

string

从之前的 ListFirebaseLinks 调用接收的页面令牌。利用其进行后续页面检索。进行分页时,提供给 ListFirebaseLinks 的所有其他参数必须与提供页面令牌的调用相一致。

ListFirebaseLinksResponse

针对 ListFirebaseLinks RPC 的响应消息

字段
next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。 目前,Google Analytics 每个媒体资源仅支持一个 FirebaseLink,因此此字段永远不会填充。

ListGoogleAdsLinksRequest

针对 ListGoogleAdsLinks RPC 的请求消息。

字段
parent

string

必需。示例格式:properties/1234

page_size

int32

要返回的资源数量上限。如果未指定,则最多返回 50 个资源。最大值为 200(如果值高于此值,系统会强制转换为最大值)。

page_token

string

从之前的 ListGoogleAdsLinks 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时,提供给 ListGoogleAdsLinks 的所有其他参数必须与提供页面令牌的调用匹配。

ListGoogleAdsLinksResponse

针对 ListGoogleAdsLinks RPC 的响应消息。

字段
next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListKeyEventsRequest

针对 ListKeyEvents RPC 的请求消息

字段
parent

string

必需。父级房源的资源名称。示例:'properties/123'

page_size

int32

要返回的资源数量上限。如果未指定,则最多返回 50 个资源。最大值为 200;(更高的值将被强制转换为最大值)

page_token

string

从之前的 ListKeyEvents 调用接收的页面令牌。利用其进行后续页面检索。进行分页时,提供给 ListKeyEvents 的所有其他参数必须与提供页面令牌的调用相一致。

ListKeyEventsResponse

针对 ListKeyEvents RPC 的响应消息。

字段
key_events[]

KeyEvent

所请求的关键事件

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListMeasurementProtocolSecretsRequest

针对 ListMeasurementProtocolSecret RPC 的请求消息

字段
parent

string

必需。父级流的资源名称。格式:properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets

page_size

int32

要返回的资源数量上限。如果未指定,则最多返回 10 个资源。最大值为 10。较高的值将强制转换为最大值。

page_token

string

从之前的 ListMeasurementProtocolSecrets 调用接收的页面令牌。利用其进行后续页面检索。进行分页时,提供给 ListMeasurementProtocolSecrets 的所有其他参数必须与提供页面令牌的调用相一致。

ListMeasurementProtocolSecretsResponse

针对 ListMeasurementProtocolSecret RPC 的响应消息

字段
measurement_protocol_secrets[]

MeasurementProtocolSecret

请求中指定的父直播的密钥列表。

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListPropertiesRequest

针对 ListProperties RPC 的请求消息。

字段
filter

string

必需。用于过滤请求结果的表达式。可用于过滤的字段包括:parent:(父账号/媒体资源的资源名称)、ancestor:(父账号的资源名称)或 firebase_project:(关联的 Firebase 项目的 ID 或编号)。以下是一些过滤条件示例:

| Filter                      | Description                               |
|-----------------------------|-------------------------------------------|
| parent:accounts/123         | The account with account id: 123.       |
| parent:properties/123       | The property with property id: 123.       |
| ancestor:accounts/123       | The account with account id: 123.         |
| firebase_project:project-id | The firebase project with id: project-id. |
| firebase_project:123        | The firebase project with number: 123.    |
page_size

int32

要返回的资源数量上限。即使有其他网页,服务返回的值也可能小于此值。如果未指定,则最多返回 50 个资源。最大值为 200;(更高的值将被强制转换为最大值)

page_token

string

从之前的 ListProperties 调用接收的页面令牌。利用其进行后续页面检索。进行分页时,提供给 ListProperties 的所有其他参数必须与提供页面令牌的调用相一致。

show_deleted

bool

是否在结果中包含已软删除(即“已放入回收站”)的媒体资源。您可以检查属性,以确定它们是否已被删除。

ListPropertiesResponse

针对 ListProperties RPC 的响应消息。

字段
properties[]

Property

符合过滤条件且调用方可访问的结果。

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListReportingDataAnnotationsRequest

针对 ListReportingDataAnnotation RPC 的请求消息。

字段
parent

string

必需。媒体资源的名称。格式:properties/property_id 示例:properties/123

filter

string

可选。用于限制列出父媒体资源下的哪些报告数据注释的过滤条件。

支持的字段包括:

  • “名称”
  • title
  • description
  • annotation_date
  • annotation_date_range
  • color

此外,此 API 还提供以下辅助函数:

  • annotation_duration():相应注释标记的时长,即时长。需要以数字形式表示的秒数,后跟 s 后缀。
  • is_annotation_in_range(start_date, end_date):如果注释位于 start_dateend_date 指定的范围内,则返回 true。日期采用 ISO-8601 格式,例如 2031-06-28

支持的操作:

  • =:等于
  • !=:不等于
  • <:小于
  • >:大于
  • <=:小于或等于
  • >=:大于或等于
  • ::包含运算符
  • =~正则表达式匹配
  • !~正则表达式不匹配
  • NOT:逻辑非
  • AND:逻辑与
  • OR:逻辑或

示例:

  1. title="Holiday Sale"
  2. description=~"[Bb]ig [Gg]ame.*[Ss]ale"
  3. is_annotation_in_range("2025-12-25", "2026-01-16") = true
  4. annotation_duration() >= 172800s AND title:BOGO
page_size

int32

可选。要返回的资源数量上限。即使有其他网页,服务返回的值也可能小于此值。如果未指定,则最多返回 50 个资源。最大值为 200;(更高的值将被强制转换为最大值)

page_token

string

可选。从之前的 ListReportingDataAnnotations 调用接收的页面令牌。利用其进行后续页面检索。进行分页时,提供给 ListReportingDataAnnotations 的所有其他参数必须与提供页面令牌的调用相一致。

ListReportingDataAnnotationsResponse

针对 ListReportingDataAnnotation RPC 的响应消息。

字段
reporting_data_annotations[]

ReportingDataAnnotation

报告数据注释的列表。

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListRollupPropertySourceLinksRequest

针对 ListRollupPropertySourceLinks RPC 的请求消息。

字段
parent

string

必需。要列出总览媒体资源来源链接的总览媒体资源的名称。格式:properties/{property_id} 示例:properties/1234

page_size

int32

可选。要返回的资源数量上限。即使有其他网页,服务返回的值也可能小于此值。如果未指定,则最多返回 50 个资源。最大值为 200;(更高的值将被强制转换为最大值)

page_token

string

可选。从之前的 ListRollupPropertySourceLinks 调用接收的页面令牌。利用其进行后续页面检索。进行分页时,提供给 ListRollupPropertySourceLinks 的所有其他参数必须与提供页面令牌的调用相一致。

ListRollupPropertySourceLinksResponse

针对 ListRollupPropertySourceLinks RPC 的响应消息。

字段
next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListSKAdNetworkConversionValueSchemasRequest

针对 ListSKAdNetworkConversionValueSchemas RPC 的请求消息

字段
parent

string

必需。要列出架构的 DataStream 资源。格式:properties/{property_id}/dataStreams/{dataStream} 示例:properties/1234/dataStreams/5678

page_size

int32

要返回的资源数量上限。即使有其他网页,服务返回的值也可能小于此值。如果未指定,则最多返回 50 个资源。最大值为 200;(更高的值将被强制转换为最大值)

page_token

string

从之前的 ListSKAdNetworkConversionValueSchemas 调用接收的页面令牌。利用其进行后续页面检索。进行分页时,提供给 ListSKAdNetworkConversionValueSchema 的所有其他参数必须与提供页面令牌的调用相一致。

ListSKAdNetworkConversionValueSchemasResponse

针对 ListSKAdNetworkConversionValueSchemas RPC 的响应消息

字段
skadnetwork_conversion_value_schemas[]

SKAdNetworkConversionValueSchema

SKAdNetworkConversionValueSchema 的列表。此属性最多只能有一个值。

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。 目前,Google Analytics 仅支持每个 dataStream 一个 SKAdNetworkConversionValueSchema,因此该字段永远不会填充。

ListSearchAds360LinksRequest

针对 ListSearchAds360Links RPC 的请求消息。

字段
parent

string

必需。示例格式:properties/1234

page_size

int32

要返回的资源数量上限。如果未指定,则最多返回 50 个资源。最大值为 200(如果值高于此值,系统会强制转换为最大值)。

page_token

string

从之前的 ListSearchAds360Links 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时,提供给 ListSearchAds360Links 的所有其他参数必须与提供页面令牌的调用匹配。

ListSearchAds360LinksResponse

针对 ListSearchAds360Links RPC 的响应消息。

字段
next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListSubpropertyEventFiltersRequest

针对 ListSubpropertyEventFilters RPC 的请求消息。

字段
parent

string

必需。普通属性的资源名称。格式:properties/property_id 示例:properties/123

page_size

int32

可选。要返回的资源数量上限。即使有其他网页,服务返回的值也可能小于此值。如果未指定,则最多返回 50 个资源。最大值为 200;(更高的值将被强制转换为最大值)

page_token

string

可选。从之前的 ListSubpropertyEventFilters 调用接收的页面令牌。利用其进行后续页面检索。进行分页时,提供给 ListSubpropertyEventFilters 的所有其他参数必须与提供页面令牌的调用相一致。

ListSubpropertyEventFiltersResponse

针对 ListSubpropertyEventFilter RPC 的响应消息。

字段
subproperty_event_filters[]

SubpropertyEventFilter

子媒体资源事件过滤器的列表。

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListSubpropertySyncConfigsRequest

针对 ListSubpropertySyncConfigs RPC 的请求消息。

字段
parent

string

必需。媒体资源的名称。格式:properties/property_id 示例:properties/123

page_size

int32

可选。要返回的资源数量上限。即使有其他网页,服务返回的值也可能小于此值。如果未指定,则最多返回 50 个资源。最大值为 200;(更高的值将被强制转换为最大值)

page_token

string

可选。从之前的 ListSubpropertySyncConfig 调用接收的页面令牌。利用其进行后续页面检索。进行分页时,提供给 ListSubpropertySyncConfig 的所有其他参数必须与提供页面令牌的调用相一致。

ListSubpropertySyncConfigsResponse

针对 ListSubpropertySyncConfigs RPC 的响应消息。

字段
subproperty_sync_configs[]

SubpropertySyncConfig

SubpropertySyncConfig 资源的列表。

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

MatchingCondition

定义事件编辑或事件创建规则何时适用于事件的条件。

字段
field

string

必需。用于比较条件的字段的名称。如果指定了“event_name”,则此条件将应用于事件的名称。否则,相应条件将应用于具有指定名称的形参。

此值不得包含空格。

comparison_type

ComparisonType

必需。要应用于值的比较类型。

value

string

必需。相应条件的比较对象值。运行时实现可能会对此值执行类型强制转换,以根据参数值的类型评估此条件。

negated

bool

是否应否定比较结果。例如,如果 negated 为 true,则“等于”比较将充当“不等于”比较。

ComparisonType

匹配条件的比较类型

枚举
COMPARISON_TYPE_UNSPECIFIED 未知
EQUALS 等于(区分大小写)
EQUALS_CASE_INSENSITIVE 相等,不区分大小写
CONTAINS 包含(区分大小写)
CONTAINS_CASE_INSENSITIVE 包含(不区分大小写)
STARTS_WITH 开头为(区分大小写)
STARTS_WITH_CASE_INSENSITIVE 开头为(不区分大小写)
ENDS_WITH 以指定字符串结尾(区分大小写)
ENDS_WITH_CASE_INSENSITIVE 结尾为(不区分大小写)
GREATER_THAN 大于
GREATER_THAN_OR_EQUAL 大于或等于
LESS_THAN 小于
LESS_THAN_OR_EQUAL 小于或等于
REGULAR_EXPRESSION 正则表达式。仅支持网站数据流。
REGULAR_EXPRESSION_CASE_INSENSITIVE 正则表达式,不区分大小写。仅支持网站数据流。

MeasurementProtocolSecret

用于向 Measurement Protocol 发送命中数据的密钥值。

字段
name

string

仅限输出。相应 Secret 的资源名称。此 Secret 可以是任何类型的数据流的子级。格式:properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

display_name

string

必需。相应 Secret 的直观易懂的显示名称。

secret_value

string

仅限输出。Measurement Protocol 密钥值。向相应密钥的父媒体资源发送命中时,请将此值传递给 Measurement Protocol API 的 api_secret 字段。

NumericValue

表示一个数字。

字段
联合字段 one_value。数值 one_value 只能是以下值之一:
int64_value

int64

整数值

double_value

double

DoubleValue

ParameterMutation

定义要变异的事件参数。

字段
parameter

string

必需。要变异的形参的名称。此值必须:* 少于 40 个字符。* 在规则中的所有变动中保持唯一性 * 只能包含字母、数字或 _(下划线)对于事件修改规则,名称也可以设置为“event_name”,以便就地修改 event_name。

parameter_value

string

必需。要执行的值变更。* 不得超过 100 个字符。* 如需为参数指定常量值,请使用该值的字符串。* 如需从其他参数复制值,请使用“[[other_parameter]]”之类的语法。如需了解详情,请参阅这篇帮助中心文章

PostbackWindow

SKAdNetwork 转化回发时间范围的设置。

字段
conversion_values[]

ConversionValues

重复字段的顺序将用于确定转化价值设置的优先级。索引越低的条目的优先级越高。系统会选择评估结果为 true 的第一个转化价值设置。如果 enable_postback_window_settings 设置为 true,则必须至少包含一个条目。最多可包含 128 个条目。

postback_window_settings_enabled

bool

如果 enable_postback_window_settings 为 true,则必须填充 conversion_values,并且该值将用于确定何时以及如何在客户端设备上设置转化价值,以及将架构导出到关联的 Google Ads 账号。如果为 false,则不使用这些设置,但会保留这些设置,以防将来可能会使用。对于 postback_window_one,此值必须始终为 true。

属性

表示 Google Analytics 媒体资源的资源消息。

字段
name

string

仅限输出。相应媒体资源的资源名称。格式:properties/{property_id} 示例:“properties/1000”

property_type

PropertyType

不可变。相应媒体资源资源的媒体资源类型。创建媒体资源时,如果类型为“PROPERTY_TYPE_UNSPECIFIED”,则表示“ORDINARY_PROPERTY”。

create_time

Timestamp

仅限输出。实体的最初创建时间。

update_time

Timestamp

仅限输出。实体载荷字段的上次更新时间。

parent

string

不可变。相应媒体资源的逻辑父级的资源名称。

注意:您可以使用“资源移动”界面来更改父级。格式:accounts/{account}、properties/{property} 示例:“accounts/100”“properties/101”

display_name

string

必需。相应媒体资源的人类可读显示名称。

允许的显示名称长度上限为 100 个 UTF-16 代码单元。

industry_category

IndustryCategory

与相应房源关联的行业。示例:AUTOMOTIVE、FOOD_AND_DRINK

time_zone

string

必需。报告时区,用作报告的每日起止时间,而无论数据来自何处。如果所选时区使用夏时制,Google Analytics 会根据相应的变化自动做出调整。

注意:更改时区只会影响未来的数据,不会影响以前的数据。

格式:https://www.iana.org/time-zones 示例:“America/Los_Angeles”

currency_code

string

涉及货币价值的报告中使用的币种类型。

格式:https://en.wikipedia.org/wiki/ISO_4217 示例:“USD”“EUR”“JPY”

service_level

ServiceLevel

仅限输出。适用于相应媒体资源的 Google Analytics 服务等级。

delete_time

Timestamp

仅限输出。如果已设置,则表示相应媒体资源被放入回收站的时间。如果未设置,则表示相应媒体资源目前不在回收站中。

expire_time

Timestamp

仅限输出。如果已设置,则表示相应已放入回收站的媒体资源将被永久删除的时间。如果未设置,则表示相应媒体资源目前不在回收站中,并且未计划删除。

account

string

不可变。父账号的资源名称。格式:accounts/{account_id}。示例:“accounts/123”

PropertySummary

一种虚拟资源,用于表示 Google Analytics 媒体资源的元数据。

字段
property

string

相应媒体资源摘要所指媒体资源的资源名称。格式:properties/{property_id}。示例:“properties/1000”

display_name

string

相应媒体资源摘要中提及的媒体资源的显示名称。

property_type

PropertyType

相应媒体资源的媒体资源类型。

parent

string

相应媒体资源的逻辑父级的资源名称。

注意:您可以使用“资源移动”界面来更改父级。格式:accounts/{account}, properties/{property} 示例:“accounts/100”“properties/200”

PropertyType

Property 资源的类型。

枚举
PROPERTY_TYPE_UNSPECIFIED 房源类型未知或未指定
PROPERTY_TYPE_ORDINARY 普通 Google Analytics 媒体资源
PROPERTY_TYPE_SUBPROPERTY Google Analytics 子媒体资源
PROPERTY_TYPE_ROLLUP Google Analytics 总览媒体资源

ProvisionAccountTicketRequest

针对 ProvisionAccountTicket RPC 的请求消息。

字段
account

Account

要创建的账号。

redirect_uri

string

用户接受服务条款后会转到的重定向 URI。必须在 Cloud 控制台中配置为重定向 URI。

ProvisionAccountTicketResponse

针对 ProvisionAccountTicket RPC 的响应消息。

字段
account_ticket_id

string

要在服务条款链接中传递的参数。

ProvisionSubpropertyRequest

针对 CreateSubproperty RPC 的请求消息。

字段
subproperty

Property

必需。要创建的子媒体资源。

subproperty_event_filter

SubpropertyEventFilter

可选。要在普通媒体资源上创建的子媒体资源事件过滤器。

custom_dimension_and_metric_synchronization_mode

SynchronizationMode

可选。自定义维度和指标的子媒体资源功能同步模式

ProvisionSubpropertyResponse

针对 ProvisionSubproperty RPC 的响应消息。

字段
subproperty

Property

创建的子媒体资源。

subproperty_event_filter

SubpropertyEventFilter

创建的子媒体资源事件过滤器。

ReorderEventEditRulesRequest

针对 ReorderEventEditRules RPC 的请求消息。

字段
parent

string

必需。示例格式:properties/123/dataStreams/456

event_edit_rules[]

string

必需。指定数据流的 EventEditRule 资源名称,按所需的处理顺序排列。相应数据流的所有 EventEditRule 都必须包含在列表中。

ReportingDataAnnotation

报告数据注释是指与报告数据的特定日期相关联的注释。

字段
name

string

必需。标识符。相应报告数据注释的资源名称。格式:'properties/{property_id}/reportingDataAnnotations/{reporting_data_annotation}' 格式:'properties/123/reportingDataAnnotations/456'

title

string

必需。相应报告数据注释的直观易懂的标题。

description

string

可选。相应报告数据注释的说明。

color

Color

必需。用于显示相应报告数据注释的颜色。

system_generated

bool

仅限输出。如果为 true,则表示相应注释是由 Google Analytics 系统生成的。系统生成的注释无法更新或删除。

联合字段 target。相应报告数据注释 target 的目标只能是以下其中一项:
annotation_date

Date

如果已设置,则报告数据注释适用于此字段所代表的特定日期。日期必须是设置了年、月和日的有效日期。日期可以是过去、当前或未来的日期。

annotation_date_range

DateRange

如果设置了此字段,则表示报告数据注释适用于此字段所表示的日期范围。

颜色

可用于此报告数据注释的颜色

枚举
COLOR_UNSPECIFIED 颜色未知或未指定。
PURPLE 紫色。
BROWN 棕色。
BLUE 蓝色。
GREEN 绿色。
RED 红色。
CYAN 青色。
ORANGE 橙色。(仅用于系统生成的注释)

DateRange

表示报告数据注释的日期范围,包括开始日期和结束日期。时区基于父属性。

字段
start_date

Date

必需。相应范围的开始日期。必须是设置了年、月和日的有效日期。日期可以是过去、当前或未来的日期。

end_date

Date

必需。相应范围的结束日期。必须是设置了年、月和日的有效日期。此日期必须晚于或等于开始日期。

ReportingIdentitySettings

一种包含与报告身份相关的设置的资源。

字段
name

string

仅限输出。标识符。相应报告身份设置单例资源的资源名称。格式:properties/{property_id}/reportingIdentitySettings 示例:“properties/1234/reportingIdentitySettings”

reporting_identity

ReportingIdentity

用于在报告中识别用户身份的策略。

ReportingIdentity

用于在报告中识别用户身份的各种策略。

枚举
IDENTITY_BLENDING_STRATEGY_UNSPECIFIED 未指定混合策略。
BLENDED 混合在报告中使用的 ID 策略。
OBSERVED 观察到的报告身份策略。
DEVICE_BASED 基于设备的“在报告中使用的 ID”策略。

RunAccessReportRequest

数据访问记录报告的请求。

字段
entity

string

数据访问报告支持在媒体资源级或账号级提出请求。如果是在账号一级请求数据访问报告,则报告会包含相应账号下所有媒体资源的所有访问记录。

如需在媒体资源级发出请求,实体应为“properties/123”(如果“123”是您的 Google Analytics 媒体资源 ID)。如需在账号级层发出请求,实体应为“accounts/1234”(如果“1234”是您的 Google Analytics 账号 ID)。

dimensions[]

AccessDimension

请求的维度以及响应中显示的维度。请求最多允许包含 9 个维度。

metrics[]

AccessMetric

请求的指标以及在回答中显示的指标。最多允许请求 10 个指标。

date_ranges[]

AccessDateRange

要读取的访问记录的日期范围。如果请求了多个日期范围,则每个响应行都将包含一个从零开始的日期范围索引。如果两个日期范围重叠,则重叠日期的访问记录会包含在两个日期范围的响应行中。最多允许 2 个日期范围。

dimension_filter

AccessFilterExpression

借助维度过滤条件,您可以将报告响应限制为与过滤条件匹配的特定维度值。例如,过滤单个用户的访问记录。如需了解详情,请参阅维度过滤条件基础知识,其中包含相关示例。此过滤条件不支持使用指标。

metric_filter

AccessFilterExpression

借助指标过滤条件,您可以将报告响应限制为与过滤条件匹配的特定指标值。指标过滤条件是在汇总报告的行之后应用的,类似于 SQL 的 having 子句。此过滤条件中不能使用维度。

offset

int64

起始行的行数。第一行计为第 0 行。如果未指定偏移量,则将其视为 0。如果偏移量为零,则此方法将返回包含 limit 个条目的第一页结果。

如需详细了解此分页参数,请参阅分页

limit

int64

要返回的行数。如果未指定,则返回 10,000 行。无论您请求多少行,该 API 每次请求最多返回 10 万行。limit 必须为正值。

如果剩余的行数少于 limit,API 返回的行数可能会少于请求的 limit。例如,维度 country 的可能值少于 300 个,因此在仅针对 country 生成报告时,即使您将 limit 设置为更高的值,也无法获得超过 300 行的数据。

如需详细了解此分页参数,请参阅分页

time_zone

string

相应请求的时区(如果已指定)。如果未指定,则使用相应媒体资源的所在时区。请求的时区用于解读报告的开始日期和结束日期。

格式为 IANA 时区数据库中的字符串 (https://www.iana.org/time-zones);例如“America/New_York”或“Asia/Tokyo”。

order_bys[]

AccessOrderBy

指定响应中各行的排序方式。

return_entity_quota

bool

切换是否返回相应 Google Analytics 媒体资源的配额的当前状态。配额在 AccessQuota 中返回。对于账号级请求,此字段必须为 false。

include_all_users

bool

可选。确定是否在响应中包含从未进行过 API 调用的用户。如果为 true,则响应中会包含有权访问指定媒体资源或账号的所有用户,无论他们是否已发出 API 调用。如果为 false,则仅包含已进行 API 调用的用户。

expand_groups

bool

可选。决定是否返回用户群组中的用户。此字段仅在 include_all_users 设置为 true 时有效。如果为 true,则返回有权访问指定媒体资源或账号的所有用户。如果为 false,则仅返回具有直接访问权限的用户。

RunAccessReportResponse

自定义的数据访问记录报告响应。

字段
dimension_headers[]

AccessDimensionHeader

报告中与特定维度对应的列的标题。DimensionHeaders 的数量和顺序与行中存在的维度一致。

metric_headers[]

AccessMetricHeader

报告中与特定指标对应的列的标题。MetricHeaders 的数量和顺序与行中存在的指标相匹配。

rows[]

AccessRow

报告中维度值组合和指标值的行数。

row_count

int32

查询结果中的总行数。rowCount 与响应中返回的行数、limit 请求参数和 offset 请求参数无关。例如,如果查询返回 175 行,并且 API 请求中包含 50 的 limit,则响应将包含 175 的 rowCount,但只有 50 行。

如需详细了解此分页参数,请参阅分页

quota

AccessQuota

相应 Google Analytics 媒体资源(包括相应请求)的配额状态。此字段不适用于账号级请求。

SKAdNetworkConversionValueSchema

iOS 媒体资源的 SKAdNetwork 转化价值架构。

字段
name

string

仅限输出。架构的资源名称。此元素只能是 iOS 流的子元素,并且一个 iOS 流下最多只能有一个此类子元素。格式:properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema

postback_window_one

PostbackWindow

必需。第一个回传时间范围的转化价值设置。这些值与回发窗口 2 和 3 的值不同,因为它们包含“精细”的转化价值(一个数值)。

必须为此回传时间范围设置转化价值。其他窗口是可选的,如果未设置或已停用,则可能会继承此窗口的设置。

postback_window_two

PostbackWindow

第二个回传时间范围的转化价值设置。

只有在需要为此回传时间范围定义不同的转化价值时,才应配置此字段。

如果针对此回发窗口将 enable_postback_window_settings 设置为 false,则将使用 postback_window_one 中的值。

postback_window_three

PostbackWindow

第三个回传时间范围的转化价值设置。

只有当用户选择为此回传时间范围定义不同的转化价值时,才应设置此字段。允许在不设置窗口 2 的情况下配置窗口 3。如果设置了时间范围 1 和 2 的设置,并且相应回传时间范围的 enable_postback_window_settings 设置为 false,则架构将继承 postback_window_two 中的设置。

apply_conversion_values

bool

如果启用,GA SDK 将使用此架构定义设置转化价值,并且架构将导出到与相应媒体资源关联的所有 Google Ads 账号。如果停用,GA SDK 将不会自动设置转化价值,并且架构也不会导出到 Google Ads。

SearchChangeHistoryEventsRequest

针对 SearchChangeHistoryEvents RPC 的请求消息。

字段
account

string

必需。要返回更改历史记录资源的账号资源。格式:accounts/{account}

示例:accounts/100

property

string

可选。子级媒体资源的资源名称。如果设置,则仅返回对此属性或其子资源所做的更改。格式:properties/{propertyId}

示例:properties/100

resource_type[]

ChangeHistoryResourceType

可选。如果设置,则仅当更改所针对的资源与至少一种这些类型匹配时,才返回更改。

action[]

ActionType

可选。如果设置了此参数,则仅返回与这些操作类型中的一种或多种匹配的更改。

actor_email[]

string

可选。如果设置了此参数,则仅当更改是由此列表中的用户做出的时,才返回更改。

earliest_change_time

Timestamp

可选。如果进行了设置,则只会返回相应时间(含此时间)之后所做的更改。

latest_change_time

Timestamp

可选。如果进行了设置,则只会返回相应时间之前(含此时间)所做的更改。

page_size

int32

可选。要返回的 ChangeHistoryEvent 项数的上限。如果未指定,则最多返回 50 个商品。最大值为 200(如果值高于此值,系统会强制转换为最大值)。

请注意,服务返回的页面中的项目数量可能少于此值指定的数量(甚至可能为零),并且可能仍有其他页面。如果您需要特定数量的商品,则需要继续使用 page_token 请求其他页面,直到获得所需的数量。

page_token

string

可选。从之前的 SearchChangeHistoryEvents 调用接收的页面令牌。利用其进行后续页面检索。进行分页时,提供给 SearchChangeHistoryEvents 的所有其他参数必须与提供页面令牌的调用相一致。

SearchChangeHistoryEventsResponse

针对 SearchAccounts RPC 的响应消息。

字段
change_history_events[]

ChangeHistoryEvent

调用者可访问的结果。

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ServiceLevel

Google Analytics 的各种服务级别。

枚举
SERVICE_LEVEL_UNSPECIFIED 未指定服务级别或服务级别无效。
GOOGLE_ANALYTICS_STANDARD Google Analytics 的标准版。
GOOGLE_ANALYTICS_360 Google Analytics 的付费高级版。

SubmitUserDeletionRequest

针对 SubmitUserDeletion RPC 的请求消息。

字段
name

string

必需。要提交用户删除请求的媒体资源的名称。

联合字段 user。提交删除请求的用户 user 只能是以下用户之一:
user_id

string

Google Analytics 用户 ID

client_id

string

Google Analytics 客户端 ID

app_instance_id

string

Firebase 应用实例 ID

user_provided_data

string

用户提供的数据。可以包含一个电子邮件地址或一个电话号码。

电子邮件地址应按如下方式进行规范化:

  • 小写
  • 针对 gmail.com/googlemail.com 地址,移除 @ 前面的句点
  • 移除所有空格

电话号码应按如下方式进行规范化:

  • 移除所有非数字字符
  • 添加“+”前缀

SubmitUserDeletionResponse

针对 SubmitUserDeletion RPC 的响应消息。

字段
deletion_request_time

Timestamp

标记一个时间点,该时间点之前的所有访问者数据都应被删除。此属性设置为收到删除请求的时间。

SubpropertyEventFilter

一种资源消息,用于表示 Google Analytics 子媒体资源的事件过滤器。

字段
name

string

仅限输出。格式:properties/{ordinary_property_id}/subpropertyEventFilters/{sub_property_event_filter} 示例:properties/1234/subpropertyEventFilters/5678

filter_clauses[]

SubpropertyEventFilterClause

必需。无序列表。用于定义 SubpropertyEventFilter 的过滤条件子句。所有子句都通过 AND 运算组合在一起,以确定要将哪些数据发送到子媒体资源。

apply_to_property

string

不可变。使用相应过滤条件的子媒体资源的资源名称。

SubpropertyEventFilterClause

用于定义过滤条件的子句。过滤器可以是包含性过滤器(满足过滤条件子句的事件包含在子媒体资源的数据中),也可以是排除性过滤器(满足过滤条件子句的事件排除在子媒体资源的数据之外)。

字段
filter_clause_type

FilterClauseType

必需。过滤条件子句的类型。

filter_expression

SubpropertyEventFilterExpression

必需。发送到子媒体资源的事件的逻辑表达式。

FilterClauseType

指定这是包含过滤条件子句还是排除过滤条件子句。

枚举
FILTER_CLAUSE_TYPE_UNSPECIFIED 过滤子句类型未知或未指定。
INCLUDE 如果满足过滤条件子句,则子媒体资源中将包含相应事件。
EXCLUDE 如果满足过滤条件子句,相应事件将从子媒体资源中排除。

SubpropertyEventFilterCondition

特定过滤表达式

字段
field_name

string

必需。要过滤的字段。

联合字段 one_filter

one_filter 只能是下列其中一项:

null_filter

bool

用于过滤 null 值的过滤条件。

string_filter

StringFilter

用于过滤与特定模式匹配的字符串类型维度的过滤条件。

StringFilter

用于过滤与特定模式匹配的字符串类型维度的过滤条件。

字段
match_type

MatchType

必需。字符串过滤器的匹配类型。

value

string

必需。用于匹配的字符串值。

case_sensitive

bool

可选。如果为 true,则字符串值区分大小写。如果为 false,则匹配不区分大小写。

MatchType

过滤条件将如何用于确定是否匹配。

枚举
MATCH_TYPE_UNSPECIFIED 匹配类型未知或未指定。
EXACT 字符串值完全匹配。
BEGINS_WITH 以字符串值开头。
ENDS_WITH 以字符串值结尾。
CONTAINS 包含字符串值。
FULL_REGEXP 正则表达式与字符串值完全匹配。
PARTIAL_REGEXP 正则表达式与字符串值部分匹配。

SubpropertyEventFilterExpression

子媒体资源事件过滤条件的逻辑表达式。

字段
联合字段 expr。应用于过滤器的表达式。expr 只能是下列其中一项:
or_group

SubpropertyEventFilterExpressionList

要使用 OR 运算符组合在一起的表达式列表。只能包含 not_expression 或 filter_condition 表达式。

not_expression

SubpropertyEventFilterExpression

要进行 NOT 运算(反转、求补)的过滤条件表达式。只能包含过滤条件。无法在顶级 SubpropertyEventFilterExpression 上设置此属性。

filter_condition

SubpropertyEventFilterCondition

创建一个与特定事件匹配的过滤条件。无法在顶级 SubpropertyEventFilterExpression 上设置此属性。

SubpropertyEventFilterExpressionList

子媒体资源事件过滤条件表达式的列表。

字段
filter_expressions[]

SubpropertyEventFilterExpression

必需。无序列表。子媒体资源事件过滤条件表达式的列表

SubpropertySyncConfig

子媒体资源同步配置用于控制如何将普通媒体资源配置同步到子媒体资源。系统会自动为每个子媒体资源配置此资源。

字段
name

string

仅限输出。标识符。格式:properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} 示例:properties/1234/subpropertySyncConfigs/5678

apply_to_property

string

仅限输出。不可变。相应设置所适用的子媒体资源的资源名称。

custom_dimension_and_metric_sync_mode

SynchronizationMode

必需。指定子媒体资源的自定义维度 / 指标同步模式。

如果设置为 ALL,系统会立即启用自定义维度 / 指标同步。只要同步模式设置为 ALL,子媒体资源就不允许进行自定义维度 / 指标的本地配置。

如果设置为 NONE,则停用自定义维度 / 指标同步。必须在子媒体资源中明确配置自定义维度 / 指标。

SynchronizationMode

子媒体资源的同步模式

枚举
SYNCHRONIZATION_MODE_UNSPECIFIED 同步模式未知或未指定。
NONE 实体未同步。允许对子媒体资源进行本地修改。
ALL 实体是从父媒体资源同步的。不允许对子媒体资源进行本地更改(创建 / 更新 / 删除)

UpdateAccessBindingRequest

针对 UpdateAccessBinding RPC 的请求消息。

字段
access_binding

AccessBinding

必需。要更新的访问权限绑定。

UpdateAccountRequest

针对 UpdateAccount RPC 的请求消息。

字段
account

Account

必需。要更新的账号。账号的 name 字段用于标识账号。

update_mask

FieldMask

必需。要更新的字段的列表。字段名称必须采用蛇形命名法(例如“field_to_update”)。省略的字段将不会更新。如需替换整个实体,请使用一个包含字符串“*”的路径来匹配所有字段。

UpdateAttributionSettingsRequest

针对 UpdateAttributionSettings RPC 的请求消息

字段
attribution_settings

AttributionSettings

必需。要更新的归因设置。name 字段用于标识要更新的设置。

update_mask

FieldMask

必需。要更新的字段的列表。字段名称必须采用蛇形命名法(例如,“field_to_update”)。省略的字段将不会更新。如需替换整个实体,请使用一个包含字符串“*”的路径来匹配所有字段。

UpdateAudienceRequest

针对 UpdateAudience RPC 的请求消息。

字段
audience

Audience

必需。要更新的受众群体。受众群体的 name 字段用于标识要更新的受众群体。

update_mask

FieldMask

必需。要更新的字段的列表。字段名称必须采用蛇形命名法(例如,“field_to_update”)。省略的字段将不会更新。如需替换整个实体,请使用一个包含字符串“*”的路径来匹配所有字段。

UpdateBigQueryLinkRequest

针对 UpdateBigQueryLink RPC 的请求消息。

字段
update_mask

FieldMask

必需。要更新的字段的列表。字段名称必须采用蛇形命名法(例如,“field_to_update”)。省略的字段将不会更新。如需替换整个实体,请使用一个包含字符串“*”的路径来匹配所有字段。

UpdateCalculatedMetricRequest

针对 UpdateCalculatedMetric RPC 的请求消息。

字段
calculated_metric

CalculatedMetric

必需。要更新的 CalculatedMetric

update_mask

FieldMask

必需。要更新的字段的列表。省略的字段将不会更新。如需替换整个实体,请使用一个包含字符串“*”的路径来匹配所有字段。

UpdateChannelGroupRequest

针对 UpdateChannelGroup RPC 的请求消息。

字段
channel_group

ChannelGroup

必需。要更新的 ChannelGroup。资源的 name 字段用于标识要更新的 ChannelGroup。

update_mask

FieldMask

必需。要更新的字段的列表。字段名称必须采用蛇形命名法(例如,“field_to_update”)。省略的字段将不会更新。如需替换整个实体,请使用一个包含字符串“*”的路径来匹配所有字段。

UpdateConversionEventRequest

针对 UpdateConversionEvent RPC 的请求消息

字段
conversion_event

ConversionEvent

必需。要更新的转化事件。name 字段用于标识要更新的设置。

update_mask

FieldMask

必需。要更新的字段的列表。字段名称必须采用蛇形命名法(例如,“field_to_update”)。省略的字段将不会更新。如需替换整个实体,请使用一个包含字符串“*”的路径来匹配所有字段。

UpdateCustomDimensionRequest

针对 UpdateCustomDimension RPC 的请求消息。

字段
custom_dimension

CustomDimension

要更新的 CustomDimension

update_mask

FieldMask

必需。要更新的字段的列表。省略的字段将不会更新。如需替换整个实体,请使用一个包含字符串“*”的路径来匹配所有字段。

UpdateCustomMetricRequest

针对 UpdateCustomMetric RPC 的请求消息。

字段
custom_metric

CustomMetric

要更新的 CustomMetric

update_mask

FieldMask

必需。要更新的字段的列表。省略的字段将不会更新。如需替换整个实体,请使用一个包含字符串“*”的路径来匹配所有字段。

UpdateDataRedactionSettingsRequest

针对 UpdateDataRedactionSettings RPC 的请求消息。

字段
data_redaction_settings

DataRedactionSettings

必需。要更新的设置。name 字段用于标识要更新的设置。

update_mask

FieldMask

必需。要更新的字段的列表。字段名称必须采用蛇形命名法(例如,“field_to_update”)。省略的字段将不会更新。如需替换整个实体,请使用一个包含字符串“*”的路径来匹配所有字段。

UpdateDataRetentionSettingsRequest

针对 UpdateDataRetentionSettings RPC 的请求消息。

字段
data_retention_settings

DataRetentionSettings

必需。要更新的设置。name 字段用于标识要更新的设置。

update_mask

FieldMask

必需。要更新的字段的列表。字段名称必须采用蛇形命名法(例如,“field_to_update”)。省略的字段将不会更新。如需替换整个实体,请使用一个包含字符串“*”的路径来匹配所有字段。

UpdateDataStreamRequest

针对 UpdateDataStream RPC 的请求消息。

字段
data_stream

DataStream

要更新的 DataStream

update_mask

FieldMask

必需。要更新的字段的列表。省略的字段将不会更新。如需替换整个实体,请使用一个包含字符串“*”的路径来匹配所有字段。

UpdateDisplayVideo360AdvertiserLinkRequest

针对 UpdateDisplayVideo360AdvertiserLink RPC 的请求消息。

字段
update_mask

FieldMask

必需。要更新的字段的列表。省略的字段将不会更新。如需替换整个实体,请使用一个包含字符串“*”的路径来匹配所有字段。

UpdateEnhancedMeasurementSettingsRequest

针对 UpdateEnhancedMeasurementSettings RPC 的请求消息。

字段
enhanced_measurement_settings

EnhancedMeasurementSettings

必需。要更新的设置。name 字段用于标识要更新的设置。

update_mask

FieldMask

必需。要更新的字段的列表。字段名称必须采用蛇形命名法(例如,“field_to_update”)。省略的字段将不会更新。如需替换整个实体,请使用一个包含字符串“*”的路径来匹配所有字段。

UpdateEventCreateRuleRequest

针对 UpdateEventCreateRule RPC 的请求消息。

字段
event_create_rule

EventCreateRule

必需。要更新的 EventCreateRule。资源的 name 字段用于标识要更新的 EventCreateRule。

update_mask

FieldMask

必需。要更新的字段的列表。字段名称必须采用蛇形命名法(例如,“field_to_update”)。省略的字段将不会更新。如需替换整个实体,请使用一个包含字符串“*”的路径来匹配所有字段。

UpdateEventEditRuleRequest

针对 UpdateEventEditRule RPC 的请求消息。

字段
event_edit_rule

EventEditRule

必需。要更新的 EventEditRule。资源的 name 字段用于标识要更新的 EventEditRule。

update_mask

FieldMask

必需。要更新的字段的列表。字段名称必须采用蛇形命名法(例如,“field_to_update”)。省略的字段将不会更新。如需替换整个实体,请使用一个包含字符串“*”的路径来匹配所有字段。

UpdateExpandedDataSetRequest

针对 UpdateExpandedDataSet RPC 的请求消息。

字段
expanded_data_set

ExpandedDataSet

必需。要更新的 ExpandedDataSet。资源的 name 字段用于标识要更新的 ExpandedDataSet。

update_mask

FieldMask

必需。要更新的字段的列表。字段名称必须采用蛇形命名法(例如,“field_to_update”)。省略的字段将不会更新。如需替换整个实体,请使用一个包含字符串“*”的路径来匹配所有字段。

UpdateGoogleAdsLinkRequest

针对 UpdateGoogleAdsLink RPC 的请求消息

字段
update_mask

FieldMask

必需。要更新的字段的列表。字段名称必须采用蛇形命名法(例如,“field_to_update”)。省略的字段将不会更新。如需替换整个实体,请使用一个包含字符串“*”的路径来匹配所有字段。

UpdateGoogleSignalsSettingsRequest

针对 UpdateGoogleSignalsSettings RPC 的请求消息

字段
google_signals_settings

GoogleSignalsSettings

必需。要更新的设置。name 字段用于标识要更新的设置。

update_mask

FieldMask

必需。要更新的字段的列表。字段名称必须采用蛇形命名法(例如,“field_to_update”)。省略的字段将不会更新。如需替换整个实体,请使用一个包含字符串“*”的路径来匹配所有字段。

UpdateKeyEventRequest

针对 UpdateKeyEvent RPC 的请求消息

字段
key_event

KeyEvent

必需。要更新的关键事件。name 字段用于标识要更新的设置。

update_mask

FieldMask

必需。要更新的字段的列表。字段名称必须采用蛇形命名法(例如,“field_to_update”)。省略的字段将不会更新。如需替换整个实体,请使用一个包含字符串“*”的路径来匹配所有字段。

UpdateMeasurementProtocolSecretRequest

针对 UpdateMeasurementProtocolSecret RPC 的请求消息

字段
measurement_protocol_secret

MeasurementProtocolSecret

必需。要更新的 Measurement Protocol 密钥。

update_mask

FieldMask

必需。要更新的字段的列表。省略的字段将不会更新。

UpdatePropertyRequest

针对 UpdateProperty RPC 的请求消息。

字段
property

Property

必需。要更新的媒体资源。相应属性的 name 字段用于标识要更新的属性。

update_mask

FieldMask

必需。要更新的字段的列表。字段名称必须采用蛇形命名法(例如,“field_to_update”)。省略的字段将不会更新。如需替换整个实体,请使用一个包含字符串“*”的路径来匹配所有字段。

UpdateReportingDataAnnotationRequest

针对 UpdateReportingDataAnnotation RPC 的请求消息。

字段
reporting_data_annotation

ReportingDataAnnotation

必需。要更新的报告数据注释。

update_mask

FieldMask

可选。要更新的字段的列表。字段名称必须采用蛇形命名法(例如“field_to_update”)。省略的字段将不会更新。如需替换整个实体,请使用一个包含字符串“*”的路径来匹配所有字段。

UpdateSKAdNetworkConversionValueSchemaRequest

针对 UpdateSKAdNetworkConversionValueSchema RPC 的请求消息。

字段
skadnetwork_conversion_value_schema

SKAdNetworkConversionValueSchema

必需。要更新的 SKAdNetwork 转化价值架构。

update_mask

FieldMask

必需。要更新的字段的列表。省略的字段将不会更新。

UpdateSearchAds360LinkRequest

针对 UpdateSearchAds360Link RPC 的请求消息。

字段
update_mask

FieldMask

必需。要更新的字段的列表。省略的字段将不会更新。如需替换整个实体,请使用一个包含字符串“*”的路径来匹配所有字段。

UpdateSubpropertyEventFilterRequest

针对 UpdateSubpropertyEventFilter RPC 的请求消息。

字段
subproperty_event_filter

SubpropertyEventFilter

必需。要更新的子媒体资源事件过滤器。

update_mask

FieldMask

必需。要更新的字段的列表。字段名称必须采用蛇形命名法(例如“field_to_update”)。省略的字段将不会更新。如需替换整个实体,请使用一个包含字符串“*”的路径来匹配所有字段。

UpdateSubpropertySyncConfigRequest

针对 UpdateSubpropertySyncConfig RPC 的请求消息。

字段
subproperty_sync_config

SubpropertySyncConfig

必需。要更新的 SubpropertySyncConfig

update_mask

FieldMask

可选。要更新的字段的列表。字段名称必须采用蛇形命名法(例如“field_to_update”)。省略的字段将不会更新。如需替换整个实体,请使用一个包含字符串“*”的路径来匹配所有字段。