Package google.analytics.admin.v1alpha

索引

AnalyticsAdminService

Google Analytics(分析)Admin API (GA4) 的服务接口。

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)

对媒体资源的自定义维度进行归档。

授权范围

需要以下 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
CreateConnectedSiteTag

rpc CreateConnectedSiteTag(CreateConnectedSiteTagRequest) returns (CreateConnectedSiteTagResponse)

为 Universal Analytics 媒体资源创建已关联的网站代码。您最多可以为每项媒体资源创建 20 个已关联的网站代码。注意:此 API 不能用于 GA4 媒体资源。

授权范围

需要以下 OAuth 作用域:

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

rpc CreateConversionEvent(CreateConversionEventRequest) returns (ConversionEvent)

创建具有指定属性的转化事件。

授权范围

需要以下 OAuth 作用域:

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

rpc CreateCustomDimension(CreateCustomDimensionRequest) returns (CustomDimension)

创建自定义维度。

授权范围

需要以下 OAuth 作用域:

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

rpc CreateCustomMetric(CreateCustomMetricRequest) returns (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
CreateExpandedDataSet

rpc CreateExpandedDataSet(CreateExpandedDataSetRequest) returns (ExpandedDataSet)

创建 ExpandDataSet。

授权范围

需要以下 OAuth 作用域:

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

rpc CreateMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret)

创建 Measurement Protocol 密钥。

授权范围

需要以下 OAuth 作用域:

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

rpc CreateProperty(CreatePropertyRequest) returns (Property)

创建具有指定位置和属性的“GA4”媒体资源。

授权范围

需要以下 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
CreateSubproperty

rpc CreateSubproperty(CreateSubpropertyRequest) returns (CreateSubpropertyResponse)

创建子媒体资源以及应用于已创建的子媒体资源的子媒体资源事件过滤器。

授权范围

需要以下 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 没有恢复软删除账号的方法。但是,您可以通过回收站界面还原这些内容。

如果您在到期前未恢复账号,该账号及所有子资源(例如媒体资源、GoogleAdsLink、Streams、AccessBinding)将被永久清除。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
DeleteConnectedSiteTag

rpc DeleteConnectedSiteTag(DeleteConnectedSiteTagRequest) returns (Empty)

删除 Universal Analytics 媒体资源的已关联的网站代码。注意:这对 GA4 媒体资源没有影响。

授权范围

需要以下 OAuth 作用域:

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

rpc DeleteConversionEvent(DeleteConversionEventRequest) returns (Empty)

删除媒体资源中的转化事件。

授权范围

需要以下 OAuth 作用域:

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

rpc DeleteDataStream(DeleteDataStreamRequest) returns (Empty)

删除媒体资源上的 DataStream。

授权范围

需要以下 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
DeleteExpandedDataSet

rpc DeleteExpandedDataSet(DeleteExpandedDataSetRequest) returns (Empty)

删除属性上的 ExtendedDataSet。

授权范围

需要以下 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 没有恢复软删除属性的方法。但是,您可以通过回收站界面还原这些内容。

如果您未在过期前恢复媒体资源,该媒体资源及所有子资源(例如 GoogleAdsLink、Streams、AccessBinding)将被永久清除。https://support.google.com/analytics/answer/6154772

如果未找到目标或目标不是 GA4 媒体资源,则返回错误。

授权范围

需要以下 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
提取自动 Ga4 配置停用

rpc FetchAutomatedGa4ConfigurationOptOut(FetchAutomatedGa4ConfigurationOptOutRequest) returns (FetchAutomatedGa4ConfigurationOptOutResponse)

获取 UA 媒体资源的 GA4 自动设置流程的停用状态。注意:这对 GA4 媒体资源没有影响。

授权范围

需要以下 OAuth 范围之一:

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

rpc FetchConnectedGa4Property(FetchConnectedGa4PropertyRequest) returns (FetchConnectedGa4PropertyResponse)

针对指定的 UA 媒体资源,查找与其关联的 GA4 媒体资源。注意:这不能与 GA4 媒体资源一起使用。

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/analytics.readonly
  • 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)

检索单个转化事件。

授权范围

需要以下 OAuth 范围之一:

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

rpc GetCustomDimension(GetCustomDimensionRequest) returns (CustomDimension)

查找单个自定义维度。

授权范围

需要以下 OAuth 范围之一:

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

rpc GetCustomMetric(GetCustomMetricRequest) returns (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
GetExpandedDataSet

rpc GetExpandedDataSet(GetExpandedDataSetRequest) returns (ExpandedDataSet)

查找单个 ExtendedDataSet。

授权范围

需要以下 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
GetMeasurementProtocolSecret

rpc GetMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret)

查找单个“GA4”MeasurementProtocolSecret。

授权范围

需要以下 OAuth 范围之一:

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

rpc GetProperty(GetPropertyRequest) returns (Property)

查找单个“GA4”媒体资源。

授权范围

需要以下 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
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)

返回调用者可访问的所有帐号。

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

授权范围

需要以下 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)

列出属性的 CalculatedMetrics。

授权范围

需要以下 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
ListConnectedSiteTags

rpc ListConnectedSiteTags(ListConnectedSiteTagsRequest) returns (ListConnectedSiteTagsResponse)

列出 Universal Analytics 媒体资源的已关联的网站代码。系统最多会返回 20 个已关联的网站代码。注意:这对 GA4 媒体资源没有影响。

授权范围

需要以下 OAuth 范围之一:

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

rpc ListConversionEvents(ListConversionEventsRequest) returns (ListConversionEventsResponse)

返回指定父媒体资源中的转化事件列表。

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

授权范围

需要以下 OAuth 范围之一:

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

rpc ListCustomDimensions(ListCustomDimensionsRequest) returns (ListCustomDimensionsResponse)

列出媒体资源的 CustomDimensions。

授权范围

需要以下 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)

列出网站数据流上的 EventCreateRules。

授权范围

需要以下 OAuth 范围之一:

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

rpc ListExpandedDataSets(ListExpandedDataSetsRequest) returns (ListExpandedDataSetsResponse)

列出属性上的 ExtendedDataSet。

授权范围

需要以下 OAuth 范围之一:

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

rpc ListMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest) returns (ListMeasurementProtocolSecretsResponse)

返回指定父级属性下的子 MeasurementProtocolSecret。

授权范围

需要以下 OAuth 范围之一:

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

rpc ListProperties(ListPropertiesRequest) returns (ListPropertiesResponse)

返回指定父帐号下的子属性。

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

授权范围

需要以下 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
ProvisionAccountTicket

rpc ProvisionAccountTicket(ProvisionAccountTicketRequest) returns (ProvisionAccountTicketResponse)

请求创建账号的工单。

授权范围

需要以下 OAuth 作用域:

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

rpc RunAccessReport(RunAccessReportRequest) returns (RunAccessReportResponse)

返回数据访问记录的自定义报告。此报告会提供用户每次读取 Google Analytics(分析)报告数据的记录。访问记录最长会保留 2 年。

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

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

授权范围

需要以下 OAuth 范围之一:

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

rpc SearchChangeHistoryEvents(SearchChangeHistoryEventsRequest) returns (SearchChangeHistoryEventsResponse)

根据指定的一组过滤条件,搜索对某个帐号或其子帐号的所有更改。

授权范围

需要以下 OAuth 作用域:

  • https://www.googleapis.com/auth/analytics.edit
自动设置 Ga4ConfigurationOptOut

rpc SetAutomatedGa4ConfigurationOptOut(SetAutomatedGa4ConfigurationOptOutRequest) returns (SetAutomatedGa4ConfigurationOptOutResponse)

针对 UA 媒体资源的 GA4 自动设置流程设置停用状态。注意:这对 GA4 媒体资源没有影响。

授权范围

需要以下 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)

更新具有指定属性的转化事件。

授权范围

需要以下 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
UpdateExpandedDataSet

rpc UpdateExpandedDataSet(UpdateExpandedDataSetRequest) returns (ExpandedDataSet)

更新媒体资源上的 ExtendedDataSet。

授权范围

需要以下 OAuth 作用域:

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

rpc UpdateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest) returns (GoogleSignalsSettings)

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

授权范围

需要以下 OAuth 作用域:

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

rpc UpdateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret)

更新 Measurement Protocol Secret。

授权范围

需要以下 OAuth 作用域:

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

rpc UpdateProperty(UpdatePropertyRequest) returns (Property)

更新媒体资源。

授权范围

需要以下 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

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

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

有效值:recommendedRoles/viewer 预定义角色/analyst 预定义角色/editor 预先定义角色/管理员预定义角色/no-cost-data 预定义角色/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

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

字段
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 中的每个 FilterExpressions 都拥有 AND 关系。

or_group

AccessFilterExpressionList

or_group 中的每个 FilterExpressions 都有一个 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

描述报告中的指标列。报告中请求的可见指标会在行和 MetricHeader 中生成列条目。不过,专用于过滤器或表达式的指标不会在报告中生成列;相应地,这些指标也不会生成标题。

字段
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 在排序之前,维度值会转换为数字。例如,在 NUMERIC 排序中,"25" < "100",在 ALPHANUMERIC 排序中,"100" < "25"。所有非数字维度值的优先级值均低于所有数值。

MetricOrderBy

按指标值排序。

字段
metric_name

string

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

AccessQuota

此 Google Analytics(分析)媒体资源的所有配额的当前状态。如果某个媒体资源的任何配额已用尽,对该媒体资源的所有请求都将返回“资源已用尽”错误。

字段
tokens_per_day

AccessQuotaStatus

媒体资源每天可以使用 250,000 个令牌。大部分请求消耗的令牌数都少于 10 个。

tokens_per_hour

AccessQuotaStatus

媒体资源每小时可以使用 50,000 个令牌。一个 API 请求使用单一数量的令牌,该数量将从每小时、每日和每个项目每小时的所有配额中扣除。

concurrent_requests

AccessQuotaStatus

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

server_errors_per_project_per_hour

AccessQuotaStatus

媒体资源和云项目对每小时最多可以出现 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

仅限输出。表明此账号是否已被软删除。除非特别要求,否则已删除的账号会从列表结果中排除。

AccountSummary

一种虚拟资源,表示账号及其所有子 GA4 媒体资源的概览。

字段
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

必需。要归档的自定义维度的名称。示例格式:properties/1234/customDimensions/5678

ArchiveCustomMetricRequest

ArchiveCustomMetric RPC 的请求消息。

字段
name

string

必需。要归档的自定义指标的名称。示例格式: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

观众群

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

字段
name

string

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

display_name

string

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

description

string

必需。受众群体的说明。

membership_duration_days

int32

必需。不可变。用户在受众群体中停留的时长。该时间范围不能超过 540 天。

ads_personalization_enabled

bool

仅限输出。如果相应受众群体是非个性化广告受众群体,并且已从广告个性化中排除,Google Analytics(分析)会自动将它设为 false。

event_trigger

AudienceEventTrigger

可选。指定在用户加入受众群体时要记录的事件。如果您未设置此政策,当用户加入受众群体时,系统不会记录任何事件。

exclusion_duration_mode

AudienceExclusionDurationMode

不可变。指定针对符合排除过滤条件的用户,排除设置的时长。此过滤条件会应用于所有 EXCLUDE 过滤条件子句;当受众群体中没有 EXCLUDE 过滤条件子句时,系统会忽略此过滤条件。

filter_clauses[]

AudienceFilterClause

必需。不可变。无序列表。用于定义受众群体的过滤条件子句。所有子句将以 AND 关系结合在一起。

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(例如,不支持嵌套事件过滤器)。此值应该是一个“and_group”的“dimension_or_metric_filter”或“not_expression”,不支持“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 消息中的 parent 字段必须为空或与此字段匹配。格式:- 账号/{账号} - 媒体资源/{媒体资源}

requests[]

CreateAccessBindingRequest

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

BatchCreateAccessBindingsResponse

BatchCreateAccessBindings RPC 的响应消息。

字段
access_bindings[]

AccessBinding

已创建的访问权限绑定。

BatchDeleteAccessBindingsRequest

BatchDeleteAccessBinding RPC 的请求消息。

字段
parent

string

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

requests[]

DeleteAccessBindingRequest

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

BatchGetAccessBindingsRequest

BatchGetAccessBindings RPC 的请求消息。

字段
parent

string

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

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 的父项必须与此字段匹配。格式:- 账号/{账号} - 媒体资源/{媒体资源}

requests[]

UpdateAccessBindingRequest

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

BatchUpdateAccessBindingsResponse

BatchUpdateAccessBinding 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 引用此计算指标时,使用 compute_metric_id。例如,“calcMetric:{calculated_metric_id}”。

metric_unit

MetricUnit

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

restricted_metric_type[]

RestrictedMetricType

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

formula

string

必需。计算指标的定义。引用的唯一自定义指标的数量上限为 5。公式支持以下运算:+(加法)、-(减)、-(负)、*(乘号)、/(除号)、()(圆括号)。任何适合长整型(64 位整数)或双精度型(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

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

channel_group

ChannelGroup

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

enhanced_measurement_settings

EnhancedMeasurementSettings

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

data_redaction_settings

DataRedactionSettings

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

skadnetwork_conversion_value_schema

SKAdNetworkConversionValueSchema

更改历史记录中 SKAdNetworkConversionValueSchema 资源的概况。

audience

Audience

更改历史记录中受众群体资源的概况。

event_create_rule

EventCreateRule

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

calculated_metric

CalculatedMetric

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

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 Data 保留 Settings 资源
DATA_STREAM DataStream 资源
ATTRIBUTION_SETTINGS AttributionSettings 资源
EXPANDED_DATA_SET ExtendedDataSet 资源
CHANNEL_GROUP ChannelGroup 资源
ENHANCED_MEASUREMENT_SETTINGS EnhancedMeasurementSettings 资源
DATA_REDACTION_SETTINGS DataRedactionSettings 资源
SKADNETWORK_CONVERSION_VALUE_SCHEMA SKAdNetworkConversionValueSchema 资源
AUDIENCE 受众群体资源
EVENT_CREATE_RULE EventCreateRule 资源
CALCULATED_METRIC CalculatedMetric 资源

ChannelGroup

表示渠道组的资源消息。

字段
name

string

仅限输出。此渠道组资源的资源名称。格式:property/{property}/channelGroups/{channel_group}

display_name

string

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

description

string

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

grouping_rule[]

GroupingRule

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

system_defined

bool

仅限输出。如果为 true,则此渠道组是由 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 表示粗略的高值。

ConnectedSiteTag

特定已关联的网站代码的配置。

字段
display_name

string

必需。用户为已关联的网站代码提供的显示名称。必须少于 256 个字符。

tag_id

string

必需。“要向其转发事件的代码 ID。也称为衡量 ID 或“G-ID”(例如 G-12345)。

ConversionEvent

Google Analytics(分析)媒体资源中的转化事件。

字段
name

string

仅限输出。此转化事件的资源名称。格式:媒体资源/{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

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

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

必需。格式:- 账号/{账号} - 媒体资源/{媒体资源}

access_binding

AccessBinding

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

CreateAdSenseLinkRequest

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

字段
parent

string

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

CreateAudienceRequest

CreateAudience RPC 的请求消息。

字段
parent

string

必需。示例格式:properties/1234

audience

Audience

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

CreateCalculatedMetricRequest

CreateCalculatedMetric RPC 的请求消息。

字段
parent

string

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

calculated_metric_id

string

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

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

calculated_metric

CalculatedMetric

必需。要创建的 CalculatedMetric。

CreateChannelGroupRequest

CreateChannelGroup RPC 的请求消息。

字段
parent

string

必需。要为其创建 ChannelGroup 的属性。示例格式:properties/1234

channel_group

ChannelGroup

必需。要创建的 ChannelGroup。

CreateConnectedSiteTagRequest

CreateConnectedSiteTag RPC 的请求消息。

字段
property

string

要为其创建已关联的网站代码的 Universal Analytics 媒体资源。此 API 不支持 GA4 媒体资源。格式:properties/{universalAnalyticsPropertyId} 示例:properties/1234

connected_site_tag

ConnectedSiteTag

必需。要添加到 Universal Analytics 媒体资源的代码

CreateConnectedSiteTagResponse

此类型没有任何字段。

CreateConnectedSiteTag RPC 的响应消息。

CreateConversionEventRequest

CreateConversionEvent RPC 的请求消息

字段
conversion_event

ConversionEvent

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

parent

string

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

CreateCustomDimensionRequest

CreateCustomDimension RPC 的请求消息。

字段
parent

string

必需。示例格式:properties/1234

custom_dimension

CustomDimension

必需。要创建的自定义维度。

CreateCustomMetricRequest

CreateCustomMetric RPC 的请求消息。

字段
parent

string

必需。示例格式:properties/1234

custom_metric

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。

CreateExpandedDataSetRequest

CreateExpandDataSet RPC 的请求消息。

字段
parent

string

必需。示例格式:properties/1234

expanded_data_set

ExpandedDataSet

必需。要创建的 ExtendedDataSet。

CreateFirebaseLinkRequest

CreateFirebaseLink RPC 的请求消息

字段
parent

string

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

CreateGoogleAdsLinkRequest

CreateGoogleAdsLink RPC 的请求消息

字段
parent

string

必需。示例格式:properties/1234

CreateMeasurementProtocolSecretRequest

CreateMeasurementProtocolSecret RPC 的请求消息

字段
parent

string

必需。将在其中创建此 Secret 的父资源。格式:properties/{property}/dataStreams/{dataStream}

measurement_protocol_secret

MeasurementProtocolSecret

必需。要创建的 Measurement Protocol 密钥。

CreatePropertyRequest

CreateProperty RPC 的请求消息。

字段
property

Property

必需。要创建的属性。注意:提供的属性必须指定其父属性。

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

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

CreateSubpropertyRequest

CreateSubproperty RPC 的请求消息。

字段
parent

string

必需。要为其创建子媒体资源的普通媒体资源。格式:properties/property_id 示例:properties/123

subproperty

Property

必需。要创建的子媒体资源。

subproperty_event_filter

SubpropertyEventFilter

可选。要在普通媒体资源中创建的子媒体资源事件过滤器。

CreateSubpropertyResponse

CreateSubproperty RPC 的响应消息。

字段
subproperty

Property

已创建的子媒体资源。

subproperty_event_filter

SubpropertyEventFilter

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

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

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

字段
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

仅限输出。此 Data 保留 Setting 资源的资源名称。格式:properties/{property}/data 保留 Settings

event_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 支持团队访问数据,以帮助排查问题。

sharing_with_google_assigned_sales_enabled

bool

允许分配给客户的 Google 销售团队访问数据,以提出配置更改建议以改善成效。销售团队限制在启用后仍然适用。

sharing_with_google_any_sales_enabled

bool

允许所有 Google 销售人员访问数据,以便提供配置更改建议以改善成效。

sharing_with_google_products_enabled

bool

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

sharing_with_others_enabled

bool

允许 Google 以匿名方式与他人共享数据。

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

仅限输出。Firebase 中对应的 Android 应用的 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

仅限输出。Firebase 中对应的 iOS 应用的 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

仅限输出。Firebase 中对应的 Web 应用的 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

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

DeleteConnectedSiteTagRequest

DeleteConnectedSiteTag RPC 的请求消息。

字段
property

string

要为其删除已关联的网站代码的 Universal Analytics 媒体资源。此 API 不支持 GA4 媒体资源。格式:properties/{universalAnalyticsPropertyId} 示例:properties/1234

tag_id

string

向其转发事件的代码 ID。也称为衡量 ID 或“G-ID”(例如 G-12345)。

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

DeleteExpandedDataSetRequest

DeleteExtendedDataSet 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

DeleteMeasurementProtocolSecretRequest

DeleteMeasurementProtocolSecret RPC 的请求消息

字段
name

string

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

DeletePropertyRequest

DeleteProperty RPC 的请求消息。

字段
name

string

必需。要软删除的属性名称。格式:properties/{property_id} 示例:“properties/1000”

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

一项关于将 GA4 媒体资源与 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 360 广告客户的显示名称。系统只会针对源自 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

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

字段
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 项更改。

EventMapping

与事件匹配的事件设置条件。

字段
event_name

string

必需。GA4 事件的名称。必须始终设置此字段。显示名称的长度上限为 40 个 UTF-16 代码单元。

min_event_count

int64

必须至少设置以下四个最小值/最大值中的一个。所设置的值将以 AND 关系结合在一起,以确定事件。事件发生的最小次数。如果未设置,则不会检查事件数下限。

max_event_count

int64

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

min_event_value

double

由该事件产生的最低收入。收入币种将在媒体资源一级指定。如果未设置,则不会检查最小事件价值。

max_event_value

double

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

ExpandedDataSet

表示 GA4 ExtendedDataSet 的资源消息。

字段
name

string

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

display_name

string

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

description

string

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

dimension_names[]

string

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

metric_names[]

string

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

dimension_filter_expression

ExpandedDataSetFilterExpression

不可变。ExtendedDataSet 过滤器的逻辑表达式,该过滤器应用于 ExpandDataSet 中包含的维度。此过滤条件用于减少行数,从而减少遇到 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 连接在一起的表达式列表。它必须包含带有“not_expression”或“dimension_filter”的 ExpandDataSetFilterExpression。必须为顶级 ExtendedDataSetFilterExpression 设置此值。

not_expression

ExpandedDataSetFilterExpression

要进行 NOT 运算(即反转、补码)的过滤表达式。该参数必须包含维度过滤条件。无法在顶级 ExtendedDataSetFilterExpression 上设置此值。

filter

ExpandedDataSetFilter

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

ExpandedDataSetFilterExpressionList

ExtendedDataSet 过滤表达式列表。

字段
filter_expressions[]

ExpandedDataSetFilterExpression

ExtendedDataSet 过滤表达式列表。

FetchAutomatedGa4ConfigurationOptOutRequest

请求获取 GA4 自动设置流程的停用状态。

字段
property

string

必需。用于获取停用状态的 UA 媒体资源。请注意,此请求使用的是内部媒体资源 ID,而不是 UA-XXXXXX-YY 形式的跟踪 ID。格式:properties/{internalWebPropertyId} 示例:properties/1234

FetchAutomatedGa4ConfigurationOptOutResponse

获取自动 GA4 设置流程的停用状态的响应消息。

字段
opt_out

bool

UA 媒体资源的停用状态。

FetchConnectedGa4PropertyRequest

请求查找与 UA 媒体资源相关联的 GA4 媒体资源。

字段
property

string

必需。要为其查找已关联的 GA4 媒体资源的 UA 媒体资源。请注意,此请求使用的是内部媒体资源 ID,而不是 UA-XXXXXX-YY 形式的跟踪 ID。格式:properties/{internal_web_property_id} 示例:properties/1234

FetchConnectedGa4PropertyResponse

针对查找与 UA 媒体资源相关联的 GA4 媒体资源的响应。

字段
property

string

与 UA 媒体资源相关联的 GA4 媒体资源。没有关联的 GA4 媒体资源时,系统会返回一个空字符串。格式:properties/{property_id} 示例:properties/1234

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

必需。要获取的自定义维度的名称。示例格式:properties/1234/customDimensions/5678

GetCustomMetricRequest

GetCustomMetric RPC 的请求消息。

字段
name

string

必需。要获取的自定义指标的名称。示例格式:properties/1234/customMetrics/5678

GetDataRedactionSettingsRequest

GetDataRedactionSettings RPC 的请求消息。

字段
name

string

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

GetDataRetentionSettingsRequest

GetData 保留 Settings RPC 的请求消息。

字段
name

string

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

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

GetEnhanceMeasurementSettings 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

GetExpandedDataSetRequest

GetExtendedDataSet RPC 的请求消息。

字段
name

string

必需。要获取的 ExtendedDataSet 的名称。示例格式: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

GetMeasurementProtocolSecretRequest

GetMeasurementProtocolSecret RPC 的请求消息。

字段
name

string

必需。要查找的 Measurement Protocol Secret 的名称。格式:properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

GetPropertyRequest

GetProperty RPC 的请求消息。

字段
name

string

必需。要查找的属性的名称。格式:properties/{property_id} 示例:“properties/1000”

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

GlobalSiteTag

只读资源,具有用于将数据从网站发送到 DataStream 的标记。仅适用于网站 DataStream 资源。

字段
name

string

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

snippet

string

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

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 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 Shopping

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

必需。格式:- 账号/{账号} - 媒体资源/{媒体资源}

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

必需。要列出其 ChannelGroup 的属性。示例格式: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 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListConnectedSiteTagsRequest

ListConnectedSiteTags RPC 的请求消息。

字段
property

string

要为其提取已关联的网站代码的 Universal Analytics 媒体资源。这不适用于 GA4 媒体资源。系统最多会返回 20 个已关联的网站代码。示例格式:properties/1234

ListConnectedSiteTagsResponse

ListConnectedSiteTags RPC 的响应消息。

字段
connected_site_tags[]

ConnectedSiteTag

Universal Analytics 媒体资源的网站代码。系统最多会返回 20 个已关联的网站代码。

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

EventCreateRules 的列表。这些对象会按任意顺序进行稳定排序。

next_page_token

string

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

ListExpandedDataSetsRequest

ListExpandDataSets RPC 的请求消息。

字段
parent

string

必需。示例格式:properties/1234

page_size

int32

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

page_token

string

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

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

ListExpandedDataSetsResponse

ListExpandDataSets RPC 的响应消息。

字段
expanded_data_sets[]

ExpandedDataSet

ExtendedDataSet 的列表。这些对象会按任意顺序进行稳定排序。

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 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

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

请求中指定的父流的 Secret 列表。

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 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

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

SKAdNetworkConversionValueSchemas 的列表。最多只有一个值。

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。目前,Google Analytics(分析)仅支持每个数据流使用一个 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 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

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 的资源名称。此密钥可以是任何类型的数据流的子级。格式:properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

display_name

string

必需。此 Secret 的直观易懂的显示名称。

secret_value

string

仅限输出。Measurement Protocol Secret 值。在向此密钥的父级属性发送命中时,将此值传递给 Measurement Protocol API 的 api_secret 字段。

NumericValue

用于表示数字。

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

int64

整数值

double_value

double

DoubleValue

ParameterMutation

定义要 mutate 的事件参数。

字段
parameter

string

必需。要更改的参数的名称。此值必须:* 少于 40 个字符。* 在规则内的所有变更中必须唯一

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(分析)GA4 媒体资源的资源消息。

字段
name

string

仅限输出。此属性的资源名称。格式:properties/{property_id} 示例:“properties/1000”

property_type

PropertyType

不可变。此 Property 资源的属性类型。创建媒体资源时,如果类型为“PROPERTY_TYPE_UNSPECIFIED”,则系统会隐含“ORDINARY_PROPERTY”。

create_time

Timestamp

仅限输出。最初创建实体的时间。

update_time

Timestamp

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

parent

string

不可变。此属性的逻辑父项的资源名称。

注意:Property-Moving 界面可用于更改父项。格式:accounts/{account}、媒体资源/{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

表示 GA4 媒体资源元数据的虚拟资源。

字段
property

string

此属性摘要所引用属性的资源名称,格式:properties/{property_id} 示例:“properties/1000”

display_name

string

此资源摘要中引用的资源的显示名称。

property_type

PropertyType

媒体资源的属性类型。

parent

string

此属性的逻辑父项的资源名称。

注意:Property-Moving 界面可用于更改父项。格式:accounts/{account}、媒体资源/{property} 示例:“accounts/100”“properties/200”

PropertyType

属性资源的类型。

枚举
PROPERTY_TYPE_UNSPECIFIED 属性类型未知或未指定
PROPERTY_TYPE_ORDINARY 普通 GA4 媒体资源
PROPERTY_TYPE_SUBPROPERTY GA4 子媒体资源
PROPERTY_TYPE_ROLLUP GA4 总览媒体资源

ProvisionAccountTicketRequest

ProvisionAccountTicket RPC 的请求消息。

字段
account

Account

要创建的帐号。

redirect_uri

string

用户接受服务条款后会转到的重定向 URI。必须在 Cloud 控制台中配置为重定向 URI。

ProvisionAccountTicketResponse

ProvisioningAccountTicket RPC 的响应消息。

字段
account_ticket_id

string

要在服务条款链接中传递的参数。

RunAccessReportRequest

数据访问记录报告请求。

字段
entity

string

数据访问报告支持在媒体资源一级或帐号一级提出请求。如果在帐号一级提出请求,数据访问报告将包含该帐号下所有媒体资源的所有访问权限。

若要在媒体资源一级发出请求,如果您的 GA4 媒体资源 ID 为“123”,则实体类型应为“properties/123”。若要在账号一级请求,实体应为“accounts/1234”(如果您的 GA4 账号 ID 为“1234”)。

dimensions[]

AccessDimension

请求并在响应中显示的维度。请求最多包含 9 个维度。

metrics[]

AccessMetric

请求并显示于响应中的指标。最多允许请求 10 个指标。

date_ranges[]

AccessDateRange

要读取的访问记录的日期范围。如果请求了多个日期范围,则每个响应行都会包含一个从零开始的日期范围索引。如果两个日期范围重叠,则重叠日期的访问记录会同时包含在两个日期范围的响应行中。最多允许请求 2 个日期范围。

dimension_filter

AccessFilterExpression

利用维度过滤条件,您可以将报告响应限制为与该过滤条件匹配的特定维度值。例如,过滤单个用户的访问记录。要了解详情,请参阅维度过滤条件基础知识中的相关示例。此过滤条件中不能使用指标。

metric_filter

AccessFilterExpression

利用指标过滤条件,您可以将报告响应限制为与该过滤条件相匹配的特定指标值。指标过滤条件在聚合报告的行之后应用,类似于 SQL 的 using-clause 子句。维度不能在此过滤条件中使用。

offset

int64

起始行的行数。第一行计为第 0 行。如果未指定 offset,系统会将其视为 0。如果 offset 为零,则此方法将返回第一页包含 limit 条目的结果。

如需详细了解此分页参数,请参阅分页

limit

int64

要返回的行数。如果未指定,将返回 10,000 行。无论您请求的数量是多少,每个请求最多返回 100,000 行。“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

报告中与特定维度对应的列的标题。DimensionHeader 的数量和 DimensionHeader 的顺序与行中显示的维度一致。

metric_headers[]

AccessMetricHeader

报告中与特定指标相对应的列的标题。MetricHeader 的数量和 MetricHeader 的顺序与行中显示的指标一致。

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

启用后,Google Analytics(分析)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

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(分析)的付费版。

SetAutomatedGa4ConfigurationOptOutRequest

请求为 GA4 自动设置流程设置停用状态。

字段
property

string

必需。用于设置停用状态的 UA 媒体资源。请注意,此请求使用的是内部媒体资源 ID,而不是 UA-XXXXXX-YY 形式的跟踪 ID。格式:properties/{internalWebPropertyId} 示例:properties/1234

opt_out

bool

要设置的状态。

SetAutomatedGa4ConfigurationOptOutResponse

此类型没有任何字段。

关于为 GA4 自动设置流程设置停用状态的响应消息。

SubpropertyEventFilter

表示 GA4 子媒体资源事件过滤器的资源消息。

字段
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

必需。无序列表。子媒体资源事件过滤表达式列表

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”)。系统不会更新省略的字段。如需替换整个实体,请使用包含字符串“*”的一个路径以匹配所有字段。

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

要更新的自定义维度

update_mask

FieldMask

必需。要更新的字段列表。系统不会更新省略的字段。如需替换整个实体,请使用包含字符串“*”的一个路径以匹配所有字段。

UpdateCustomMetricRequest

UpdateCustomMetric RPC 的请求消息。

字段
custom_metric

CustomMetric

要更新的自定义指标

update_mask

FieldMask

必需。要更新的字段列表。系统不会更新省略的字段。如需替换整个实体,请使用包含字符串“*”的一个路径以匹配所有字段。

UpdateDataRedactionSettingsRequest

UpdateDataRedactionSettings RPC 的请求消息。

字段
data_redaction_settings

DataRedactionSettings

必需。要更新的设置。name 字段用于标识要更新的设置。

update_mask

FieldMask

必需。要更新的字段列表。字段名称必须采用蛇形命名法(例如,“field_to_update”)。系统不会更新省略的字段。如需替换整个实体,请使用包含字符串“*”的一个路径以匹配所有字段。

UpdateDataRetentionSettingsRequest

UpdateData 保留 Settings 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

UpdateEnhanceMeasurementSettings 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”)。系统不会更新省略的字段。如需替换整个实体,请使用包含字符串“*”的一个路径以匹配所有字段。

UpdateExpandedDataSetRequest

UpdateExtendedDataSet RPC 的请求消息。

字段
expanded_data_set

ExpandedDataSet

必需。要更新的 ExtendedDataSet。资源的 name 字段用于标识要更新的 ExtendedDataSet。

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”)。系统不会更新省略的字段。如需替换整个实体,请使用包含字符串“*”的一个路径以匹配所有字段。

UpdateMeasurementProtocolSecretRequest

UpdateMeasurementProtocolSecret RPC 的请求消息

字段
measurement_protocol_secret

MeasurementProtocolSecret

必需。要更新的 Measurement Protocol 密钥。

update_mask

FieldMask

必需。要更新的字段列表。系统不会更新省略的字段。

UpdatePropertyRequest

UpdateProperty RPC 的请求消息。

字段
property

Property

必需。要更新的属性。属性的 name 字段用于标识要更新的属性。

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”)。系统不会更新省略的字段。如需替换整个实体,请使用包含字符串“*”的一个路径以匹配所有字段。