Package google.analytics.admin.v1beta

NumericValue

以此数字开头。

NumericValue

以此数字结尾。

string

查询的开始日期（含此日期），格式为 YYYY-MM-DD。不得晚于 endDate。系统也接受 NdaysAgo、yesterday 或 today 格式，在这种情况下，系统会根据请求时区的当前时间推断日期。

string

查询的结束日期（含此日期），格式为 YYYY-MM-DD。不能早于 startDate。系统也接受 NdaysAgo、yesterday 或 today 格式，在这种情况下，系统会根据请求时区的当前时间推断日期。

string

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

dimensionFilter 和 orderBys 中会按名称引用维度。

string

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

string

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

string

维度名称或指标名称。

AccessStringFilter

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

AccessInListFilter

用于过滤“in”列表值的过滤条件。

AccessNumericFilter

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

AccessBetweenFilter

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

AccessFilterExpressionList

and_group 中的每个 FilterExpression 之间都存在“AND”关系。

AccessFilterExpressionList

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

AccessFilterExpression

FilterExpression 不是 not_expression。

AccessFilter

基元过滤器。在同一 FilterExpression 中，过滤条件的所有字段名称都必须是所有维度或所有指标。

AccessFilterExpression

过滤条件表达式列表。

string

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

bool

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

string

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

在 metricFilter 和 orderBys 中，指标是按名称引用的。

string

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

string

测量值。例如，此值可以是“13”。

Operation

此过滤条件的操作类型。

NumericValue

数值或日期值。

bool

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

MetricOrderBy

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

DimensionOrderBy

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

string

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

OrderType

控制维度值排序规则。

string

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

AccessQuotaStatus

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

AccessQuotaStatus

媒体资源每小时可以使用 5 万个令牌。一个 API 请求会消耗一组令牌，系统会从所有小时配额、每日配额和每个项目的小时配额中扣除该数量。

AccessQuotaStatus

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

AccessQuotaStatus

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

AccessQuotaStatus

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

int32

此请求消耗的配额。

int32

此请求后剩余的配额。

AccessDimensionValue

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

AccessMetricValue

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

MatchType

此过滤条件的匹配类型。

string

用于匹配的字符串值。

bool

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

string

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

Timestamp

仅限输出。此账号的最初创建时间。

Timestamp

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

string

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

string

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

bool

仅限输出。指示此账号是否已被软删除。除非您明确要求，否则已删除的账号不会显示在列表结果中。

string

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

string

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

string

此账号摘要中提及的账号的资源名称。格式：accounts/{account_id}。示例：“accounts/1000”

string

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

PropertySummary

此账号的子账号摘要列表。

string

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

string

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

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

string

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

string

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

string

此条目描述的资源的资源名称。

ActionType

更改此资源的操作类型。

ChangeHistoryResource

更改生效前资源的内容。如果此资源是在此次更改中创建的，则此字段将缺失。

ChangeHistoryResource

更改生效后的资源内容。如果此资源在此更改中被删除，则此字段将缺失。

Account

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

Property

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

FirebaseLink

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

GoogleAdsLink

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

ConversionEvent

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

MeasurementProtocolSecret

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

DataRetentionSettings

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

DataStream

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

string

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

Timestamp

更改的时间。

ActorType

进行此更改的操作者类型。

string

做出更改的 Google 账号的电子邮件地址。如果“执行者”字段设置为“USER”，则此字段应为有效的电子邮件地址；否则，此字段应为空。已删除的 Google 账号会导致错误。

bool

如果为 true，则表示返回的更改列表已过滤，并不代表在此事件中发生的所有更改。

ChangeHistoryChange

在此更改历史记录事件中进行的符合 SearchChangeHistoryEventsRequest 中指定过滤条件的更改的列表。

string

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

string

不可变。此转化事件的事件名称。示例：“点击”“购买”

Timestamp

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

bool

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

bool

仅限输出。如果设为 true，此转化事件将引用自定义事件。如果设置为 false，此转化事件将引用 GA 中的默认事件。默认事件通常在 GA 中具有特殊含义。默认事件通常由 GA 系统为您创建，但在某些情况下也可以由媒体资源管理员创建。自定义事件会计入每个媒体资源可创建的自定义转化事件的数量上限。

ConversionCountingMethod

可选。用于跨会话内的多个事件统计转化的方法。如果未提供此值，则将其设为 ONCE_PER_EVENT。

DefaultConversionValue

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

double

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

string

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

ConversionEvent

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

string

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

string

必需。示例格式：properties/1234

CustomDimension

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

string

必需。示例格式：properties/1234

CustomMetric

必需。要创建的 CustomMetric。

string

必需。示例格式：properties/1234

DataStream

必需。要创建的 DataStream。

string

必需。格式：properties/{property_id}

示例：properties/1234

FirebaseLink

必需。要创建的 Firebase 关联。

string

必需。示例格式：properties/1234

GoogleAdsLink

必需。要创建的 GoogleAdsLink。

KeyEvent

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

string

必需。将要创建此关键事件的父级媒体资源的资源名称。格式：properties/123

string

必需。将在其中创建此密钥的父级资源。格式：properties/{property}/dataStreams/{dataStream}

MeasurementProtocolSecret

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

Property

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

string

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

string

必需。不可变。此自定义维度的代码植入参数名称。

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

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

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

string

必需。此自定义维度的显示名称（如 Google Analytics 界面中所示）。最多 82 个字符，可包含字母数字、空格和下划线，且必须以字母开头。旧版系统生成的显示名称可以包含方括号，但对此字段进行更新时绝不允许使用方括号。

string

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

DimensionScope

必需。不可变。此维度的范围。

bool

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

目前，只有用户级范围的自定义维度支持此功能。

string

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

string

必需。不可变。此自定义指标的代码植入名称。

如果这是事件级范围的指标，则此维度是事件参数名称。

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

string

必需。此自定义指标的显示名称（如 Google Analytics 界面中所示）。最多 82 个字符，可包含字母数字、空格和下划线，且必须以字母开头。旧版系统生成的显示名称可以包含方括号，但对此字段进行更新时绝不允许使用方括号。

string

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

MeasurementUnit

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

MetricScope

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

RestrictedMetricType

可选。此指标可能包含的受限数据类型。对于使用“CURRENCY”衡量单位的指标，此字段为必填。对于衡量单位不是“CURRENCY”的指标，此值必须为空。

string

仅限输出。此 DataRetentionSetting 资源的资源名称。格式：properties/{property}/dataRetentionSettings

RetentionDuration

必需。事件级数据的保留期限。

RetentionDuration

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

bool

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

string

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

bool

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

此字段会映射到 Google Analytics“管理”界面中的“技术支持”字段。

bool

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

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

bool

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

bool

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

此字段会映射到 Google Analytics“管理”界面中的“Google 产品和服务”字段。

bool

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

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

string

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

DataStreamType

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

string

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

网站数据流必须提供此维度。

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

Timestamp

仅限输出。此数据流的原始创建时间。

Timestamp

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

WebStreamData

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

AndroidAppStreamData

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

IosAppStreamData

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

string

仅限输出。Firebase 中相应 Android 应用的 ID（如果有）。如果删除并重新创建 Android 应用，此 ID 可能会发生变化。

string

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

string

仅限输出。Firebase 中相应 iOS 应用的 ID（如果有）。如果删除并重新创建 iOS 应用，此 ID 可能会发生变化。

string

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

string

仅限输出。Google Analytics 衡量 ID。

示例：“G-1A2BCD345E”

string

仅限输出。Firebase 中相应 Web 应用的 ID（如果有）。如果您删除并重新创建 Web 应用，此 ID 可能会发生变化。

string

要衡量的网站应用的域名，或为空。示例：“http://www.google.com”“https://www.google.com”

string

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

string

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

string

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

string

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

示例：properties/1234/firebaseLinks/5678

string

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

string

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

string

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

string

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

string

仅限输出。示例格式：properties/1234/firebaseLinks/5678

string

不可变。Firebase 项目资源名称。创建 FirebaseLink 时，您可以使用项目编号或项目 ID 提供此资源名称。创建此资源后，返回的 FirebaseLink 始终会包含项目编号的 project_name。

格式：“projects/{project number}”示例：“projects/1234”

Timestamp

仅限输出。此 FirebaseLink 最初创建的时间。

string

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

string

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

string

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

string

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

string

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

string

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

示例：accounts/1000/dataSharingSettings

string

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

string

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

string

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

string

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

string

仅限输出。格式：properties/{propertyId}/googleAdsLinks/{googleAdsLinkId}

注意：googleAdsLinkId 不是 Google Ads 客户 ID。

string

不可变。Google Ads 客户 ID。

bool

仅限输出。如果为 true，则表示此关联是针对 Google Ads 经理账号。

BoolValue

通过此集成启用个性化广告功能。自动将我的 Google Analytics 受众群体名单和 Google Analytics 再营销事件/参数发布到关联的 Google Ads 账号。如果在创建/更新时未设置此字段，则默认为 true。

Timestamp

仅限输出。此关联的初始创建时间。

Timestamp

仅限输出。此链接上次更新的时间。

string

仅限输出。创建关联的用户的电子邮件地址。如果无法检索到电子邮件地址，则会返回空字符串。

string

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

string

不可变。此按键事件的事件名称。示例：“点击”“购买”

Timestamp

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

bool

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

bool

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

CountingMethod

必需。系统跨会话内的多个事件统计关键事件的方式。

DefaultValue

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

double

必需。系统会使用此值来填充此关键事件（由 event_name 指定）的所有出现情况的“value”参数（如果该参数未设置）。

string

必需。如果此关键事件（由 event_name 指定）的某个出现情况未设置币种，系统会将此币种应用为默认币种。必须采用 ISO 4217 货币代码格式。

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

int32

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

string

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

AccountSummary

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

string

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

int32

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

string

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

bool

是否在结果中包含已软删除（即“移至回收站”）的账号。您可以检查账号，以确定其是否已被删除。

Account

可供调用方访问的结果。

string

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

string

必需。父媒体资源的资源名称。示例：“properties/123”

int32

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

string

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

ConversionEvent

请求的转化事件

string

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

string

必需。示例格式：properties/1234

int32

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

string

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

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

CustomDimension

CustomDimensions 列表。

string

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

string

必需。示例格式：properties/1234

int32

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

string

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

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

CustomMetric

CustomMetrics 列表。

string

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

string

必需。示例格式：properties/1234

int32

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

string

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

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

DataStream

DataStream 列表。

string

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

string

必需。格式：properties/{property_id}

示例：properties/1234

int32

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

string

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

FirebaseLink

FirebaseLinks 列表。此值最多只能有一个。

string

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

string

必需。示例格式：properties/1234

int32

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

string

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

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

GoogleAdsLink

GoogleAdsLink 列表。

string

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

string

必需。父媒体资源的资源名称。示例：“properties/123”

int32

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

string

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

KeyEvent

请求的按键事件

string

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

string

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

int32

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

string

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

MeasurementProtocolSecret

请求中指定的父级数据流的密钥列表。

string

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

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

int32

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

string

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

bool

是否在结果中包含已软删除（即“已移至回收站”）的媒体资源。您可以检查媒体资源，以确定它们是否已被删除。

Property

与过滤条件匹配且可供调用方访问的结果。

string

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

string

仅限输出。此 Secret 的资源名称。此 Secret 可以是任何类型的串流的子级。格式：properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

string

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

string

仅限输出。Measurement Protocol 密钥值。将命中数据发送到此密钥的父级媒体资源时，将此值传递给 Measurement Protocol API 的 api_secret 字段。

int64

整数值

double

DoubleValue

string

仅限输出。此媒体资源的资源名称。格式：properties/{property_id} 示例：“properties/1000”

PropertyType

不可变。此媒体资源的媒体资源类型。创建媒体资源时，如果类型为“PROPERTY_TYPE_UNSPECIFIED”，则系统会隐式使用“ORDINARY_PROPERTY”。

Timestamp

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

Timestamp

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

string

不可变。此媒体资源的逻辑父项的资源名称。

注意：您可以使用“移动媒体资源”界面更改父级。格式：accounts/{account}、properties/{property}。示例：“accounts/100”“properties/101”

string

必需。此媒体资源的直观易懂的显示名称。

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

IndustryCategory

与此媒体资源相关联的行业。示例：AUTOMOTIVE、FOOD_AND_DRINK

string

必需。报告时区，用于确定报告的每日起止时间（无论数据来自何处）。如果时区使用夏时制，Google Analytics 会根据相应的变化自动做出调整。

注意：更改时区只会影响未来的数据，不会影响以前的数据。

格式：https://www.iana.org/time-zones 示例：“America/Los_Angeles”

string

涉及货币值的报告中使用的币种类型。

格式：https://en.wikipedia.org/wiki/ISO_4217 示例：“USD”“EUR”“JPY”

ServiceLevel

仅限输出。适用于此媒体资源的 Google Analytics 服务等级。

Timestamp

仅限输出。如果已设置，则表示此媒体资源被移至回收站的时间。如果未设置，则表示此媒体资源目前不在回收站中。

Timestamp

仅限输出。如果设置，则表示系统永久删除此已回收的媒体资源的时间。如果未设置，则表示此媒体资源目前不在回收站中，并且未安排删除。

string

不可变。父级账号的资源名称。格式：accounts/{account_id}。示例：“accounts/123”

string

此房源摘要中提及的房源的资源名称。格式：properties/{property_id}。示例：“properties/1000”

string

此媒体资源摘要中提及的媒体资源的显示名称。

PropertyType

媒体资源的媒体资源类型。

string

此媒体资源的逻辑父项的资源名称。

注意：您可以使用“移动媒体资源”界面更改父级。格式：accounts/{account}、properties/{property}。示例：“accounts/100”“properties/200”

Account

要创建的账号。

string

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

string

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

string

数据访问权限报告支持在媒体资源级别或账号级别进行请求。如果在账号一级请求，数据访问报告将包含对该账号下所有媒体资源的所有访问权限。

如需在媒体资源一级进行请求，实体应为“properties/123”，其中“123”是您的 Google Analytics 媒体资源 ID。如需在账号一级进行请求，实体应为“accounts/1234”，其中“1234”是您的 Google Analytics 账号 ID。

AccessDimension

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

AccessMetric

请求并在响应中显示的指标。请求最多可包含 10 个指标。

AccessDateRange

要读取的访问记录的日期范围。如果请求多个日期范围，则每个响应行都将包含从零开始的日期范围编号。如果两个日期范围有重叠，则重叠天数的访问记录会包含在两个日期范围的响应行中。请求最多可包含 2 个日期范围。

AccessFilterExpression

借助维度过滤条件，您可以将报告响应限制为与过滤条件匹配的特定维度值。例如，按单个用户的访问记录进行过滤。如需了解详情，请参阅维度过滤条件基础知识，查看相关示例。此过滤条件不支持使用指标。

AccessFilterExpression

借助指标过滤条件，您可以将报告响应限制为与过滤条件匹配的特定指标值。指标过滤条件会在汇总报告行后应用，类似于 SQL 中的 having 子句。此过滤条件中无法使用维度。

int64

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

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

int64

要返回的行数。如果未指定，则返回 10,000 行。无论您请求多少行，该 API 每个请求最多只会返回 10 万行。limit 必须为正数。

如果剩余行数不等于 limit，则 API 返回的行数可能会少于请求的 limit。例如，维度 country 的可取值少于 300 个，因此，如果仅针对 country 生成报告，则即使您将 limit 设置为更大的值，也无法获得超过 300 行的报告。

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

string

此请求的时区（如果指定）。如果未指定，则使用媒体资源的时区。请求的时区用于解读报告的开始日期和结束日期。

格式为 IANA 时区数据库 (https://www.iana.org/time-zones) 中的字符串；例如“America/New_York”或“Asia/Tokyo”。

AccessOrderBy

指定响应中各行的排序方式。

bool

切换是否返回此 Google Analytics 媒体资源配额的当前状态。配额会在 AccessQuota 中返回。对于账号级请求，此字段必须为 false。

bool

可选。确定是否在响应中包含从未进行过 API 调用的用户。如果为 true，则响应中会包含对指定媒体资源或账号拥有访问权限的所有用户，无论他们是否已发出 API 调用。如果为 false，则仅包含已发出 API 调用的用户。

bool

可选。决定是否返回用户群组中的用户。只有在 include_all_users 设置为 true 时，此字段才有效。如果为 true，则会返回对指定媒体资源或账号拥有访问权限的所有用户。如果为 false，则仅会返回具有直接访问权限的用户。

AccessDimensionHeader

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

AccessMetricHeader

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

AccessRow

报告中包含维度值组合和指标值的行。

int32

查询结果中的总行数。rowCount 与响应中返回的行数、limit 请求参数和 offset 请求参数无关。例如，如果某个查询返回 175 行，并且在 API 请求中包含 limit（50），则响应将包含 rowCount（175），但只有 50 行。

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

AccessQuota

此 Google Analytics 媒体资源（包括此请求）的配额状态。此字段不适用于账号级请求。

string

必需。要为其返回更改历史记录资源的账号资源。格式：accounts/{account}

示例：accounts/100

string

可选。子媒体资源的资源名称。如果设置，则仅返回对此媒体资源或其子资源所做的更改。格式：properties/{propertyId}

示例：properties/100

ChangeHistoryResourceType

可选。如果设置，则仅返回与至少一种类型匹配的资源的更改。

ActionType

可选。如果设置了此参数，则仅返回与其中一个或多个操作类型匹配的更改。

string

可选。如果设置了此属性，则仅在更改由此列表中的用户进行时返回更改。

Timestamp

可选。如果设置了此参数，则只会返回在此时间（包括此时间）之后所做的更改。

Timestamp

可选。如果设置了此属性，则只会返回在此时间（包括此时间）之前所做的更改。

int32

可选。要返回的 ChangeHistoryEvent 项的数量上限。如果未指定，则最多返回 50 项。最大值为 200（更高的值将被强制转换为最大值）。

请注意，服务返回的页面中包含的项目数量可能少于此值（甚至可能为零），并且可能还有其他页面。如果您想要获取特定数量的项，则需要继续使用 page_token 请求其他页面，直到获取所需数量的项。

string

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

ChangeHistoryEvent

可供调用方访问的结果。

string

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

Account

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

FieldMask

必需。要更新的字段的列表。字段名称必须采用蛇形命名法（例如“field_to_update”）。系统不会更新省略的字段。如需替换整个实体，请使用一个路径并将其设置为字符串“*”，以匹配所有字段。

ConversionEvent

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

FieldMask

必需。要更新的字段的列表。字段名称必须采用蛇形命名法（例如“field_to_update”）。系统不会更新省略的字段。如需替换整个实体，请使用一个路径并将其设置为字符串“*”，以匹配所有字段。

CustomDimension

要更新的自定义维度

FieldMask

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

CustomMetric

要更新的 CustomMetric

FieldMask

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

DataRetentionSettings

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

FieldMask

必需。要更新的字段的列表。字段名称必须采用蛇形命名法（例如“field_to_update”）。系统不会更新省略的字段。如需替换整个实体，请使用一个路径并将其设置为字符串“*”，以匹配所有字段。

DataStream

要更新的 DataStream

FieldMask

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

GoogleAdsLink

要更新的 GoogleAdsLink

FieldMask

必需。要更新的字段的列表。字段名称必须采用蛇形命名法（例如“field_to_update”）。系统不会更新省略的字段。如需替换整个实体，请使用一个路径并将其设置为字符串“*”，以匹配所有字段。

KeyEvent

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

FieldMask

必需。要更新的字段的列表。字段名称必须采用蛇形命名法（例如“field_to_update”）。系统不会更新省略的字段。如需替换整个实体，请使用一个路径并将其设置为字符串“*”，以匹配所有字段。

MeasurementProtocolSecret

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

FieldMask

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

Property

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

FieldMask

必需。要更新的字段的列表。字段名称必须采用蛇形命名法（例如“field_to_update”）。系统不会更新省略的字段。如需替换整个实体，请使用一个路径并将其设置为字符串“*”，以匹配所有字段。