Package google.analytics.admin.v1beta

索引

AnalyticsAdminService

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

AcknowledgeUserDataCollection

rpc AcknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest) returns (AcknowledgeUserDataCollectionResponse)

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

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

授权范围

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

rpc CreateKeyEvent(CreateKeyEventRequest) returns (KeyEvent)

创建关键事件。

授权范围

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

rpc DeleteKeyEvent(DeleteKeyEventRequest) returns (Empty)

删除关键事件。

授权范围

需要以下 OAuth 作用域:

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

rpc DeleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest) returns (Empty)

删除目标 MeasurementProtocolSecret。

授权范围

需要以下 OAuth 作用域:

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

rpc DeleteProperty(DeletePropertyRequest) returns (Property)

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

此 API 没有恢复软删除属性的方法。但是,您可以通过回收站界面还原这些内容。

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

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

授权范围

需要以下 OAuth 作用域:

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

rpc GetAccount(GetAccountRequest) returns (Account)

查找单个帐号。

授权范围

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

rpc GetKeyEvent(GetKeyEventRequest) returns (KeyEvent)

检索单个键事件。

授权范围

需要以下 OAuth 范围之一:

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

rpc GetMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret)

查找单个“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
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
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
ListKeyEvents

rpc ListKeyEvents(ListKeyEventsRequest) returns (ListKeyEventsResponse)

返回指定父属性中的关键事件列表。如果未找到键事件,则返回空列表。

授权范围

需要以下 OAuth 范围之一:

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

rpc ListMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest) returns (ListMeasurementProtocolSecretsResponse)

返回指定父级属性下的子 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
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
UpdateAccount

rpc UpdateAccount(UpdateAccountRequest) returns (Account)

更新帐号。

授权范围

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

rpc UpdateKeyEvent(UpdateKeyEventRequest) returns (KeyEvent)

更新关键事件。

授权范围

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

AccessBetweenFilter

表示结果需要介于两个数字(含)之间。

字段
from_value

NumericValue

以此数字开头。

to_value

NumericValue

以此数字结尾。

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

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

gmp_organization

string

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

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(分析)支持团队员工所做的更改。

ArchiveCustomDimensionRequest

ArchiveCustomDimension RPC 的请求消息。

字段
name

string

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

ArchiveCustomMetricRequest

ArchiveCustomMetric RPC 的请求消息。

字段
name

string

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

ChangeHistoryChange

对单个 Google Analytics(分析)资源所做更改的说明。

字段
resource

string

此条目描述其更改的资源的资源名称。

action

ActionType

更改此资源的操作类型。

resource_before_change

ChangeHistoryResource

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

resource_after_change

ChangeHistoryResource

进行更改之后的资源内容。如果此资源在此变更中删除,则此字段将缺失。

ChangeHistoryResource

在更改历史记录中发生变更之前或之后的资源快照。

字段

联合字段 resource

resource 只能是下列其中一项:

account

Account

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

property

Property

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

conversion_event

ConversionEvent

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

measurement_protocol_secret

MeasurementProtocolSecret

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

data_retention_settings

DataRetentionSettings

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

data_stream

DataStream

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

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 资源
DATA_RETENTION_SETTINGS Data 保留 Settings 资源
DATA_STREAM DataStream 资源
ATTRIBUTION_SETTINGS AttributionSettings 资源

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

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。

CreateFirebaseLinkRequest

CreateFirebaseLink RPC 的请求消息

字段
parent

string

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

CreateGoogleAdsLinkRequest

CreateGoogleAdsLink RPC 的请求消息

字段
parent

string

必需。示例格式:properties/1234

CreateKeyEventRequest

CreateKeyEvent RPC 的请求消息

字段
key_event

KeyEvent

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

parent

string

必需。将在其中创建此关键事件的父属性的资源名称。格式:properties/123

CreateMeasurementProtocolSecretRequest

CreateMeasurementProtocolSecret RPC 的请求消息

字段
parent

string

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

measurement_protocol_secret

MeasurementProtocolSecret

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

CreatePropertyRequest

CreateProperty RPC 的请求消息。

字段
property

Property

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

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 指标报告收入数据。

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”

DeleteAccountRequest

DeleteAccount RPC 的请求消息。

字段
name

string

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

DeleteConversionEventRequest

DeleteConversionEvent RPC 的请求消息

字段
name

string

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

DeleteDataStreamRequest

DeleteDataStream RPC 的请求消息。

字段
name

string

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

DeleteFirebaseLinkRequest

DeleteFirebaseLink RPC 的请求消息

字段
name

string

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

DeleteGoogleAdsLinkRequest

DeleteGoogleAdsLink RPC 的请求消息。

字段
name

string

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

DeleteKeyEventRequest

DeleteKeyEvent RPC 的请求消息

字段
name

string

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

DeleteMeasurementProtocolSecretRequest

DeleteMeasurementProtocolSecret RPC 的请求消息

字段
name

string

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

DeletePropertyRequest

DeleteProperty RPC 的请求消息。

字段
name

string

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

GetAccountRequest

GetAccount RPC 的请求消息。

字段
name

string

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

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

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

GetKeyEventRequest

GetKeyEvent RPC 的请求消息

字段
name

string

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

GetMeasurementProtocolSecretRequest

GetMeasurementProtocolSecret RPC 的请求消息。

字段
name

string

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

GetPropertyRequest

GetProperty RPC 的请求消息。

字段
name

string

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

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

KeyEvent

Google Analytics(分析)媒体资源中的关键事件。

字段
name

string

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

event_name

string

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

create_time

Timestamp

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

deletable

bool

仅限输出。如果设置为 true,则可以删除此事件。

custom

bool

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

counting_method

CountingMethod

必需。针对一个会话内的多个事件统计关键事件的方法。

default_value

DefaultValue

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

CountingMethod

针对一个会话内的多个事件统计关键事件的方法。

枚举
COUNTING_METHOD_UNSPECIFIED 未指定统计方法。
ONCE_PER_EVENT 每个 Event 实例都被视为一个关键事件。
ONCE_PER_SESSION 对于每个用户的每次会话,一个事件实例最多会被视为一次关键事件。

DefaultValue

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

字段
numeric_value

double

必需。这将用于为未设置“value”参数的关键事件(由 event_name 指定)的所有出现填充“value”参数。

currency_code

string

必需。当此关键事件(由 event_name 指定)的发生时未设置币种时,此币种将作为默认币种。必须采用 ISO 4217 货币代码格式。

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

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

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

ListFirebaseLinksRequest

ListFirebaseLinks RPC 的请求消息

字段
parent

string

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

page_size

int32

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

page_token

string

从之前的 ListFirebaseLinks 调用接收的页面令牌。提供此令牌以检索后续页面。进行分页时,提供给 ListFirebaseLinks 的所有其他参数必须与提供页面令牌的调用匹配。

ListFirebaseLinksResponse

ListFirebaseLinks RPC 的响应消息

字段
next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。目前,Google Analytics(分析)仅支持每个媒体资源有一个 FirebaseLink,因此永远不会填充此字段。

ListGoogleAdsLinksRequest

ListGoogleAdsLinks RPC 的请求消息。

字段
parent

string

必需。示例格式:properties/1234

page_size

int32

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

page_token

string

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

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

ListGoogleAdsLinksResponse

ListGoogleAdsLinks RPC 的响应消息。

字段
next_page_token

string

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

ListKeyEventsRequest

ListKeyEvents RPC 的请求消息

字段
parent

string

必需。父属性的资源名称。示例:“properties/123”

page_size

int32

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

page_token

string

从之前的 ListKeyEvents 调用接收的页面令牌。提供此令牌以检索后续页面。进行分页时,提供给 ListKeyEvents 的所有其他参数必须与提供页面令牌的调用匹配。

ListKeyEventsResponse

ListKeyEvents RPC 的响应消息。

字段
key_events[]

KeyEvent

请求的关键事件

next_page_token

string

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

ListMeasurementProtocolSecretsRequest

ListMeasurementProtocolSecret RPC 的请求消息

字段
parent

string

必需。父流的资源名称。格式:properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets

page_size

int32

要返回的资源数量上限。如果未指定,则最多返回 10 项资源。最大值为 10。较高的值将被强制转换为最大值。

page_token

string

从之前的 ListMeasurementProtocolSecrets 调用接收的页面令牌。提供此令牌以检索后续页面。进行分页时,提供给 ListMeasurementProtocolSecrets 的所有其他参数必须与提供页面令牌的调用匹配。

ListMeasurementProtocolSecretsResponse

ListMeasurementProtocolSecret RPC 的响应消息

字段
measurement_protocol_secrets[]

MeasurementProtocolSecret

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

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

媒体资源

表示 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(分析)媒体资源(包括此请求)的配额状态。此字段不适用于帐号级请求。

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

UpdateAccountRequest

UpdateAccount RPC 的请求消息。

字段
account

Account

必需。要更新的账号。帐号的 name 字段用于标识帐号。

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

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

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

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

UpdateGoogleAdsLinkRequest

UpdateGoogleAdsLink RPC 的请求消息

字段
update_mask

FieldMask

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

UpdateKeyEventRequest

UpdateKeyEvent RPC 的请求消息

字段
key_event

KeyEvent

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

update_mask

FieldMask

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

UpdateMeasurementProtocolSecretRequest

UpdateMeasurementProtocolSecret RPC 的请求消息

字段
measurement_protocol_secret

MeasurementProtocolSecret

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

update_mask

FieldMask

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

UpdatePropertyRequest

UpdateProperty RPC 的请求消息。

字段
property

Property

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

update_mask

FieldMask

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