索引
AnalyticsAdminService(接口)AccessBetweenFilter(消息)AccessDateRange(消息)AccessDimension(消息)AccessDimensionHeader(消息)AccessDimensionValue(消息)AccessFilter(消息)AccessFilterExpression(消息)AccessFilterExpressionList(消息)AccessInListFilter(消息)AccessMetric(消息)AccessMetricHeader(消息)AccessMetricValue(消息)AccessNumericFilter(消息)AccessNumericFilter.Operation(枚举)AccessOrderBy(消息)AccessOrderBy.DimensionOrderBy(消息)AccessOrderBy.DimensionOrderBy.OrderType(枚举)AccessOrderBy.MetricOrderBy(消息)AccessQuota(消息)AccessQuotaStatus(消息)AccessRow(消息)AccessStringFilter(消息)AccessStringFilter.MatchType(枚举)Account(消息)AccountSummary(消息)AcknowledgeUserDataCollectionRequest(消息)AcknowledgeUserDataCollectionResponse(消息)ActionType(枚举)ActorType(枚举)ArchiveCustomDimensionRequest(消息)ArchiveCustomMetricRequest(消息)ChangeHistoryChange(消息)ChangeHistoryChange.ChangeHistoryResource(消息)ChangeHistoryEvent(消息)ChangeHistoryResourceType(枚举)ConversionEvent(消息)ConversionEvent.ConversionCountingMethod(枚举)ConversionEvent.DefaultConversionValue(消息)CreateConversionEventRequest(消息)CreateCustomDimensionRequest(消息)CreateCustomMetricRequest(消息)CreateDataStreamRequest(消息)CreateFirebaseLinkRequest(消息)CreateGoogleAdsLinkRequest(消息)CreateKeyEventRequest(消息)CreateMeasurementProtocolSecretRequest(消息)CreatePropertyRequest(消息)CustomDimension(消息)CustomDimension.DimensionScope(枚举)CustomMetric(消息)CustomMetric.MeasurementUnit(枚举)CustomMetric.MetricScope(枚举)CustomMetric.RestrictedMetricType(枚举)DataRetentionSettings(消息)DataRetentionSettings.RetentionDuration(枚举)DataSharingSettings(消息)DataStream(消息)DataStream.AndroidAppStreamData(消息)DataStream.DataStreamType(枚举)DataStream.IosAppStreamData(消息)DataStream.WebStreamData(消息)DeleteAccountRequest(消息)DeleteConversionEventRequest(消息)DeleteDataStreamRequest(消息)DeleteFirebaseLinkRequest(消息)DeleteGoogleAdsLinkRequest(消息)DeleteKeyEventRequest(消息)DeleteMeasurementProtocolSecretRequest(消息)DeletePropertyRequest(消息)FirebaseLink(消息)GetAccountRequest(消息)GetConversionEventRequest(消息)GetCustomDimensionRequest(消息)GetCustomMetricRequest(消息)GetDataRetentionSettingsRequest(消息)GetDataSharingSettingsRequest(消息)GetDataStreamRequest(消息)GetKeyEventRequest(消息)GetMeasurementProtocolSecretRequest(消息)GetPropertyRequest(消息)GoogleAdsLink(消息)IndustryCategory(枚举)KeyEvent(消息)KeyEvent.CountingMethod(枚举)KeyEvent.DefaultValue(消息)ListAccountSummariesRequest(消息)ListAccountSummariesResponse(消息)ListAccountsRequest(消息)ListAccountsResponse(消息)ListConversionEventsRequest(消息)ListConversionEventsResponse(消息)ListCustomDimensionsRequest(消息)ListCustomDimensionsResponse(消息)ListCustomMetricsRequest(消息)ListCustomMetricsResponse(消息)ListDataStreamsRequest(消息)ListDataStreamsResponse(消息)ListFirebaseLinksRequest(消息)ListFirebaseLinksResponse(消息)ListGoogleAdsLinksRequest(消息)ListGoogleAdsLinksResponse(消息)ListKeyEventsRequest(消息)ListKeyEventsResponse(消息)ListMeasurementProtocolSecretsRequest(消息)ListMeasurementProtocolSecretsResponse(消息)ListPropertiesRequest(消息)ListPropertiesResponse(消息)MeasurementProtocolSecret(消息)NumericValue(消息)Property(消息)PropertySummary(消息)PropertyType(枚举)ProvisionAccountTicketRequest(消息)ProvisionAccountTicketResponse(消息)RunAccessReportRequest(消息)RunAccessReportResponse(消息)SearchChangeHistoryEventsRequest(消息)SearchChangeHistoryEventsResponse(消息)ServiceLevel(枚举)UpdateAccountRequest(消息)UpdateConversionEventRequest(消息)UpdateCustomDimensionRequest(消息)UpdateCustomMetricRequest(消息)UpdateDataRetentionSettingsRequest(消息)UpdateDataStreamRequest(消息)UpdateGoogleAdsLinkRequest(消息)UpdateKeyEventRequest(消息)UpdateMeasurementProtocolSecretRequest(消息)UpdatePropertyRequest(消息)
AnalyticsAdminService
Google Analytics Admin API 的服务接口。
| AcknowledgeUserDataCollection |
|---|
|
确认指定媒体资源的用户数据收集条款。 必须先完成此确认(在 Google Analytics 界面中或通过此 API),然后才能创建 MeasurementProtocolSecret 资源。
|
| ArchiveCustomDimension |
|---|
|
归档媒体资源中的 CustomDimension。
|
| ArchiveCustomMetric |
|---|
|
归档媒体资源中的 CustomMetric。
|
| CreateConversionEvent |
|---|
|
已弃用:请改用
|
| CreateCustomDimension |
|---|
|
创建 CustomDimension。
|
| CreateCustomMetric |
|---|
|
创建 CustomMetric。
|
| CreateDataStream |
|---|
|
创建 DataStream。
|
| CreateFirebaseLink |
|---|
|
创建 FirebaseLink。 媒体资源最多只能有一个 FirebaseLink。
|
| CreateGoogleAdsLink |
|---|
|
创建 GoogleAdsLink。
|
| CreateKeyEvent |
|---|
|
创建关键事件。
|
| CreateMeasurementProtocolSecret |
|---|
|
创建 Measurement Protocol Secret。
|
| CreateProperty |
|---|
|
创建具有指定位置和属性的 Google Analytics 媒体资源。
|
| DeleteAccount |
|---|
|
将目标账号标记为已软删除(即“已放入回收站”),并返回该账号。 此 API 没有用于恢复软删除账号的方法。不过,您可以使用回收站界面恢复这些文件。 如果未在到期时间之前恢复这些账号,相应账号和所有子资源(例如媒体资源、GoogleAdsLinks、数据流、AccessBindings)将被永久清除。https://support.google.com/analytics/answer/6154772 如果找不到目标,则返回错误。
|
| DeleteConversionEvent |
|---|
|
已弃用:请改用
|
| DeleteDataStream |
|---|
|
删除媒体资源中的数据流。
|
| DeleteFirebaseLink |
|---|
|
删除媒体资源中的 FirebaseLink
|
| DeleteGoogleAdsLink |
|---|
|
删除媒体资源中的 GoogleAdsLink
|
| DeleteKeyEvent |
|---|
|
删除关键事件。
|
| DeleteMeasurementProtocolSecret |
|---|
|
删除目标 MeasurementProtocolSecret。
|
| DeleteProperty |
|---|
|
将目标媒体资源标记为软删除(即“已放入回收站”),然后返回该媒体资源。 此 API 没有用于恢复软删除的属性的方法。不过,您可以使用回收站界面恢复这些文件。 如果未在到期时间之前恢复媒体资源,该媒体资源和所有子资源(例如 GoogleAdsLinks、Streams、AccessBindings)将被永久清除。https://support.google.com/analytics/answer/6154772 如果找不到目标,则返回错误。
|
| GetAccount |
|---|
|
查找单个账号。
|
| GetConversionEvent |
|---|
|
已弃用:请改用
|
| GetCustomDimension |
|---|
|
查找单个 CustomDimension。
|
| GetCustomMetric |
|---|
|
查找单个 CustomMetric。
|
| GetDataRetentionSettings |
|---|
|
返回相应媒体资源的单例数据保留设置。
|
| GetDataSharingSettings |
|---|
|
获取账号的数据共享设置。数据共享设置是单例。
|
| GetDataStream |
|---|
|
查找单个 DataStream。
|
| GetKeyEvent |
|---|
|
检索单个关键事件。
|
| GetMeasurementProtocolSecret |
|---|
|
查找单个 MeasurementProtocolSecret。
|
| GetProperty |
|---|
|
查找单个 Google Analytics 媒体资源。
|
| ListAccountSummaries |
|---|
|
返回调用者可访问的所有账号的摘要。
|
| ListAccounts |
|---|
|
返回调用者可访问的所有账号。 请注意,这些账号目前可能没有 GA 媒体资源。默认情况下,系统会排除软删除(即“已放入回收站”)的账号。如果未找到任何相关账号,则返回空列表。
|
| ListConversionEvents |
|---|
|
已弃用:请改用 如果未找到任何转化事件,则返回空列表。
|
| ListCustomDimensions |
|---|
|
列出媒体资源中的 CustomDimension。
|
| ListCustomMetrics |
|---|
|
列出媒体资源中的 CustomMetrics。
|
| ListDataStreams |
|---|
|
列出媒体资源中的 DataStream。
|
| ListFirebaseLinks |
|---|
|
列出媒体资源中的 FirebaseLink。媒体资源最多只能有一个 FirebaseLink。
|
| ListGoogleAdsLinks |
|---|
|
列出媒体资源中的 GoogleAdsLink。
|
| ListKeyEvents |
|---|
|
返回指定父媒体资源中的关键事件列表。如果未找到任何关键事件,则返回空列表。
|
| ListMeasurementProtocolSecrets |
|---|
|
返回指定父级媒体资源下的子级 MeasurementProtocolSecrets。
|
| ListProperties |
|---|
|
返回指定父账号下的子媒体资源。 如果调用方没有访问权限,则会排除相应属性。默认情况下,系统会排除软删除(即“已放入回收站”)的媒体资源。如果未找到相关属性,则返回空列表。
|
| ProvisionAccountTicket |
|---|
|
请求创建账号的工单。
|
| RunAccessReport |
|---|
|
返回数据访问权限记录的自定义报告。此报告会记录用户每次读取 Google Analytics 报告数据的时间。访问记录最多可保留 2 年。 您可以为媒体资源请求数据访问报告。您可以为任何媒体资源请求报告,但与配额无关的维度只能在 Google Analytics 360 媒体资源中请求。此方法仅适用于管理员。 这些数据访问记录包括 Google Analytics 界面报告、Google Analytics 界面探索、Google Analytics Data API,以及可通过关联从 Google Analytics 检索数据的 Firebase 和 AdMob 等其他产品。这些记录不包括媒体资源配置更改,例如添加数据流或更改媒体资源的时区。如需了解配置更改历史记录,请参阅 searchChangeHistoryEvents。 如需对此 API 提供反馈,请填写 Google Analytics 访问报告反馈表单。
|
| SearchChangeHistoryEvents |
|---|
|
根据指定的过滤条件搜索账号或其子账号的所有更改。 仅返回 API 支持的更改子集。界面可能会返回其他更改。
|
| UpdateAccount |
|---|
|
更新账号。
|
| UpdateConversionEvent |
|---|
|
已弃用:请改用
|
| UpdateCustomDimension |
|---|
|
更新媒体资源中的 CustomDimension。
|
| UpdateCustomMetric |
|---|
|
更新媒体资源中的 CustomMetric。
|
| UpdateDataRetentionSettings |
|---|
|
更新相应媒体资源的单例数据保留设置。
|
| UpdateDataStream |
|---|
|
更新媒体资源中的 DataStream。
|
| UpdateGoogleAdsLink |
|---|
|
更新媒体资源中的 GoogleAdsLink
|
| UpdateKeyEvent |
|---|
|
更新关键事件。
|
| UpdateMeasurementProtocolSecret |
|---|
|
更新 Measurement Protocol 密钥。
|
| UpdateProperty |
|---|
|
更新媒体资源。
|
AccessBetweenFilter
表示结果必须介于两个数字之间(含这两个数字)。
| 字段 | |
|---|---|
from_value |
以该数字开头。 |
to_value |
以该数字结尾。 |
AccessDateRange
连续的日期范围:startDate、startDate + 1、...、endDate。
| 字段 | |
|---|---|
start_date |
查询的开始日期(含此日期),格式为 |
end_date |
查询的结束日期(含此日期),格式为 |
AccessDimension
“维度”是指数据的属性。例如,维度 userEmail 表示访问报告数据的用户的电子邮件地址。报告响应中的维度值是字符串。
| 字段 | |
|---|---|
dimension_name |
维度的 API 名称。如需查看此 API 支持的维度列表,请参阅数据访问架构。 维度在 |
AccessDimensionHeader
描述报告中的维度列。报告中请求的维度会在行和 DimensionHeaders 中生成列条目。不过,如果维度仅在过滤条件或表达式中使用,则不会在报告中生成列;相应地,这些维度也不会生成标题。
| 字段 | |
|---|---|
dimension_name |
维度的名称;例如“userEmail”。 |
AccessDimensionValue
维度值。
| 字段 | |
|---|---|
value |
维度值。例如,对于“国家/地区”维度,此值可能是“法国”。 |
AccessFilter
用于过滤维度或指标值的表达式。
| 字段 | |
|---|---|
field_name |
维度名称或指标名称。 |
联合字段 one_filter。为 Filter 指定一种过滤条件类型。one_filter 只能是下列其中一项: |
|
string_filter |
与字符串相关的过滤条件。 |
in_list_filter |
用于过滤列表中的值的过滤条件。 |
numeric_filter |
用于过滤数值或日期值的过滤条件。 |
between_filter |
用于过滤两个值的过滤条件。 |
AccessFilterExpression
表示维度或指标过滤条件。同一表达式中的字段必须全部为维度或全部为指标。
| 字段 | |
|---|---|
联合字段 one_expression。为 FilterExpression 指定一种过滤表达式。one_expression 只能是下列其中一项: |
|
and_group |
and_group 中的每个 FilterExpression 之间是 AND 关系。 |
or_group |
or_group 中的每个 FilterExpression 之间都是 OR 关系。 |
not_expression |
FilterExpression 不是 not_expression。 |
access_filter |
一种基本过滤条件。在同一 FilterExpression 中,过滤条件的所有字段名称必须全部为维度或全部为指标。 |
AccessFilterExpressionList
过滤条件表达式列表。
| 字段 | |
|---|---|
expressions[] |
过滤条件表达式列表。 |
AccessInListFilter
结果需要采用字符串值列表的形式。
| 字段 | |
|---|---|
values[] |
字符串值列表。不得为空。 |
case_sensitive |
如果为 true,则字符串值区分大小写。 |
AccessMetric
报告的量化衡量标准。例如,指标 accessCount 是指数据访问记录的总数。
| 字段 | |
|---|---|
metric_name |
相应指标的 API 名称。如需查看此 API 支持的指标列表,请参阅数据访问架构。 指标在 |
AccessMetricHeader
描述报告中的指标列。报告中请求的可见指标会在行和 MetricHeaders 中生成列条目。不过,如果指标仅在过滤条件或表达式中使用,则不会在报告中生成列;相应地,这些指标也不会生成标题。
| 字段 | |
|---|---|
metric_name |
指标的名称,例如“accessCount”。 |
AccessMetricValue
指标的值。
| 字段 | |
|---|---|
value |
衡量值。例如,此值可以是“13”。 |
AccessNumericFilter
用于过滤数值或日期值。
| 字段 | |
|---|---|
operation |
相应过滤条件的操作类型。 |
value |
数值或日期值。 |
操作
应用于数字过滤器的操作。
| 枚举 | |
|---|---|
OPERATION_UNSPECIFIED |
未指定。 |
EQUAL |
等于 |
LESS_THAN |
小于 |
LESS_THAN_OR_EQUAL |
小于或等于 |
GREATER_THAN |
大于 |
GREATER_THAN_OR_EQUAL |
大于或等于 |
AccessOrderBy
Order by 定义了响应中各行的排序方式。例如,按访问次数降序对行进行排序是一种排序方式,而按国家/地区字符串对行进行排序则是另一种排序方式。
| 字段 | |
|---|---|
desc |
如果为 true,则按降序排序。如果为 false 或未指定,则按升序排序。 |
联合字段 one_order_by。为 OrderBy 指定一种排序依据类型。one_order_by 只能是下列其中一项: |
|
metric |
按指标值对结果进行排序。 |
dimension |
按维度值对结果进行排序。 |
DimensionOrderBy
按维度值排序。
| 字段 | |
|---|---|
dimension_name |
请求中用于排序的维度名称。 |
order_type |
控制维度值排序的规则。 |
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 |
请求中用于排序的指标名称。 |
AccessQuota
相应 Google Analytics 媒体资源的所有配额的当前状态。如果某个属性的任何配额用尽,则对该属性的所有请求都会返回“资源耗尽”错误。
| 字段 | |
|---|---|
tokens_per_day |
每个媒体资源每天最多可以使用 25 万个令牌。大部分请求消耗的令牌数都少于 10 个。 |
tokens_per_hour |
属性每小时最多可以使用 5 万个令牌。一个 API 请求会消耗一定数量的令牌,该数量会从所有的小时配额、每日配额和每个项目的小时配额中扣除。 |
concurrent_requests |
媒体资源最多可使用 50 个并发请求。 |
server_errors_per_project_per_hour |
媒体资源和云项目对每小时最多可以有 50 个服务器错误。 |
tokens_per_project_per_hour |
媒体资源每小时每个项目最多可以使用 25% 的令牌。也就是说,Analytics 360 媒体资源每个项目每小时可以使用 12,500 个令牌。一个 API 请求会消耗一定数量的令牌,该数量会从所有的小时配额、每日配额和每个项目的小时配额中扣除。 |
AccessQuotaStatus
特定配额组的当前状态。
| 字段 | |
|---|---|
consumed |
相应请求消耗的配额。 |
remaining |
相应请求完成后的剩余配额。 |
AccessRow
访问每行报告数据。
| 字段 | |
|---|---|
dimension_values[] |
维度值列表。这些值的顺序与请求中指定的顺序相同。 |
metric_values[] |
指标值列表。这些值的顺序与请求中指定的顺序相同。 |
AccessStringFilter
字符串的过滤条件。
| 字段 | |
|---|---|
match_type |
相应过滤条件的匹配类型。 |
value |
用于匹配的字符串值。 |
case_sensitive |
如果为 true,则字符串值区分大小写。 |
MatchType
字符串过滤器的匹配类型。
| 枚举 | |
|---|---|
MATCH_TYPE_UNSPECIFIED |
未指定 |
EXACT |
字符串值完全匹配。 |
BEGINS_WITH |
以字符串值开头。 |
ENDS_WITH |
以字符串值结尾。 |
CONTAINS |
包含字符串值。 |
FULL_REGEXP |
正则表达式与字符串值完全匹配。 |
PARTIAL_REGEXP |
字符串值与正则表达式的部分匹配。 |
账号
表示 Google Analytics 账号的资源消息。
| 字段 | |
|---|---|
name |
标识符。相应账号的资源名称。格式:accounts/{account} 示例:“accounts/100” |
create_time |
仅限输出。相应账号的原始创建时间。 |
update_time |
仅限输出。账号载荷字段的上次更新时间。 |
display_name |
必需。相应账号的人类可读显示名称。 |
region_code |
商家所在的国家/地区。必须是 Unicode CLDR 区域代码。 |
deleted |
仅限输出。指示相应账号是否处于软删除状态。除非明确要求,否则已删除的账号不会包含在列表结果中。 |
gmp_organization |
仅限输出。Google Marketing Platform 组织资源的 URI。仅当此账号与 GMP 组织相关联时设置。格式:marketingplatformadmin.googleapis.com/organizations/{org_id} |
AccountSummary
一种虚拟资源,用于表示账号及其所有子级 Google Analytics 媒体资源的概览。
| 字段 | |
|---|---|
name |
标识符。相应账号摘要的资源名称。格式:accountSummaries/{account_id} 示例:“accountSummaries/1000” |
account |
相应账号的资源名称。格式:accounts/{account_id}。示例:“accounts/1000” |
display_name |
相应账号摘要中提及的账号的显示名称。 |
property_summaries[] |
相应账号的子账号的摘要列表。 |
AcknowledgeUserDataCollectionRequest
针对 AcknowledgeUserDataCollection RPC 的请求消息。
| 字段 | |
|---|---|
property |
必需。要确认用户数据收集的媒体资源。 |
acknowledgement |
必需。确认此方法的调用方了解用户数据收集条款。 此字段必须包含以下确切值:“我确认,我已进行了必要的隐私披露声明并获得了最终用户授权,可收集最终用户的数据并进行相关处理,包括将此类数据与 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 |
必需。要归档的 CustomDimension 的名称。示例格式:properties/1234/customDimensions/5678 |
ArchiveCustomMetricRequest
针对 ArchiveCustomMetric RPC 的请求消息。
| 字段 | |
|---|---|
name |
必需。要归档的 CustomMetric 的名称。示例格式:properties/1234/customMetrics/5678 |
ChangeHistoryChange
对单个 Google Analytics 资源所做更改的说明。
| 字段 | |
|---|---|
resource |
相应条目所描述的资源的资源名称。 |
action |
更改相应资源的操作类型。 |
resource_before_change |
更改前的资源内容。如果相应资源是在此更改中创建的,则此字段将缺失。 |
resource_after_change |
更改后的资源内容。如果相应资源在此更改中被删除,则此字段将缺失。 |
ChangeHistoryResource
资源在更改历史记录中的更改结果之前或之后的快照。
| 字段 | |
|---|---|
联合字段
|
|
account |
更改历史记录中“账号”资源的快照。 |
property |
更改历史记录中媒体资源资源的快照。 |
firebase_link |
更改历史记录中的 FirebaseLink 资源快照。 |
google_ads_link |
更改历史记录中 GoogleAdsLink 资源的快照。 |
conversion_event |
更改历史记录中 ConversionEvent 资源的快照。 |
measurement_protocol_secret |
更改历史记录中 MeasurementProtocolSecret 资源的快照。 |
data_retention_settings |
变更历史记录中的数据保留设置资源快照。 |
data_stream |
变更历史记录中 DataStream 资源的快照。 |
ChangeHistoryEvent
Google Analytics 账号或其子媒体资源中因同一原因而发生的一组变化。常见原因包括在 Google Analytics 界面中进行的更新、客户支持人员所做的更改,或 Google Analytics 系统自动进行的更改。
| 字段 | |
|---|---|
id |
相应更改历史记录事件的 ID。此 ID 在整个 Google Analytics 中是唯一的。 |
change_time |
做出更改的时间。 |
actor_type |
进行相应更改的行为者类型。 |
user_actor_email |
做出更改的 Google 账号的电子邮件地址。如果 actor 字段设置为 USER,则此字段将为有效的电子邮件地址;否则,此字段为空。已删除的 Google 账号会导致错误。 |
changes_filtered |
如果为 true,则表示返回的更改列表经过过滤,不代表相应事件中发生的所有更改。 |
changes[] |
相应更改历史记录事件中符合 SearchChangeHistoryEventsRequest 中指定过滤条件的更改列表。 |
ChangeHistoryResourceType
可从更改历史记录中返回其更改的资源类型。
| 枚举 | |
|---|---|
CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED |
资源类型未知或未指定。 |
ACCOUNT |
账号资源 |
PROPERTY |
媒体资源 |
FIREBASE_LINK |
FirebaseLink 资源 |
GOOGLE_ADS_LINK |
GoogleAdsLink 资源 |
GOOGLE_SIGNALS_SETTINGS |
GoogleSignalsSettings 资源 |
CONVERSION_EVENT |
ConversionEvent 资源 |
MEASUREMENT_PROTOCOL_SECRET |
MeasurementProtocolSecret 资源 |
CUSTOM_DIMENSION |
CustomDimension 资源 |
CUSTOM_METRIC |
CustomMetric 资源 |
DATA_RETENTION_SETTINGS |
DataRetentionSettings 资源 |
DISPLAY_VIDEO_360_ADVERTISER_LINK |
DisplayVideo360AdvertiserLink 资源 |
DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL |
DisplayVideo360AdvertiserLinkProposal 资源 |
DATA_STREAM |
DataStream 资源 |
ATTRIBUTION_SETTINGS |
AttributionSettings 资源 |
ConversionEvent
Google Analytics 媒体资源中的转化事件。
| 字段 | |
|---|---|
name |
标识符。相应转化事件的资源名称。格式:properties/{property}/conversionEvents/{conversion_event} |
event_name |
不可变。相应转化事件的事件名称。示例:'click'、'purchase' |
create_time |
仅限输出。相应转化事件在媒体资源中的创建时间。 |
deletable |
仅限输出。如果已设置,则目前可以使用 DeleteConversionEvent 删除此事件。 |
custom |
仅限输出。如果设置为 true,则表示相应转化事件是指自定义事件。如果设置为 false,则此转化事件是指 Google Analytics 中的默认事件。默认事件通常在 Google Analytics 中具有特殊含义。默认事件通常由 Google Analytics 系统为您创建,但在某些情况下,也可以由媒体资源管理员创建。自定义事件会纳入每个媒体资源可创建的自定义转化事件数量上限。 |
counting_method |
可选。在一次会话中,针对多个事件统计转化的方法。如果未提供此值,则会将其设置为 |
default_conversion_value |
可选。为转化事件定义默认价值/币种。 |
ConversionCountingMethod
在一次会话中,统计多次事件转化所用的方法。
| 枚举 | |
|---|---|
CONVERSION_COUNTING_METHOD_UNSPECIFIED |
未指定统计方法。 |
ONCE_PER_EVENT |
每个事件实例都被视为一次转化。 |
ONCE_PER_SESSION |
每个用户在每次会话中最多只能将一个事件实例视为一次转化。 |
DefaultConversionValue
为转化事件定义默认价值/币种。必须同时提供价值和币种。
| 字段 | |
|---|---|
value |
此值将用于填充指定 event_name 的所有转化(其中事件“value”参数未设置)的值。 |
currency_code |
如果此 event_name 的转化事件未设置币种,系统会将此币种应用为默认币种。必须采用 ISO 4217 货币代码格式。如需了解详情,请参阅 https://en.wikipedia.org/wiki/ISO_4217。 |
CreateConversionEventRequest
针对 CreateConversionEvent RPC 的请求消息
| 字段 | |
|---|---|
conversion_event |
必需。要创建的转化事件。 |
parent |
必需。将创建相应转化事件的父媒体资源的资源名称。格式:properties/123 |
CreateCustomDimensionRequest
针对 CreateCustomDimension RPC 的请求消息。
| 字段 | |
|---|---|
parent |
必需。示例格式:properties/1234 |
custom_dimension |
必需。要创建的 CustomDimension。 |
CreateCustomMetricRequest
针对 CreateCustomMetric RPC 的请求消息。
| 字段 | |
|---|---|
parent |
必需。示例格式:properties/1234 |
custom_metric |
必需。要创建的 CustomMetric。 |
CreateDataStreamRequest
针对 CreateDataStream RPC 的请求消息。
| 字段 | |
|---|---|
parent |
必需。示例格式:properties/1234 |
data_stream |
必需。要创建的 DataStream。 |
CreateFirebaseLinkRequest
针对 CreateFirebaseLink RPC 的请求消息
| 字段 | |
|---|---|
parent |
必需。格式:properties/{property_id} 示例: |
firebase_link |
必需。要创建的 Firebase 关联。 |
CreateGoogleAdsLinkRequest
CreateGoogleAdsLink RPC 的请求消息
| 字段 | |
|---|---|
parent |
必需。示例格式:properties/1234 |
google_ads_link |
必需。要创建的 GoogleAdsLink。 |
CreateKeyEventRequest
针对 CreateKeyEvent RPC 的请求消息
| 字段 | |
|---|---|
key_event |
必需。要创建的关键事件。 |
parent |
必需。将创建此关键事件的父级媒体资源的资源名称。格式:properties/123 |
CreateMeasurementProtocolSecretRequest
针对 CreateMeasurementProtocolSecret RPC 的请求消息
| 字段 | |
|---|---|
parent |
必需。将创建相应 Secret 的父级资源。格式:properties/{property}/dataStreams/{dataStream} |
measurement_protocol_secret |
必需。要创建的 Measurement Protocol 密钥。 |
CreatePropertyRequest
CreateProperty RPC 的请求消息。
| 字段 | |
|---|---|
property |
必需。要创建的媒体资源。注意:所提供的房源必须指定其父房源。 |
CustomDimension
CustomDimension 的定义。
| 字段 | |
|---|---|
name |
标识符。相应 CustomDimension 资源的资源名称。格式:properties/{property}/customDimensions/{customDimension} |
parameter_name |
必需。不可变。相应自定义维度的标记参数名称。 如果这是用户级范围的维度,则这是用户属性名称。如果这是事件级范围的维度,则这是事件参数名称。 如果这是商品级范围的维度,则这是在电子商务商品数组中找到的参数名称。 只能包含字母数字字符和下划线,且必须以字母开头。用户级范围的维度的长度上限为 24 个字符,事件级范围的维度的长度上限为 40 个字符。 |
display_name |
必需。相应自定义维度在 Google Analytics 界面中显示的名称。最长 82 个字符,字母数字字符加空格和下划线,以字母开头。旧版系统生成的显示名称可能包含方括号,但此字段的更新绝不允许包含方括号。 |
description |
可选。相应自定义维度的说明。长度上限为 150 个字符。 |
scope |
必需。不可变。相应维度的范围。 |
disallow_ads_personalization |
可选。如果设置为 true,则将此维度设置为 NPA,并将其从广告个性化中排除。 目前仅支持用户级范围的自定义维度。 |
DimensionScope
相应维度的有效范围值。
| 枚举 | |
|---|---|
DIMENSION_SCOPE_UNSPECIFIED |
范围未知或未指定。 |
EVENT |
限定于事件的维度。 |
USER |
用户级范围的维度。 |
ITEM |
以电子商务商品为范围的维度 |
CustomMetric
自定义指标的定义。
| 字段 | |
|---|---|
name |
标识符。相应 CustomMetric 资源的资源名称。格式:properties/{property}/customMetrics/{customMetric} |
parameter_name |
必需。不可变。相应自定义指标的标记名称。 如果这是事件级范围的指标,则这是事件参数名称。 只能包含字母数字字符和下划线,且必须以字母开头。事件级指标的长度上限为 40 个字符。 |
display_name |
必需。相应自定义指标在 Google Analytics 界面中显示的名称。最长 82 个字符,字母数字字符加空格和下划线,以字母开头。旧版系统生成的显示名称可能包含方括号,但此字段的更新绝不允许包含方括号。 |
description |
可选。相应自定义维度的说明。长度上限为 150 个字符。 |
measurement_unit |
必需。自定义指标的值类型。 |
scope |
必需。不可变。相应自定义指标的范围。 |
restricted_metric_type[] |
可选。相应指标可能包含的受限数据类型。对于具有 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 |
标识符。相应 DataRetentionSetting 资源的资源名称。格式:properties/{property}/dataRetentionSettings |
event_data_retention |
必需。事件级数据的保留时长。 |
user_data_retention |
必需。用户级数据的保留期限。 |
reset_user_data_on_new_activity |
如果为 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 |
标识符。资源名称。格式:accounts/{account}/dataSharingSettings 示例:“accounts/1000/dataSharingSettings” |
sharing_with_google_support_enabled |
允许 Google 技术支持服务代表在必要时访问您的 Google Analytics 数据和账号,以提供服务和寻找技术问题的解决办法。 此字段对应于 Google Analytics 管理界面中的“技术支持”字段。 |
sharing_with_google_assigned_sales_enabled |
允许 Google 访问您的 Google Analytics 账号数据,包括账号使用情况和配置数据、产品支出以及与您的 Google Analytics 账号关联的用户,以便 Google 帮助您充分利用各种 Google 产品,并为您提供有关 Google Analytics 和其他 Google 商业产品的数据洞见、优惠、建议和优化提示。 此字段会映射到 Google Analytics 管理界面中的“业务建议”字段。 |
sharing_with_google_any_sales_enabled |
已弃用。此字段不再使用,并且始终返回 false。 |
sharing_with_google_products_enabled |
允许 Google 使用这些数据来改进其他 Google 产品或服务。 此字段对应于 Google Analytics 管理界面中的“Google 产品和服务”字段。 |
sharing_with_others_enabled |
选择贡献汇总的衡量数据后,您即可启用预测、基于模型估算数据和基准比较等功能,获得更丰富的业务数据洞见。您共享的数据(包括数据共享来源媒体资源的有关信息)将会进行汇总和去标识化处理,然后才会用于生成业务数据洞见。 此字段对应于 Google Analytics 管理界面中的“根据模型估算贡献数据和业务数据洞见”字段。 |
DataStream
表示数据流的资源消息。
| 字段 | |
|---|---|
name |
标识符。相应数据流的资源名称。格式:properties/{property_id}/dataStreams/{stream_id} 示例:“properties/1000/dataStreams/2000” |
type |
必需。不可变。相应 DataStream 资源的类型。 |
display_name |
数据流的人类可读显示名称。 网站数据流的必需属性。 允许的显示名称长度上限为 255 个 UTF-16 代码单元。 |
create_time |
仅限输出。相应数据流最初创建的时间。 |
update_time |
仅限输出。数据流载荷字段的上次更新时间。 |
联合字段 stream_data。特定数据流类型的数据。将设置的消息与相应直播的类型相对应。stream_data 只能是下列其中一项: |
|
web_stream_data |
特定于网站数据流的数据。如果类型为 WEB_DATA_STREAM,则必须填充此字段。 |
android_app_stream_data |
特定于 Android 应用数据流的数据。如果类型为 ANDROID_APP_DATA_STREAM,则必须填充此字段。 |
ios_app_stream_data |
特定于 iOS 应用数据流的数据。如果类型为 IOS_APP_DATA_STREAM,则必须填充此字段。 |
AndroidAppStreamData
特定于 Android 应用数据流的数据。
| 字段 | |
|---|---|
firebase_app_id |
仅限输出。相应 Android 应用在 Firebase 中的 ID(如有)。如果 Android 应用被删除并重新创建,此 ID 可能会发生变化。 |
package_name |
不可变。正在衡量的应用的软件包名称。示例:“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 |
仅限输出。相应 iOS 应用在 Firebase 中的 ID(如有)。如果 iOS 应用被删除并重新创建,此 ID 可能会发生变化。 |
bundle_id |
必需。不可变。应用的 Apple App Store 软件包 ID。示例:“com.example.myiosapp” |
WebStreamData
特定于网站数据流的数据。
| 字段 | |
|---|---|
measurement_id |
仅限输出。Google Analytics 衡量 ID。 示例:“G-1A2BCD345E” |
firebase_app_id |
仅限输出。相应 Web 应用在 Firebase 中的 ID(如有)。如果删除并重新创建 Web 应用,此 ID 可能会发生变化。 |
default_uri |
所衡量 Web 应用的域名,或为空。示例:“http://www.google.com”“https://www.google.com” |
DeleteAccountRequest
针对 DeleteAccount RPC 的请求消息。
| 字段 | |
|---|---|
name |
必需。要软删除的账号的名称。格式:accounts/{account} 示例:“accounts/100” |
DeleteConversionEventRequest
针对 DeleteConversionEvent RPC 的请求消息
| 字段 | |
|---|---|
name |
必需。要删除的转化事件的资源名称。格式:properties/{property}/conversionEvents/{conversion_event} 示例:“properties/123/conversionEvents/456” |
DeleteDataStreamRequest
针对 DeleteDataStream RPC 的请求消息。
| 字段 | |
|---|---|
name |
必需。要删除的 DataStream 的名称。示例格式:properties/1234/dataStreams/5678 |
DeleteFirebaseLinkRequest
针对 DeleteFirebaseLink RPC 的请求消息
| 字段 | |
|---|---|
name |
必需。格式:properties/{property_id}/firebaseLinks/{firebase_link_id} 示例: |
DeleteGoogleAdsLinkRequest
针对 DeleteGoogleAdsLink RPC 的请求消息。
| 字段 | |
|---|---|
name |
必需。示例格式:properties/1234/googleAdsLinks/5678 |
DeleteKeyEventRequest
针对 DeleteKeyEvent RPC 的请求消息
| 字段 | |
|---|---|
name |
必需。要删除的键事件的资源名称。格式:properties/{property}/keyEvents/{key_event} 示例:“properties/123/keyEvents/456” |
DeleteMeasurementProtocolSecretRequest
针对 DeleteMeasurementProtocolSecret RPC 的请求消息
| 字段 | |
|---|---|
name |
必需。要删除的 MeasurementProtocolSecret 的名称。格式:properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} |
DeletePropertyRequest
针对 DeleteProperty RPC 的请求消息。
| 字段 | |
|---|---|
name |
必需。要软删除的媒体资源的名称。格式:properties/{property_id} 示例:“properties/1000” |
FirebaseLink
Google Analytics 媒体资源与 Firebase 项目之间的关联。
| 字段 | |
|---|---|
name |
标识符。示例格式:properties/1234/firebaseLinks/5678 |
project |
不可变。Firebase 项目资源名称。创建 FirebaseLink 时,您可以使用项目编号或项目 ID 提供此资源名称。创建此资源后,返回的 FirebaseLink 将始终具有包含项目编号的 project_name。 格式:'projects/{项目编号}' 示例:'projects/1234' |
create_time |
仅限输出。相应 FirebaseLink 最初的创建时间。 |
GetAccountRequest
针对 GetAccount RPC 的请求消息。
| 字段 | |
|---|---|
name |
必需。要查找的账号的名称。格式:accounts/{account} 示例:“accounts/100” |
GetConversionEventRequest
针对 GetConversionEvent RPC 的请求消息
| 字段 | |
|---|---|
name |
必需。要检索的转化事件的资源名称。格式:properties/{property}/conversionEvents/{conversion_event} 示例:“properties/123/conversionEvents/456” |
GetCustomDimensionRequest
针对 GetCustomDimension RPC 的请求消息。
| 字段 | |
|---|---|
name |
必需。要获取的 CustomDimension 的名称。示例格式:properties/1234/customDimensions/5678 |
GetCustomMetricRequest
针对 GetCustomMetric RPC 的请求消息。
| 字段 | |
|---|---|
name |
必需。要获取的 CustomMetric 的名称。示例格式:properties/1234/customMetrics/5678 |
GetDataRetentionSettingsRequest
针对 GetDataRetentionSettings RPC 的请求消息。
| 字段 | |
|---|---|
name |
必需。要查找的设置的名称。格式:properties/{property}/dataRetentionSettings 示例:“properties/1000/dataRetentionSettings” |
GetDataSharingSettingsRequest
针对 GetDataSharingSettings RPC 的请求消息。
| 字段 | |
|---|---|
name |
必需。要查找的设置的名称。格式:accounts/{account}/dataSharingSettings 示例: |
GetDataStreamRequest
针对 GetDataStream RPC 的请求消息。
| 字段 | |
|---|---|
name |
必需。要获取的 DataStream 的名称。示例格式:properties/1234/dataStreams/5678 |
GetKeyEventRequest
针对 GetKeyEvent RPC 的请求消息
| 字段 | |
|---|---|
name |
必需。要检索的关键事件的资源名称。格式:properties/{property}/keyEvents/{key_event} 示例:“properties/123/keyEvents/456” |
GetMeasurementProtocolSecretRequest
针对 GetMeasurementProtocolSecret RPC 的请求消息。
| 字段 | |
|---|---|
name |
必需。要查找的 Measurement Protocol 密钥的名称。格式:properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} |
GetPropertyRequest
针对 GetProperty RPC 的请求消息。
| 字段 | |
|---|---|
name |
必需。要查找的属性的名称。格式:properties/{property_id} 示例:“properties/1000” |
GoogleAdsLink
Google Analytics 媒体资源与 Google Ads 账号之间的关联。
| 字段 | |
|---|---|
name |
标识符。格式:properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} 注意:googleAdsLinkId 不是 Google Ads 客户 ID。 |
customer_id |
不可变。Google Ads 客户 ID。 |
can_manage_clients |
仅限输出。如果为 true,则此链接适用于 Google Ads 经理账号。 |
ads_personalization_enabled |
通过此集成启用个性化广告功能。自动将我的 Google Analytics 受众群体名单和 Google Analytics 再营销事件/参数发布到关联的 Google Ads 账号。如果在创建/更新时未设置此字段,则默认值为 true。 |
create_time |
仅限输出。相应关联的最初创建时间。 |
update_time |
仅限输出。相应链接的上次更新时间。 |
creator_email_address |
仅限输出。创建链接的用户的电子邮件地址。如果无法检索电子邮件地址,则返回空字符串。 |
IndustryCategory
为此媒体资源选择的类别,用于行业基准比较。
| 枚举 | |
|---|---|
INDUSTRY_CATEGORY_UNSPECIFIED |
未指定行业类别 |
AUTOMOTIVE |
汽车 |
BUSINESS_AND_INDUSTRIAL_MARKETS |
工商业市场 |
FINANCE |
财经 |
HEALTHCARE |
医疗保健 |
TECHNOLOGY |
技术 |
TRAVEL |
旅游 |
OTHER |
其他 |
ARTS_AND_ENTERTAINMENT |
艺术与娱乐 |
BEAUTY_AND_FITNESS |
美容健身 |
BOOKS_AND_LITERATURE |
图书与文学 |
FOOD_AND_DRINK |
食品和饮料 |
GAMES |
游戏 |
HOBBIES_AND_LEISURE |
爱好与休闲 |
HOME_AND_GARDEN |
家居园艺 |
INTERNET_AND_TELECOM |
互联网与电信 |
LAW_AND_GOVERNMENT |
法律和政府 |
NEWS |
新闻 |
ONLINE_COMMUNITIES |
在线社区 |
PEOPLE_AND_SOCIETY |
人与社会 |
PETS_AND_ANIMALS |
宠物与动物 |
REAL_ESTATE |
房地产 |
REFERENCE |
参考 |
SCIENCE |
科学 |
SPORTS |
体育 |
JOBS_AND_EDUCATION |
招聘与培训 |
SHOPPING |
购物 |
KeyEvent
Google Analytics 媒体资源中的关键事件。
| 字段 | |
|---|---|
name |
仅限输出。相应关键事件的资源名称。格式:properties/{property}/keyEvents/{key_event} |
event_name |
不可变。相应关键事件的事件名称。示例:'click'、'purchase' |
create_time |
仅限输出。相应关键事件在媒体资源中创建的时间。 |
deletable |
仅限输出。如果设置为 true,则可以删除相应活动。 |
custom |
仅限输出。如果设置为 true,则此关键事件是指自定义事件。如果设置为 false,则此关键事件是指 GA 中的默认事件。默认事件通常在 GA 中具有特殊含义。默认事件通常由 GA 系统为您创建,但在某些情况下,也可以由媒体资源管理员创建。自定义事件会占用每个媒体资源可创建的自定义关键事件数量上限。 |
counting_method |
必需。在会话中,统计多个事件的关键事件的方法。 |
default_value |
可选。为关键事件定义默认价值/币种。 |
CountingMethod
在会话中,统计多个事件的关键事件的方法。
| 枚举 | |
|---|---|
COUNTING_METHOD_UNSPECIFIED |
未指定统计方法。 |
ONCE_PER_EVENT |
每个 Event 实例都被视为关键事件。 |
ONCE_PER_SESSION |
每个用户在每次会话中最多只能将一个事件实例视为关键事件。 |
DefaultValue
为关键事件定义默认价值/币种。
| 字段 | |
|---|---|
numeric_value |
必需。此值将用于填充相应关键事件(由 event_name 指定)的所有实例中未设置的“value”参数。 |
currency_code |
必需。如果此关键事件(由 event_name 指定)的某次发生没有设置币种,则系统会应用此币种作为默认币种。必须采用 ISO 4217 货币代码格式。 如需了解详情,请参阅 https://en.wikipedia.org/wiki/ISO_4217。 |
ListAccountSummariesRequest
针对 ListAccountSummaries RPC 的请求消息。
| 字段 | |
|---|---|
page_size |
可选。要返回的 AccountSummary 资源数量上限。即使有其他页面,服务返回的项数也可能小于此值。如果未指定,则最多返回 50 个资源。最大值为 200;(更高的值将被强制转换为最大值) |
page_token |
可选。从之前的 |
ListAccountSummariesResponse
针对 ListAccountSummaries RPC 的响应消息。
| 字段 | |
|---|---|
account_summaries[] |
调用者有权访问的所有账号的账号摘要。 |
next_page_token |
可作为 |
ListAccountsRequest
针对 ListAccounts RPC 的请求消息。
| 字段 | |
|---|---|
page_size |
可选。要返回的资源数量上限。即使有其他页面,服务返回的项数也可能小于此值。如果未指定,则最多返回 50 个资源。最大值为 200;(更高的值将被强制转换为最大值) |
page_token |
可选。从之前的 |
show_deleted |
是否在结果中包含已软删除(即“已放入回收站”)的账号。您可以检查账号,以确定其是否已被删除。 |
ListAccountsResponse
针对 ListAccounts RPC 的请求消息。
| 字段 | |
|---|---|
accounts[] |
调用者可访问的结果。 |
next_page_token |
可作为 |
ListConversionEventsRequest
针对 ListConversionEvents RPC 的请求消息
| 字段 | |
|---|---|
parent |
必需。父级媒体资源的资源名称。示例:'properties/123' |
page_size |
可选。要返回的资源数量上限。如果未指定,则最多返回 50 个资源。最大值为 200;(更高的值将被强制转换为最大值) |
page_token |
可选。从之前的 |
ListConversionEventsResponse
针对 ListConversionEvents RPC 的响应消息。
| 字段 | |
|---|---|
conversion_events[] |
所请求的转化事件 |
next_page_token |
可作为 |
ListCustomDimensionsRequest
针对 ListCustomDimensions RPC 的请求消息。
| 字段 | |
|---|---|
parent |
必需。示例格式:properties/1234 |
page_size |
可选。要返回的资源数量上限。如果未指定,则最多返回 50 个资源。最大值为 200(更高的值将被强制转换为最大值)。 |
page_token |
可选。从之前的 进行分页时,提供给 |
ListCustomDimensionsResponse
针对 ListCustomDimensions RPC 的响应消息。
| 字段 | |
|---|---|
custom_dimensions[] |
CustomDimensions 的列表。 |
next_page_token |
可作为 |
ListCustomMetricsRequest
针对 ListCustomMetrics RPC 的请求消息。
| 字段 | |
|---|---|
parent |
必需。示例格式:properties/1234 |
page_size |
要返回的资源数量上限。如果未指定,则最多返回 50 个资源。最大值为 200(更高的值将被强制转换为最大值)。 |
page_token |
从之前的 进行分页时,提供给 |
ListCustomMetricsResponse
针对 ListCustomMetrics RPC 的响应消息。
| 字段 | |
|---|---|
custom_metrics[] |
CustomMetrics 的列表。 |
next_page_token |
可作为 |
ListDataStreamsRequest
针对 ListDataStreams RPC 的请求消息。
| 字段 | |
|---|---|
parent |
必需。示例格式:properties/1234 |
page_size |
要返回的资源数量上限。如果未指定,则最多返回 50 个资源。最大值为 200(更高的值将被强制转换为最大值)。 |
page_token |
从之前的 进行分页时,提供给 |
ListDataStreamsResponse
针对 ListDataStreams RPC 的响应消息。
| 字段 | |
|---|---|
data_streams[] |
DataStream 列表。 |
next_page_token |
可作为 |
ListFirebaseLinksRequest
针对 ListFirebaseLinks RPC 的请求消息
| 字段 | |
|---|---|
parent |
必需。格式:properties/{property_id} 示例: |
page_size |
可选。要返回的资源数量上限。即使有其他页面,服务返回的项数也可能小于此值。如果未指定,则最多返回 50 个资源。最大值为 200;(更高的值将被强制转换为最大值) |
page_token |
可选。从之前的 |
ListFirebaseLinksResponse
针对 ListFirebaseLinks RPC 的响应消息
| 字段 | |
|---|---|
firebase_links[] |
FirebaseLink 的列表。此属性最多只能有一个值。 |
next_page_token |
可作为 |
ListGoogleAdsLinksRequest
针对 ListGoogleAdsLinks RPC 的请求消息。
| 字段 | |
|---|---|
parent |
必需。示例格式:properties/1234 |
page_size |
可选。要返回的资源数量上限。如果未指定,则最多返回 50 个资源。最大值为 200(更高的值将被强制转换为最大值)。 |
page_token |
可选。从之前的 进行分页时,提供给 |
ListGoogleAdsLinksResponse
针对 ListGoogleAdsLinks RPC 的响应消息。
| 字段 | |
|---|---|
google_ads_links[] |
GoogleAdsLink 的列表。 |
next_page_token |
可作为 |
ListKeyEventsRequest
针对 ListKeyEvents RPC 的请求消息
| 字段 | |
|---|---|
parent |
必需。父级媒体资源的资源名称。示例:'properties/123' |
page_size |
可选。要返回的资源数量上限。如果未指定,则最多返回 50 个资源。最大值为 200;(更高的值将被强制转换为最大值) |
page_token |
可选。从之前的 |
ListKeyEventsResponse
针对 ListKeyEvents RPC 的响应消息。
| 字段 | |
|---|---|
key_events[] |
所请求的关键事件 |
next_page_token |
可作为 |
ListMeasurementProtocolSecretsRequest
针对 ListMeasurementProtocolSecret RPC 的请求消息
| 字段 | |
|---|---|
parent |
必需。父级媒体源的资源名称。格式:properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets |
page_size |
可选。要返回的资源数量上限。如果未指定,则最多返回 10 个资源。最大值为 10。较高的值将被强制转换为最大值。 |
page_token |
可选。从之前的 |
ListMeasurementProtocolSecretsResponse
针对 ListMeasurementProtocolSecret RPC 的响应消息
| 字段 | |
|---|---|
measurement_protocol_secrets[] |
请求中指定的父级直播的密钥列表。 |
next_page_token |
可作为 |
ListPropertiesRequest
针对 ListProperties RPC 的请求消息。
| 字段 | |
|---|---|
filter |
必需。用于过滤请求结果的表达式。可用于过滤的字段包括: |
page_size |
可选。要返回的资源数量上限。即使有其他页面,服务返回的项数也可能小于此值。如果未指定,则最多返回 50 个资源。最大值为 200;(更高的值将被强制转换为最大值) |
page_token |
可选。从之前的 |
show_deleted |
是否在结果中包含软删除(即“已放入回收站”)的媒体资源。您可以检查属性,以确定它们是否已被删除。 |
ListPropertiesResponse
针对 ListProperties RPC 的响应消息。
| 字段 | |
|---|---|
properties[] |
符合过滤条件且可供调用方访问的结果。 |
next_page_token |
可作为 |
MeasurementProtocolSecret
用于向 Measurement Protocol 发送命中数据的密钥值。
| 字段 | |
|---|---|
name |
标识符。相应 Secret 的资源名称。此 Secret 可以是任何类型流的子级。格式:properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} |
display_name |
必需。相应 Secret 的人类可读显示名称。 |
secret_value |
仅限输出。Measurement Protocol 密钥值。向相应密钥的父媒体资源发送命中时,请将此值传递给 Measurement Protocol API 的 api_secret 字段。 |
NumericValue
表示一个数字。
| 字段 | |
|---|---|
联合字段 one_value。数值 one_value 只能是以下值之一: |
|
int64_value |
整数值 |
double_value |
DoubleValue |
属性
表示 Google Analytics 媒体资源的资源消息。
| 字段 | |
|---|---|
name |
标识符。相应媒体资源的资源名称。格式:properties/{property_id} 示例:“properties/1000” |
property_type |
不可变。相应媒体资源资源的媒体资源类型。创建媒体资源时,如果类型为“PROPERTY_TYPE_UNSPECIFIED”,则表示“ORDINARY_PROPERTY”。 |
create_time |
仅限输出。实体的最初创建时间。 |
update_time |
仅限输出。实体载荷字段的上次更新时间。 |
parent |
不可变。相应媒体资源的逻辑父级的资源名称。 注意:您可以使用“移动媒体资源”界面来更改父级。格式:accounts/{account}, properties/{property} 示例:“accounts/100”“properties/101” |
display_name |
必需。相应媒体资源的人类可读显示名称。 允许的显示名称长度上限为 100 个 UTF-16 代码单元。 |
industry_category |
与相应媒体资源相关联的行业。示例:AUTOMOTIVE、FOOD_AND_DRINK |
time_zone |
必需。报告时区,用作报告的每日起止时间,而无论数据来自何处。如果时区使用夏时制,Google Analytics 会根据相应的变化自动做出调整。 注意:更改时区只会影响未来的数据,不会影响以前的数据。 格式:https://www.iana.org/time-zones 示例:“America/Los_Angeles” |
currency_code |
涉及货币价值的报告中使用的币种类型。 格式:https://en.wikipedia.org/wiki/ISO_4217 示例:“USD”“EUR”“JPY” |
service_level |
仅限输出。适用于相应媒体资源的 Google Analytics 服务等级。 |
delete_time |
仅限输出。如果已设置,则表示相应媒体资源被放入回收站的时间。如果未设置,则表示相应媒体资源目前不在回收站中。 |
expire_time |
仅限输出。如果已设置,则表示相应已放入回收站的媒体资源将被永久删除的时间。如果未设置,则表示相应媒体资源目前不在回收站中,并且未计划删除。 |
account |
不可变。父账号的资源名称。格式:accounts/{account_id}。示例:“accounts/123” |
PropertySummary
一种虚拟资源,用于表示 Google Analytics 媒体资源的元数据。
| 字段 | |
|---|---|
property |
相应媒体资源摘要所指媒体资源的资源名称。格式:properties/{property_id}。示例:“properties/1000” |
display_name |
相应媒体资源摘要中提及的媒体资源的显示名称。 |
property_type |
相应房源的房源类型。 |
parent |
相应媒体资源的逻辑父级的资源名称。 注意:您可以使用“移动媒体资源”界面来更改父级。格式:accounts/{account}, properties/{property} 示例:“accounts/100”“properties/200” |
can_edit |
如果为 true,则表示用户拥有允许其修改相应媒体资源的 Google Analytics 角色。 |
PropertyType
Property 资源的类型。
| 枚举 | |
|---|---|
PROPERTY_TYPE_UNSPECIFIED |
未知或未指定的媒体资源类型 |
PROPERTY_TYPE_ORDINARY |
普通 Google Analytics 媒体资源 |
PROPERTY_TYPE_SUBPROPERTY |
Google Analytics 子媒体资源 |
PROPERTY_TYPE_ROLLUP |
Google Analytics 总览媒体资源 |
ProvisionAccountTicketRequest
针对 ProvisionAccountTicket RPC 的请求消息。
| 字段 | |
|---|---|
account |
要创建的账号。 |
redirect_uri |
用户接受服务条款后会转到的重定向 URI。必须在 Cloud 控制台中配置为重定向 URI。 |
ProvisionAccountTicketResponse
针对 ProvisionAccountTicket RPC 的响应消息。
| 字段 | |
|---|---|
account_ticket_id |
要在服务条款链接中传递的参数。 |
RunAccessReportRequest
数据访问记录报告的请求。
| 字段 | |
|---|---|
entity |
数据访问权限报告支持在媒体资源级或账号级提出请求。如果是在账号一级请求数据访问报告,则报告会包含相应账号下所有媒体资源的所有访问记录。 如需在媒体资源级请求,实体应为“properties/123”(如果“123”是您的 Google Analytics 媒体资源 ID)。如需在账号级层发出请求,实体应为“accounts/1234”(如果“1234”是您的 Google Analytics 账号 ID)。 |
dimensions[] |
请求的维度以及响应中显示的维度。请求最多允许包含 9 个维度。 |
metrics[] |
请求的指标以及在响应中显示的指标。最多允许请求 10 个指标。 |
date_ranges[] |
要读取的访问记录的日期范围。如果请求了多个日期范围,则每个响应行都将包含一个从零开始的日期范围索引。如果两个日期范围重叠,则重叠日期的访问记录会包含在两个日期范围的响应行中。最多允许 2 个日期范围。 |
dimension_filter |
借助维度过滤条件,您可以将报告响应限制为与过滤条件匹配的特定维度值。例如,过滤单个用户的访问记录。如需了解详情,请参阅维度过滤条件基础知识,其中包含相关示例。此过滤条件不支持使用指标。 |
metric_filter |
借助指标过滤条件,您可以将报告响应限制为与过滤条件匹配的特定指标值。指标过滤条件是在汇总报告的行之后应用的,类似于 SQL having 子句。此过滤条件中不能使用维度。 |
offset |
起始行的行数。第一行计为第 0 行。如果未指定偏移量,则将其视为 0。如果偏移量为零,则此方法将返回包含 如需详细了解此分页参数,请参阅分页。 |
limit |
要返回的行数。如果未指定,则返回 10,000 行。无论您请求多少行,该 API 每次请求最多返回 10 万行。 如果剩余的行数少于 如需详细了解此分页参数,请参阅分页。 |
time_zone |
相应请求的时区(如果已指定)。如果未指定,则使用媒体资源的相应时区。请求的时区用于解读报告的开始日期和结束日期。 格式为 IANA 时区数据库 (https://www.iana.org/time-zones) 中的字符串;例如“America/New_York”或“Asia/Tokyo”。 |
order_bys[] |
指定响应中各行的排序方式。 |
return_entity_quota |
切换是否返回相应 Google Analytics 媒体资源配额的当前状态。配额在 AccessQuota 中返回。对于账号级请求,此字段必须为 false。 |
include_all_users |
可选。确定是否在响应中包含从未进行过 API 调用的用户。如果为 true,则无论指定媒体资源或账号的所有用户是否已发出 API 调用,系统都会在响应中包含这些用户。如果值为 false,则仅包含已进行 API 调用的用户。 |
expand_groups |
可选。决定是否返回用户群组中的用户。仅当 include_all_users 设置为 true 时,此字段才会生效。如果为 true,则返回有权访问指定媒体资源或账号的所有用户。如果为 false,则仅返回具有直接访问权限的用户。 |
RunAccessReportResponse
自定义的数据访问记录报告响应。
| 字段 | |
|---|---|
dimension_headers[] |
报告中与特定维度对应的列的标题。DimensionHeaders 的数量和顺序与行中存在的维度一致。 |
metric_headers[] |
报告中与特定指标对应的列的标题。MetricHeaders 的数量和顺序与行中存在的指标相匹配。 |
rows[] |
报告中维度值组合和指标值的行。 |
row_count |
查询结果中的总行数。 如需详细了解此分页参数,请参阅分页。 |
quota |
相应 Google Analytics 媒体资源(包括相应请求)的配额状态。此字段不适用于账号级请求。 |
SearchChangeHistoryEventsRequest
针对 SearchChangeHistoryEvents RPC 的请求消息。
| 字段 | |
|---|---|
account |
必需。要返回更改历史记录资源的账号资源。格式:accounts/{account} 示例: |
property |
可选。子级媒体资源的资源名称。如果设置,则仅返回对此属性或其子资源所做的更改。格式:properties/{propertyId} 示例: |
resource_type[] |
可选。如果设置,则仅当更改是针对至少与其中一种类型匹配的资源时才返回更改。 |
action[] |
可选。如果设置了此参数,则只会返回与这些操作类型中的一种或多种相符的更改。 |
actor_email[] |
可选。如果设置了此参数,则仅当更改是由此列表中的用户做出的时,才返回更改。 |
earliest_change_time |
可选。如果进行了设置,则只会返回相应时间之后(含此时间)所做的更改。 |
latest_change_time |
可选。如果进行了设置,则只会返回相应时间之前(含此时间)所做的更改。 |
page_size |
可选。要返回的 ChangeHistoryEvent 项数的上限。如果未指定,则最多返回 50 个商品。最大值为 200(更高的值将被强制转换为最大值)。 请注意,即使可能还有其他网页,服务返回的网页中的商品数量也可能小于此值(甚至可能为零)。如果您需要特定数量的商品,则需要继续使用 |
page_token |
可选。从之前的 |
SearchChangeHistoryEventsResponse
针对 SearchAccounts RPC 的响应消息。
| 字段 | |
|---|---|
change_history_events[] |
调用者可访问的结果。 |
next_page_token |
可作为 |
ServiceLevel
Google Analytics 的各种服务级别。
| 枚举 | |
|---|---|
SERVICE_LEVEL_UNSPECIFIED |
未指定或指定了无效的服务级别。 |
GOOGLE_ANALYTICS_STANDARD |
Google Analytics 的标准版。 |
GOOGLE_ANALYTICS_360 |
Google Analytics 的付费高级版。 |
UpdateAccountRequest
针对 UpdateAccount RPC 的请求消息。
| 字段 | |
|---|---|
account |
必需。要更新的账号。账号的 |
update_mask |
必需。要更新的字段的列表。字段名称必须采用蛇形命名法(例如“field_to_update”)。省略的字段将不会更新。如需替换整个实体,请使用一个包含字符串“*”的路径来匹配所有字段。 |
UpdateConversionEventRequest
针对 UpdateConversionEvent RPC 的请求消息
| 字段 | |
|---|---|
conversion_event |
必需。要更新的转化事件。 |
update_mask |
必需。要更新的字段的列表。字段名称必须采用蛇形命名法(例如“field_to_update”)。省略的字段将不会更新。如需替换整个实体,请使用一个包含字符串“*”的路径来匹配所有字段。 |
UpdateCustomDimensionRequest
针对 UpdateCustomDimension RPC 的请求消息。
| 字段 | |
|---|---|
custom_dimension |
要更新的 CustomDimension |
update_mask |
必需。要更新的字段的列表。省略的字段将不会更新。如需替换整个实体,请使用一个包含字符串“*”的路径来匹配所有字段。 |
UpdateCustomMetricRequest
针对 UpdateCustomMetric RPC 的请求消息。
| 字段 | |
|---|---|
custom_metric |
要更新的 CustomMetric |
update_mask |
必需。要更新的字段的列表。省略的字段将不会更新。如需替换整个实体,请使用一个包含字符串“*”的路径来匹配所有字段。 |
UpdateDataRetentionSettingsRequest
针对 UpdateDataRetentionSettings RPC 的请求消息。
| 字段 | |
|---|---|
data_retention_settings |
必需。要更新的设置。 |
update_mask |
必需。要更新的字段的列表。字段名称必须采用蛇形命名法(例如“field_to_update”)。省略的字段将不会更新。如需替换整个实体,请使用一个包含字符串“*”的路径来匹配所有字段。 |
UpdateDataStreamRequest
针对 UpdateDataStream RPC 的请求消息。
| 字段 | |
|---|---|
data_stream |
要更新的 DataStream |
update_mask |
必需。要更新的字段的列表。省略的字段将不会更新。如需替换整个实体,请使用一个包含字符串“*”的路径来匹配所有字段。 |
UpdateGoogleAdsLinkRequest
针对 UpdateGoogleAdsLink RPC 的请求消息
| 字段 | |
|---|---|
google_ads_link |
要更新的 GoogleAdsLink |
update_mask |
必需。要更新的字段的列表。字段名称必须采用蛇形命名法(例如“field_to_update”)。省略的字段将不会更新。如需替换整个实体,请使用一个包含字符串“*”的路径来匹配所有字段。 |
UpdateKeyEventRequest
针对 UpdateKeyEvent RPC 的请求消息
| 字段 | |
|---|---|
key_event |
必需。要更新的关键事件。 |
update_mask |
必需。要更新的字段的列表。字段名称必须采用蛇形命名法(例如“field_to_update”)。省略的字段将不会更新。如需替换整个实体,请使用一个包含字符串“*”的路径来匹配所有字段。 |
UpdateMeasurementProtocolSecretRequest
针对 UpdateMeasurementProtocolSecret RPC 的请求消息
| 字段 | |
|---|---|
measurement_protocol_secret |
必需。要更新的 Measurement Protocol 密钥。 |
update_mask |
必需。要更新的字段的列表。省略的字段将不会更新。 |
UpdatePropertyRequest
针对 UpdateProperty RPC 的请求消息。
| 字段 | |
|---|---|
property |
必需。要更新的媒体资源。相应属性的 |
update_mask |
必需。要更新的字段的列表。字段名称必须采用蛇形命名法(例如“field_to_update”)。省略的字段将不会更新。如需替换整个实体,请使用一个包含字符串“*”的路径来匹配所有字段。 |