- HTTP 请求
- 路径参数
- 请求正文
- 响应正文
- 授权范围
- DateRange
- 漏斗
- FunnelStep
- FunnelFilterExpression
- FunnelFilterExpressionList
- FunnelFieldFilter
- StringFilter
- MatchType
- InListFilter
- NumericFilter
- 操作
- NumericValue
- BetweenFilter
- FunnelEventFilter
- FunnelParameterFilterExpression
- FunnelParameterFilterExpressionList
- FunnelParameterFilter
- FunnelBreakdown
- 维度
- DimensionExpression
- CaseExpression
- ConcatenateExpression
- FunnelNextAction
- FunnelVisualizationType
- 细分
- UserSegment
- UserSegmentCriteria
- UserSegmentConditionGroup
- UserCriteriaScoping
- SegmentFilterExpression
- SegmentFilterExpressionList
- SegmentFilter
- SegmentFilterScoping
- SegmentEventFilter
- SegmentParameterFilterExpression
- SegmentParameterFilterExpressionList
- SegmentParameterFilter
- SegmentParameterFilterScoping
- UserSegmentSequenceGroup
- UserSequenceStep
- UserSegmentExclusion
- UserExclusionDuration
- SessionSegment
- SessionSegmentCriteria
- SessionSegmentConditionGroup
- SessionCriteriaScoping
- SessionSegmentExclusion
- SessionExclusionDuration
- EventSegment
- EventSegmentCriteria
- EventSegmentConditionGroup
- EventCriteriaScoping
- EventSegmentExclusion
- EventExclusionDuration
- FilterExpression
- FilterExpressionList
- 过滤
- FunnelSubReport
- DimensionHeader
- MetricHeader
- MetricType
- 行
- DimensionValue
- MetricValue
- FunnelResponseMetadata
- SamplingMetadata
- PropertyQuota
- QuotaStatus
- 试试看!
返回 Google Analytics(分析)事件数据的自定义漏斗报告。从 API 返回的数据是一个表格,其中包含所请求的维度和指标的列。
漏斗探索可以直观呈现用户为完成任务而采取的步骤,并让您迅速了解用户在每个步骤上的成功或失败情况。例如,潜在客户是如何一步步提高购买意向并最终出手购买的?一次性买家是如何成为回头客的?根据这些信息,您可以改进低效或被用户放弃的客户转化历程。如需了解详情,请参阅 GA4 漏斗探索。
此方法是在 Alpha 版稳定性阶段推出的,目的是在进入 Beta 版之前收集有关语法和功能的反馈。若要提供有关此 API 的反馈,请填写 Google Analytics(分析)Data API 漏斗报告反馈。
HTTP 请求
POST https://analyticsdata.googleapis.com/v1alpha/{property=properties/*}:runFunnelReport
网址采用 gRPC 转码语法。
路径参数
参数 | |
---|---|
property |
可选。用于跟踪事件的 Google Analytics(分析)GA4 媒体资源标识符。在网址路径(而非正文)中指定。如需了解详情,请参阅如何找到媒体资源 ID。在批量请求中,此属性应不指定或与批次级属性一致。 示例:properties/1234 |
请求正文
请求正文中包含结构如下的数据:
JSON 表示法 |
---|
{ "dateRanges": [ { object ( |
字段 | |
---|---|
dateRanges[] |
可选。要读取的数据的日期范围。如果请求了多个日期范围,则每个响应行都会包含一个从 0 开始的日期范围索引。如果两个日期范围重叠,则重叠日期的事件数据会包含在这两个日期范围的响应行中。 |
funnel |
可选。此请求的漏斗配置。必须选择此漏斗配置。 |
funnelBreakdown |
可选。如果指定,此细分维度会向漏斗表子报告响应添加一个维度。此细分维度会将每个漏斗步骤扩展为细分维度的唯一值。例如,如果按“ |
funnelNextAction |
可选。如果已指定,则下一项操作会向漏斗可视化子报告响应添加一个维度。此“下一步”操作维度会将每个漏斗步骤扩展为下一个操作的唯一值。例如, “下一项”操作仅支持 |
funnelVisualizationType |
可选。漏斗可视化类型用于控制漏斗可视化子报告响应中显示的维度。如果未指定,则系统会使用 |
segments[] |
可选。细分的配置。细分是媒体资源数据的子集。在包含细分的漏斗报告中,每个细分的漏斗都会进行评估。 此请求中指定的每个片段都会在响应中生成单独的一行;在响应中,每个片段都由其名称标识。 “segments”参数是可选的。请求最多只能包含 4 个细分受众群。 |
limit |
可选。要返回的行数。如果未指定,则返回 10,000 行。无论您请求返回多少行,每个请求最多返回 250,000 行。“ 如果维度值没有 |
dimensionFilter |
可选。借助维度过滤条件,您可以只在报告中请求特定的维度值。有关详情,请参阅创建报告:维度过滤条件中的示例。此过滤条件中不能使用指标。 |
returnPropertyQuota |
可选。切换是否返回此 Google Analytics(分析)媒体资源配额的当前状态。配额在 PropertyQuota 中返回。 |
响应正文
漏斗报告响应包含两个子报告。两个子报告是维度和指标的不同组合。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{ "funnelTable": { object ( |
字段 | |
---|---|
funnelTable |
漏斗表格是一份报告,包含漏斗步骤、细分、细分维度、活跃用户数、完成率、放弃率和放弃率。 只有在请求细分时,此响应中才会显示细分维度。细分维度仅在被请求时才会在此响应中显示。 |
funnelVisualization |
漏斗可视化图表是一个包含漏斗步骤、细分、日期、“下一项操作”维度和活跃用户数的报告。 只有在请求细分时,此响应中才会显示细分维度。只有通过 |
propertyQuota |
此 Google Analytics(分析)媒体资源的配额状态,包括此请求。 |
kind |
标识此消息的类型。此 |
授权范围
需要以下 OAuth 范围之一:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
DateRange
一组连续的日期:startDate
、startDate + 1
...、endDate
。最多可以指定 4 个日期范围。
JSON 表示法 |
---|
{ "startDate": string, "endDate": string, "name": string } |
字段 | |
---|---|
startDate |
查询的开始日期,格式为 |
endDate |
查询的结束日期,格式为 |
name |
为此日期范围指定名称。在报告响应中,维度“ |
漏斗图
在漏斗报告请求中配置漏斗。漏斗可报告用户完成一系列步骤的情况。
漏斗探索可以直观呈现用户为完成任务而采取的步骤,并让您迅速了解用户在每个步骤上的成功或失败情况。例如,潜在客户是如何一步步提高购买意向并最终出手购买的?一次性买家是如何成为回头客的?根据这些信息,您可以改进低效或被用户放弃的客户转化历程。
JSON 表示法 |
---|
{
"isOpenFunnel": boolean,
"steps": [
{
object ( |
字段 | |
---|---|
isOpenFunnel |
在开放漏斗中,用户可以在任何步骤进入漏斗;在封闭漏斗中,用户必须在第一个步骤进入漏斗。可选。如果未指定,则使用封闭漏斗。 |
steps[] |
此漏斗的连续步骤。 |
FunnelStep
步骤用于界定您要衡量的用户历程。步骤包含一个或多个条件,用户必须满足这些条件才能被纳入漏斗历程的相应步骤。
JSON 表示法 |
---|
{
"name": string,
"isDirectlyFollowedBy": boolean,
"filterExpression": {
object ( |
字段 | |
---|---|
name |
此步骤的专用名称。如果未指定,系统将以从 1 开始的索引名称为步骤命名(例如“0. ”“1. ”等)。此名称定义了 |
isDirectlyFollowedBy |
如果为 true,此步骤必须直接后跟上一步。如果为 false,则上一步和此步骤之间可能存在事件。如果未指定,则将 |
filterExpression |
用户必须满足哪些条件才能被纳入到漏斗历程的这一步中。 |
withinDurationFromPriorStep |
如果指定,则该步骤必须在前一步完成的这一时长内完成。
时长以秒为单位,最多包含九个小数位,以“ |
FunnelFilterExpression
表示漏斗过滤条件的组合。
JSON 表示法 |
---|
{ // Union field |
字段 | |
---|---|
联合字段 expr 。为 FunnelFilterExpression 指定一种类型的过滤条件。expr 只能是下列其中一项: |
|
andGroup |
|
orGroup |
|
notExpression |
FunnelFilterExpression 不是 |
funnelFieldFilter |
针对维度或指标的漏斗过滤条件。 |
funnelEventFilter |
创建与单个事件名称的事件匹配的过滤条件。如果指定了参数过滤器表达式,则只有与单个事件名称和参数过滤器表达式都匹配的事件子集与此事件过滤器匹配。 |
FunnelFilterExpressionList
漏斗过滤条件表达式列表。
JSON 表示法 |
---|
{
"expressions": [
{
object ( |
字段 | |
---|---|
expressions[] |
漏斗过滤条件表达式列表。 |
FunnelFieldFilter
用于过滤维度或指标值的表达式。
JSON 表示法 |
---|
{ "fieldName": string, // Union field |
字段 | |
---|---|
fieldName |
维度名称或指标名称。 |
联合字段 one_filter 。指定一种类型的过滤条件。one_filter 只能是下列其中一项: |
|
stringFilter |
与字符串相关的过滤条件。 |
inListFilter |
列表值中的过滤器。 |
numericFilter |
数值或日期值的过滤条件。 |
betweenFilter |
两个值之间的过滤器。 |
StringFilter
字符串的过滤器
JSON 表示法 |
---|
{
"matchType": enum ( |
字段 | |
---|---|
matchType |
此过滤器的匹配类型。 |
value |
用于匹配的字符串值。 |
caseSensitive |
如果为 true,字符串值区分大小写。 |
MatchType
字符串过滤条件的匹配类型
枚举 | |
---|---|
MATCH_TYPE_UNSPECIFIED |
未指定 |
EXACT |
与字符串值完全匹配。 |
BEGINS_WITH |
以字符串值开头。 |
ENDS_WITH |
以字符串值结尾。 |
CONTAINS |
包含字符串值。 |
FULL_REGEXP |
与具有字符串值的正则表达式完全匹配。 |
PARTIAL_REGEXP |
与具有字符串值的正则表达式的部分匹配。 |
InListFilter
结果需要在字符串值列表中。
JSON 表示法 |
---|
{ "values": [ string ], "caseSensitive": boolean } |
字段 | |
---|---|
values[] |
字符串值的列表。不得为空。 |
caseSensitive |
如果为 true,字符串值区分大小写。 |
NumericFilter
数字或日期值的过滤条件。
JSON 表示法 |
---|
{ "operation": enum ( |
字段 | |
---|---|
operation |
此过滤器的操作类型。 |
value |
数值或日期值。 |
操作
应用于数字过滤条件的运算
枚举 | |
---|---|
OPERATION_UNSPECIFIED |
未指定。 |
EQUAL |
等于 |
LESS_THAN |
小于 |
LESS_THAN_OR_EQUAL |
小于或等于 |
GREATER_THAN |
大于 |
GREATER_THAN_OR_EQUAL |
大于或等于 |
NumericValue
用于表示数字。
JSON 表示法 |
---|
{ // Union field |
字段 | |
---|---|
联合字段 one_value 。数值 one_value 只能是下列其中一项: |
|
int64Value |
整数值 |
doubleValue |
DoubleValue |
BetweenFilter
表示结果需要介于两个数字(含)之间。
JSON 表示法 |
---|
{ "fromValue": { object ( |
字段 | |
---|---|
fromValue |
以此数字开头。 |
toValue |
以此数字结尾。 |
FunnelEventFilter
创建与单个事件名称的事件匹配的过滤条件。如果指定了参数过滤器表达式,则只有与单个事件名称和参数过滤器表达式都匹配的事件子集与此事件过滤器匹配。
JSON 表示法 |
---|
{
"eventName": string,
"funnelParameterFilterExpression": {
object ( |
字段 | |
---|---|
eventName |
此过滤条件会匹配这个单一事件名称的事件。事件名称为必填项。 |
funnelParameterFilterExpression |
如果指定,此过滤条件会匹配与单个事件名称和参数过滤条件表达式都匹配的事件。 在参数过滤器表达式中,只有参数过滤器可用。 |
FunnelParameterFilterExpression
表示基于参数的漏斗过滤器组合。
JSON 表示法 |
---|
{ // Union field |
字段 | |
---|---|
联合字段 expr 。为 FunnelParameterFilterExpression 指定一种类型的过滤条件。expr 只能是下列其中一项: |
|
andGroup |
|
orGroup |
|
notExpression |
FunnelParameterFilterExpression 不是 |
funnelParameterFilter |
初始漏斗参数过滤器。 |
FunnelParameterFilterExpressionList
漏斗参数过滤条件表达式列表。
JSON 表示法 |
---|
{
"expressions": [
{
object ( |
字段 | |
---|---|
expressions[] |
漏斗参数过滤器表达式列表。 |
FunnelParameterFilter
用于过滤漏斗中参数值的表达式。
JSON 表示法 |
---|
{ // Union field |
字段 | |
---|---|
联合字段 one_parameter 。要过滤的字段。one_parameter 只能是下列其中一项: |
|
eventParameterName |
系统将根据指定的事件参数评估此过滤器。事件参数会记录为事件的参数。事件参数包括“firebase_screen”和“currency”等字段。 事件参数只能在细分和漏斗中使用,并且只能在 EventFilter 的后代过滤器中使用。在 EventFilter 的后代过滤器中,应使用事件或商品参数。 |
itemParameterName |
系统将根据指定的 item 参数评估此过滤器。Item 参数作为参数记录在 item 数组中。Item 参数包括“item_name”和“item_category”等字段。 Item 参数只能在细分和漏斗中使用,并且只能用于 EventFilter 的后代过滤条件。在 EventFilter 的后代过滤器中,应使用事件或商品参数。 商品参数仅适用于电子商务事件。如需详细了解电子商务事件,请参阅衡量电子商务指南。 |
联合字段 one_filter 。指定一种类型的过滤条件。one_filter 只能是下列其中一项: |
|
stringFilter |
与字符串相关的过滤条件。 |
inListFilter |
列表值中的过滤器。 |
numericFilter |
数值或日期值的过滤条件。 |
betweenFilter |
两个值之间的过滤器。 |
FunnelBreakdown
细分功能会向漏斗表子报告响应添加一个维度。
JSON 表示法 |
---|
{
"breakdownDimension": {
object ( |
字段 | |
---|---|
breakdownDimension |
添加到漏斗表子报告响应的维度列。细分维度会细分每个漏斗步骤。如果指定了 |
limit |
要在响应中返回细分维度的不同值数量上限。如果未指定限制,则使用 |
维度
“维度”是指数据的属性。例如,“城市”维度表示的是事件发起城市。报告响应中的维度值是字符串;例如,城市可以是“Paris”或“New York”。
JSON 表示法 |
---|
{
"name": string,
"dimensionExpression": {
object ( |
字段 | |
---|---|
name |
维度的名称。如需查看核心报告方法(例如 如果指定了 维度由 |
dimensionExpression |
一个维度可以是多个维度的表达式的结果。例如,维度“国家/地区, 城市”:concatenate(country, ", ", city)。 |
DimensionExpression
用于表示一个维度,该维度是多重维度的公式结果。用法示例:1)LowerCase(dimension) 2) concatenate(dimension1, characters, dimension2)。
JSON 表示法 |
---|
{ // Union field |
字段 | |
---|---|
联合字段 one_expression 。为 DimensionExpression 指定一种类型的维度表达式。one_expression 只能是下列其中一项: |
|
lowerCase |
用于将维度值转换为小写。 |
upperCase |
用于将尺寸值转换为大写。 |
concatenate |
用于将多个维度值合并为一个维度。例如,维度“国家/地区, 城市”:concatenate(country, ", ", city)。 |
CaseExpression
用于将维度值转换为单个 case。
JSON 表示法 |
---|
{ "dimensionName": string } |
字段 | |
---|---|
dimensionName |
维度名称。该名称必须回指请求的维度字段中的名称。 |
ConcatenateExpression
用于将多个维度值合并为一个维度。
JSON 表示法 |
---|
{ "dimensionNames": [ string ], "delimiter": string } |
字段 | |
---|---|
dimensionNames[] |
维度的名称。这些名称必须回指请求的维度字段中的名称。 |
delimiter |
维度名称之间的分隔符。 分隔符通常是单个字符,例如“|”或“,”,但也可以是较长的字符串。如果某个维度值包含分隔符,则响应中都会包含这两个分隔符,不会区分开来。例如,如果维度 1 的值 =“US,FR”,维度 2 的值 =“JP”,而分隔符 =“,”,则响应将包含“US,FR,JP”。 |
FunnelNextAction
下一项操作说明了用户完成某个步骤之后但该用户尚未完成下一步骤之前的维度值。例如,如果 nextActionDimension
为 eventName
,则第 i
个漏斗步骤行中的 nextActionDimension
将在事件促使用户进入第 i
个漏斗步骤、但该用户完成第 i+1
个漏斗步骤之前返回第一个事件。
JSON 表示法 |
---|
{
"nextActionDimension": {
object ( |
字段 | |
---|---|
nextActionDimension |
添加到漏斗可视化子报告响应的维度列。在用户完成第
|
limit |
要在响应中返回细分维度的不同值数量上限。如果未指定限制,则使用 |
FunnelVisualizationType
控制漏斗可视化子报告响应中显示的维度。
枚举 | |
---|---|
FUNNEL_VISUALIZATION_TYPE_UNSPECIFIED |
未指定类型。 |
STANDARD_FUNNEL |
标准(阶梯)漏斗。响应中的漏斗可视化子报告不会包含日期。 |
TRENDED_FUNNEL |
呈现出趋势(折线图)的漏斗。响应中的漏斗可视化子报告将包含日期维度。 |
片段
“细分”是指您的一部分 Google Analytics(分析)数据。例如,在您的整个用户群中,您可使用一个细分来指定来自特定国家/地区或城市的用户,您还可以使用另一个细分来指定购买特定产品系列、访问网站上特定部分或触发应用中某些事件的用户。
如需了解详情,请参阅 GA4 细分生成工具。
JSON 表示法 |
---|
{ "name": string, // Union field |
字段 | |
---|---|
name |
此细分的名称。如果未指定,细分将命名为“细分”。此名称定义了 |
联合字段 one_segment_scope 。在一个范围中指定一个细分。one_segment_scope 只能是下列其中一项: |
|
userSegment |
细分用户群是指与您的网站或应用互动过的用户子集。 |
sessionSegment |
会话细分是在您的网站或应用上发生的会话的子集。 |
eventSegment |
事件细分是在您的网站或应用上触发的部分事件。 |
UserSegment
用户细分是指与您的网站或应用互动过的用户子集。例如,之前购买过商品的用户;已将商品添加至购物车但未完成购买的用户。
JSON 表示法 |
---|
{ "userInclusionCriteria": { object ( |
字段 | |
---|---|
userInclusionCriteria |
定义此细分中包含哪些用户。可选。 |
exclusion |
定义此细分中排除哪些用户。可选。 |
UserSegmentCriteria
如果用户的事件满足条件中的条件,则用户与条件匹配。
JSON 表示法 |
---|
{ "andConditionGroups": [ { object ( |
字段 | |
---|---|
andConditionGroups[] |
如果用户与这些 |
andSequenceGroups[] |
如果用户与这些 |
UserSegmentConditionGroup
条件用于指示 Google Analytics(分析)要在细分中包含或排除哪些数据。
JSON 表示法 |
---|
{ "conditionScoping": enum ( |
字段 | |
---|---|
conditionScoping |
系统会根据数据是否与条件组匹配来在细分中包含或排除数据。此范围限定了在确定条件组是否匹配之前,评估 可选。如果未指定,则系统会使用 |
segmentFilterExpression |
系统会根据数据是否与此表达式匹配来在细分中包含或排除数据。表达式表示维度、指标和/或参数的条件。 |
UserCriteriaScoping
设定范围可指定在评估用户是否满足某个条件时要考虑哪些事件。
枚举 | |
---|---|
USER_CRITERIA_SCOPING_UNSPECIFIED |
未指定条件范围。未指定。 |
USER_CRITERIA_WITHIN_SAME_EVENT |
如果某个事件内满足条件,则用户也符合该条件。 |
USER_CRITERIA_WITHIN_SAME_SESSION |
如果在一次会话中满足条件,则用户也符合该条件。 |
USER_CRITERIA_ACROSS_ALL_SESSIONS |
如果用户有事件满足了条件,则用户与该条件匹配。 |
SegmentFilterExpression
表示细分过滤条件的组合。
JSON 表示法 |
---|
{ // Union field |
字段 | |
---|---|
联合字段 expr 。为 SegmentFilterExpression 指定一种类型的过滤条件。expr 只能是下列其中一项: |
|
andGroup |
|
orGroup |
|
notExpression |
SegmentFilterExpression 不是 |
segmentFilter |
基元细分过滤器。 |
segmentEventFilter |
创建与单个事件名称的事件匹配的过滤条件。如果指定了参数过滤器表达式,则只有与单个事件名称和参数过滤器表达式都匹配的事件子集与此事件过滤器匹配。 |
SegmentFilterExpressionList
细分过滤器表达式列表。
JSON 表示法 |
---|
{
"expressions": [
{
object ( |
字段 | |
---|---|
expressions[] |
细分过滤器表达式列表 |
SegmentFilter
用于过滤维度或指标值的表达式。
JSON 表示法 |
---|
{ "fieldName": string, "filterScoping": { object ( |
字段 | |
---|---|
fieldName |
维度名称或指标名称。 |
filterScoping |
指定过滤器的范围。 |
联合字段 one_filter 。为 Filter 指定一种类型的过滤条件。one_filter 只能是下列其中一项: |
|
stringFilter |
与字符串相关的过滤条件。 |
inListFilter |
列表值中的过滤器。 |
numericFilter |
数值或日期值的过滤条件。 |
betweenFilter |
两个值之间的过滤器。 |
SegmentFilterScoping
范围指定在评估细分过滤器时应如何考虑多个事件的维度和指标。
JSON 表示法 |
---|
{ "atAnyPointInTime": boolean } |
字段 | |
---|---|
atAnyPointInTime |
如果 此 只有在条件范围为“ 如果条件范围为 |
SegmentEventFilter
创建与单个事件名称的事件匹配的过滤条件。如果指定了参数过滤器表达式,则只有与单个事件名称和参数过滤器表达式都匹配的事件子集与此事件过滤器匹配。
JSON 表示法 |
---|
{
"eventName": string,
"segmentParameterFilterExpression": {
object ( |
字段 | |
---|---|
eventName |
此过滤条件会匹配这个单一事件名称的事件。事件名称为必填项。 |
segmentParameterFilterExpression |
如果指定,此过滤条件会匹配与单个事件名称和参数过滤条件表达式都匹配的事件。 在参数过滤器表达式中,只有参数过滤器可用。 |
SegmentParameterFilterExpression
表示基于参数的细分过滤器组合。
JSON 表示法 |
---|
{ // Union field |
字段 | |
---|---|
联合字段 expr 。为 SegmentParameterFilterExpression 指定一种类型的过滤条件。expr 只能是下列其中一项: |
|
andGroup |
|
orGroup |
|
notExpression |
SegmentParameterFilterExpression 不是 |
segmentParameterFilter |
基元细分参数过滤器。 |
SegmentParameterFilterExpressionList
细分参数过滤器表达式列表。
JSON 表示法 |
---|
{
"expressions": [
{
object ( |
字段 | |
---|---|
expressions[] |
细分参数过滤器表达式列表。 |
SegmentParameterFilter
用于过滤细分中的参数值的表达式。
JSON 表示法 |
---|
{ "filterScoping": { object ( |
字段 | |
---|---|
filterScoping |
指定过滤器的范围。 |
联合字段 one_parameter 。要过滤的字段。one_parameter 只能是下列其中一项: |
|
eventParameterName |
系统将根据指定的事件参数评估此过滤器。事件参数会记录为事件的参数。事件参数包括“firebase_screen”和“currency”等字段。 事件参数只能在细分和漏斗中使用,并且只能在 EventFilter 的后代过滤器中使用。在 EventFilter 的后代过滤器中,应使用事件或商品参数。 |
itemParameterName |
系统将根据指定的 item 参数评估此过滤器。Item 参数作为参数记录在 item 数组中。Item 参数包括“item_name”和“item_category”等字段。 Item 参数只能在细分和漏斗中使用,并且只能用于 EventFilter 的后代过滤条件。在 EventFilter 的后代过滤器中,应使用事件或商品参数。 商品参数仅适用于电子商务事件。如需详细了解电子商务事件,请参阅衡量电子商务指南。 |
联合字段 one_filter 。指定一种类型的过滤条件。one_filter 只能是下列其中一项: |
|
stringFilter |
与字符串相关的过滤条件。 |
inListFilter |
列表值中的过滤器。 |
numericFilter |
数值或日期值的过滤条件。 |
betweenFilter |
两个值之间的过滤器。 |
SegmentParameterFilterScoping
范围指定在评估细分参数过滤器时应如何考虑多个事件。
JSON 表示法 |
---|
{ "inAnyNDayPeriod": string } |
字段 | |
---|---|
inAnyNDayPeriod |
在应用过滤器之前,先在指定天数内累积参数。仅当条件范围为 例如,如果 我们并不是为了将日期范围的开始日期延长整整 N 天,而对日期范围进行扩展。例如,如果报告的时间范围为 2021 年 11 月 1 日至 2021 年 11 月 10 日,且
|
UserSegmentSequenceGroup
定义要成为细分受众群成员的用户,必须按特定顺序出现的条件。
JSON 表示法 |
---|
{ "sequenceScoping": enum ( |
字段 | |
---|---|
sequenceScoping |
范围中必须满足所有序列步骤,用户才能与序列相匹配。例如,如果为 可选。如果未指定,则系统会使用 |
sequenceMaximumDuration |
定义整个序列必须在多长时间内完成;例如,30 分钟。
时长以秒为单位,最多包含九个小数位,以“ |
userSequenceSteps[] |
条件步骤的有序序列。用户的事件必须完成每个步骤,才能匹配 |
UserSequenceStep
与序列匹配的指定步骤顺序中必须发生的条件。
JSON 表示法 |
---|
{ "isDirectlyFollowedBy": boolean, "stepScoping": enum ( |
字段 | |
---|---|
isDirectlyFollowedBy |
如果为 true,则满足此步骤的事件必须是符合最后一步的事件之后的下一个事件。如果为 false,此步骤将间接后跟前一步;例如,前一步和此步骤之间可能存在事件。第一步的 |
stepScoping |
范围中必须满足此序列步骤,用户才能与序列相匹配。例如,如果为 可选。如果未指定, |
segmentFilterExpression |
如果用户的事件与此表达式匹配,则用户与此序列步骤匹配。表达式表示维度、指标和/或参数的条件。 |
UserSegmentExclusion
指定在此细分中排除哪些用户。
JSON 表示法 |
---|
{ "userExclusionDuration": enum ( |
字段 | |
---|---|
userExclusionDuration |
指定当用户与 可选。如果未指定,则系统会使用 |
userExclusionCriteria |
如果用户满足此条件,就会从 |
UserExclusionDuration
枚举与 userExclusionCriteria
匹配时排除将持续有效时长的选项。
枚举 | |
---|---|
USER_EXCLUSION_DURATION_UNSPECIFIED |
排除时长未指定。未指定。 |
USER_EXCLUSION_TEMPORARY |
在用户满足 userExclusionCriteria 条件的时段内暂时从细分受众群中排除用户。 |
USER_EXCLUSION_PERMANENT |
如果用户曾满足 userExclusionCriteria 条件,则从细分受众群中永久排除用户。 |
SessionSegment
会话细分是在您的网站或应用上发生的一部分会话,例如:源自特定广告系列的所有会话。
JSON 表示法 |
---|
{ "sessionInclusionCriteria": { object ( |
字段 | |
---|---|
sessionInclusionCriteria |
定义此细分中包含哪些会话。可选。 |
exclusion |
定义此细分中排除哪些会话。可选。 |
SessionSegmentCriteria
如果会话的事件满足条件中的条件,则会话符合条件。
JSON 表示法 |
---|
{
"andConditionGroups": [
{
object ( |
字段 | |
---|---|
andConditionGroups[] |
如果会话符合以下每个 |
SessionSegmentConditionGroup
条件用于指示 Google Analytics(分析)要在细分中包含或排除哪些数据。
JSON 表示法 |
---|
{ "conditionScoping": enum ( |
字段 | |
---|---|
conditionScoping |
系统会根据数据是否与条件组匹配来在细分中包含或排除数据。此范围限定了在确定条件组是否匹配之前,评估 可选。如果未指定,则使用 |
segmentFilterExpression |
系统会根据数据是否与此表达式匹配来在细分中包含或排除数据。表达式表示维度、指标和/或参数的条件。 |
SessionCriteriaScoping
界定范围可指定在评估会话是否符合条件时要考虑哪些事件。
枚举 | |
---|---|
SESSION_CRITERIA_SCOPING_UNSPECIFIED |
未指定条件范围。未指定。 |
SESSION_CRITERIA_WITHIN_SAME_EVENT |
如果某个事件满足条件,会话就符合条件。 |
SESSION_CRITERIA_WITHIN_SAME_SESSION |
如果在一次会话中满足条件,会话就符合条件。 |
SessionSegmentExclusion
指定此细分中排除哪些会话。
JSON 表示法 |
---|
{ "sessionExclusionDuration": enum ( |
字段 | |
---|---|
sessionExclusionDuration |
指定会话与 可选。如果未指定,则使用 |
sessionExclusionCriteria |
如果某个会话满足此条件,则该会话会从 |
SessionExclusionDuration
枚举当会话与 sessionExclusionCriteria
匹配时排除将持续的时长的选项。
枚举 | |
---|---|
SESSION_EXCLUSION_DURATION_UNSPECIFIED |
排除时长未指定。未指定。 |
SESSION_EXCLUSION_TEMPORARY |
在会话满足 sessionExclusionCriteria 条件期间暂时从细分中排除会话。 |
SESSION_EXCLUSION_PERMANENT |
如果会话曾满足 sessionExclusionCriteria 条件,则永久排除该细分中的会话。 |
EventSegment
事件细分是在您的网站或应用上触发的一部分事件。例如,在特定位置发生的所有购买事件;在特定操作系统上发生的 app_exception 事件。
JSON 表示法 |
---|
{ "eventInclusionCriteria": { object ( |
字段 | |
---|---|
eventInclusionCriteria |
定义此细分中包含哪些事件。可选。 |
exclusion |
定义此细分中排除的事件。可选。 |
EventSegmentCriteria
如果事件满足条件中的条件,则事件与条件匹配。
JSON 表示法 |
---|
{
"andConditionGroups": [
{
object ( |
字段 | |
---|---|
andConditionGroups[] |
如果事件与以下每个 |
EventSegmentConditionGroup
条件用于指示 Google Analytics(分析)要在细分中包含或排除哪些数据。
JSON 表示法 |
---|
{ "conditionScoping": enum ( |
字段 | |
---|---|
conditionScoping |
可选。如果未指定,则使用 |
segmentFilterExpression |
系统会根据数据是否与此表达式匹配来在细分中包含或排除数据。表达式表示维度、指标和/或参数的条件。 |
EventCriteriaScoping
设定范围可指定在评估事件是否符合条件时要考虑哪些事件。
枚举 | |
---|---|
EVENT_CRITERIA_SCOPING_UNSPECIFIED |
未指定条件范围。未指定。 |
EVENT_CRITERIA_WITHIN_SAME_EVENT |
如果事件在一个事件中满足了条件,则该事件也符合该条件。 |
EventSegmentExclusion
指定此细分中排除哪些事件。
JSON 表示法 |
---|
{ "eventExclusionDuration": enum ( |
字段 | |
---|---|
eventExclusionDuration |
可选。如果未指定,则使用 |
eventExclusionCriteria |
如果某个事件满足此条件,则该事件会从 |
EventExclusionDuration
枚举相关选项,说明当某个事件与 eventExclusionCriteria
匹配时排除项的持续时间。
枚举 | |
---|---|
EVENT_EXCLUSION_DURATION_UNSPECIFIED |
排除时长未指定。未指定。 |
EVENT_EXCLUSION_PERMANENT |
如果事件曾满足 eventExclusionCriteria 条件,则从细分中永久排除相应事件。 |
FilterExpression
用来表示维度或指标过滤条件。同一个 FilterExpression 中的字段必须是所有维度或所有指标。
JSON 表示法 |
---|
{ // Union field |
字段 | |
---|---|
联合字段 expr 。为 FilterExpression 指定一种类型的过滤条件表达式。expr 只能是下列其中一项: |
|
andGroup |
andGroup 中的 FilterExpression 具有 AND 关系。 |
orGroup |
orGroup 中的 FilterExpression 具有 OR 关系。 |
notExpression |
FilterExpression 不是 notExpression 。 |
filter |
原初过滤器。在同一 FilterExpression 中,过滤器的所有字段名称都需要是全部维度或全部指标。 |
FilterExpressionList
过滤器表达式列表。
JSON 表示法 |
---|
{
"expressions": [
{
object ( |
字段 | |
---|---|
expressions[] |
过滤器表达式列表。 |
过滤
用于过滤维度或指标值的表达式。
JSON 表示法 |
---|
{ "fieldName": string, // Union field |
字段 | |
---|---|
fieldName |
维度名称或指标名称。必须是在维度或指标中定义的名称。 |
联合字段 one_filter 。为 Filter 指定一种类型的过滤条件。one_filter 只能是下列其中一项: |
|
stringFilter |
与字符串相关的过滤条件。 |
inListFilter |
列表值中的过滤器。 |
numericFilter |
数值或日期值的过滤条件。 |
betweenFilter |
两个值之间的过滤器。 |
FunnelSubReport
漏斗子报告包含维度和指标数据值。例如,有 12 位用户到达了漏斗的第二个步骤。
JSON 表示法 |
---|
{ "dimensionHeaders": [ { object ( |
字段 | |
---|---|
dimensionHeaders[] |
描述维度列。漏斗报告始终会在子报告响应中包含漏斗步骤维度。如果请求,响应中可能会包含细分、日期和后续操作等其他维度。 |
metricHeaders[] |
描述指标列。漏斗报告在子报告响应中始终包含活跃用户。漏斗表包含完成率、放弃率和放弃率等其他指标。 |
rows[] |
报告中的维度值组合和指标值行。 |
metadata |
漏斗报告的元数据。 |
DimensionHeader
描述报告中的维度列。报告中请求的维度会在行和 DimensionHeader 中生成列条目。不过,专门用在过滤条件或表达式中的维度不会在报告中显示列,相应维度也不会生成标题。
JSON 表示法 |
---|
{ "name": string } |
字段 | |
---|---|
name |
维度的名称。 |
MetricHeader
描述报告中的指标列。报告中请求的可见指标会在行和 MetricHeaders 中生成列条目。然而,专门用于过滤器或表达式的指标不会在报告中生成列;相应地,这些指标也不会生成标题。
JSON 表示法 |
---|
{
"name": string,
"type": enum ( |
字段 | |
---|---|
name |
指标的名称。 |
type |
指标的数据类型。 |
MetricType
指标的值类型。
枚举 | |
---|---|
METRIC_TYPE_UNSPECIFIED |
未指定类型。 |
TYPE_INTEGER |
整数类型。 |
TYPE_FLOAT |
浮点类型。 |
TYPE_SECONDS |
以秒为单位的持续时间;一种特殊的浮点类型。 |
TYPE_MILLISECONDS |
持续时间(以毫秒为单位);一种特殊的浮点类型。 |
TYPE_MINUTES |
持续时间(以分钟为单位);一种特殊的浮点类型。 |
TYPE_HOURS |
时长(以小时为单位);一种特殊的浮点类型。 |
TYPE_STANDARD |
标准类型的自定义指标;一种特殊的浮点类型。 |
TYPE_CURRENCY |
金额;一种特殊的浮点类型。 |
TYPE_FEET |
以英尺为单位的长度;一种特殊的浮点类型。 |
TYPE_MILES |
以英里为单位的长度;一种特殊的浮点类型。 |
TYPE_METERS |
长度(以米为单位);一种特殊的浮点类型。 |
TYPE_KILOMETERS |
以公里为单位的长度;一种特殊的浮点类型。 |
行
每行的报告数据。例如,如果 RunReportRequest 包含:
"dimensions": [
{
"name": "eventName"
},
{
"name": "countryId"
}
],
"metrics": [
{
"name": "eventCount"
}
]
以“in_app_purchase”为 eventName、“JP”为“countryId”和“eventCount”为 15 的行如下:
"dimensionValues": [
{
"value": "in_app_purchase"
},
{
"value": "JP"
}
],
"metricValues": [
{
"value": "15"
}
]
JSON 表示法 |
---|
{ "dimensionValues": [ { object ( |
字段 | |
---|---|
dimensionValues[] |
所请求维度值的列表。在 PivotReport 中,仅列出数据透视中包含的维度的 dimensionValues。 |
metricValues[] |
所请求的可见指标值的列表。 |
DimensionValue
维度的值。
JSON 表示法 |
---|
{ // Union field |
字段 | |
---|---|
联合字段 one_value 。一种维度值 one_value 只能是下列其中一项: |
|
value |
如果维度类型是字符串,则为字符串。 |
MetricValue
指标的值。
JSON 表示法 |
---|
{ // Union field |
字段 | |
---|---|
联合字段 one_value 。指标值“one_value ”只能是下列其中一项: |
|
value |
测量值。如需了解类型,请参阅 MetricHeader 。 |
FunnelResponseMetadata
漏斗报告的响应元数据包含有关漏斗报告的更多信息。
JSON 表示法 |
---|
{
"samplingMetadatas": [
{
object ( |
字段 | |
---|---|
samplingMetadatas[] |
如果对漏斗报告结果进行抽样,则表示此漏斗报告中所用事件所占的百分比。系统会为每个日期范围填充一个 但是,如果未对结果进行抽样,则不会定义此字段。 |
SamplingMetadata
如果对漏斗报告结果进行抽样,此元数据将说明此漏斗报告中在某一日期范围内使用的事件所占的百分比。抽样是指通过分析所有数据的一部分,从较大数据集中发掘有意义的信息的做法。
JSON 表示法 |
---|
{ "samplesReadCount": string, "samplingSpaceSize": string } |
字段 | |
---|---|
samplesReadCount |
在此抽样报告中读取的事件总数。这是指在此漏斗报告中分析此媒体资源的数据子集的大小。 |
samplingSpaceSize |
此媒体资源的数据中可在某个日期范围内在此漏斗报告中分析的事件总数。抽样可以揭示关于较大数据集的有意义信息,而这些信息也就比较大的数据集规模。 若要计算此漏斗报告中所用数据的百分比,请计算 |
PropertyQuota
此 Google Analytics(分析)媒体资源的所有配额的当前状态。如果媒体资源的任何配额已用尽,对该媒体资源的所有请求都将返回“资源已用尽”错误。
JSON 表示法 |
---|
{ "tokensPerDay": { object ( |
字段 | |
---|---|
tokensPerDay |
标准 Google Analytics(分析)媒体资源每天最多可使用 20 万个令牌;Analytics 360 媒体资源每天最多可使用 200 万个令牌。大部分请求消耗的令牌数都少于 10 个。 |
tokensPerHour |
标准 Google Analytics(分析)媒体资源每小时最多可使用 40,000 个令牌;Analytics 360 媒体资源每小时可使用 40 万个令牌。一个 API 请求消耗单个数量的令牌,系统会从每小时、每日和每个项目每小时的所有配额中扣减相应数量。 |
concurrentRequests |
标准 Google Analytics(分析)媒体资源最多可以发送 10 个并发请求;Analytics 360 媒体资源最多可以使用 50 个并发请求。 |
serverErrorsPerProjectPerHour |
标准 Google Analytics(分析)媒体资源和云项目对每小时最多可以有 10 个服务器错误;Analytics 360 媒体资源和云项目对每小时最多可以有 50 个服务器错误。 |
potentiallyThresholdedRequestsPerHour |
Google Analytics(分析)媒体资源每小时最多可以发送 120 个维度可能受到限制的请求。在批量请求中,如果每个报告请求包含的维度可能受到限制,则系统会单独将此配额计入该配额。 |
tokensPerProjectPerHour |
Google Analytics(分析)媒体资源每小时每个项目最多可使用 35% 的令牌。标准 Google Analytics(分析)媒体资源每小时可使用的令牌数量上限为 14,000 个,Analytics 360 媒体资源每小时每个项目可使用的令牌数为 140,000 个。一个 API 请求消耗单个数量的令牌,系统会从每小时、每日和每个项目每小时的所有配额中扣减相应数量。 |
QuotaStatus
特定配额组的当前状态。
JSON 表示法 |
---|
{ "consumed": integer, "remaining": integer } |
字段 | |
---|---|
consumed |
此请求占用的配额。 |
remaining |
完成此请求后剩余的配额。 |