- HTTP 请求
- 路径参数
- 请求正文
- 响应正文
- 授权范围
- 漏斗
- FunnelStep
- FunnelFilterExpression
- FunnelFilterExpressionList
- FunnelFieldFilter
- FunnelEventFilter
- FunnelParameterFilterExpression
- FunnelParameterFilterExpressionList
- FunnelParameterFilter
- FunnelBreakdown
- FunnelNextAction
- FunnelVisualizationType
- 细分
- UserSegment
- UserSegmentCriteria
- UserSegmentConditionGroup
- UserCriteriaScoping
- SegmentFilterExpression
- SegmentFilterExpressionList
- SegmentFilter
- SegmentFilterScoping
- SegmentEventFilter
- SegmentParameterFilterExpression
- SegmentParameterFilterExpressionList
- SegmentParameterFilter
- SegmentParameterFilterScoping
- UserSegmentSequenceGroup
- UserSequenceStep
- UserSegmentExclusion
- UserExclusionDuration
- SessionSegment
- SessionSegmentCriteria
- SessionSegmentConditionGroup
- SessionCriteriaScoping
- SessionSegmentExcludeSessionSegmentExclusion
- SessionExclusionDuration
- EventSegment
- EventSegmentCriteria
- EventSegmentConditionGroup
- EventCriteriaScoping
- EventSegmentExclusion
- EventExclusionDuration
- FunnelSubReport
- 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[] |
可选。要读取的数据的日期范围。如果请求了多个日期范围,则每个响应行都会包含一个从零开始的日期范围索引。如果两个日期范围重叠,则重叠日期的事件数据会包含在两个日期范围的响应行中。 |
funnel |
可选。此请求的漏斗配置。此漏斗配置是必需的。 |
funnelBreakdown |
可选。如果指定,此细分维度会向漏斗表子报告响应添加一个维度。此细分维度会将每个漏斗步骤展开为细分维度的唯一值。例如,如果按“ |
funnelNextAction |
可选。如果指定,“下一项”操作会向漏斗可视化子报告响应添加一个维度。此“下一个操作”维度会将每个漏斗步骤展开为下一个操作的唯一值。例如,“ “下一项”操作仅支持 |
funnelVisualizationType |
可选。漏斗可视化图表类型用于控制漏斗可视化图表子报告响应中显示的维度。如果未指定,则系统会使用 |
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
漏斗图
配置漏斗报告请求中的漏斗。漏斗可报告用户完成一系列步骤的情况。
漏斗探索可以直观呈现用户为完成任务而采取的步骤,并让您迅速了解用户在每个步骤上的成功或失败情况。例如,潜在客户是如何一步步提高购买意向并最终出手购买的?一次性买家是如何成为回头客的?根据这些信息,您可以改进低效或被用户放弃的客户转化历程。
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 |
两个值之间的过滤条件。 |
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_name”和“item_category”等字段。 商品参数只能在细分和漏斗中使用,只能用于 EventFilter 的后代过滤器。在 EventFilter 的后代过滤器中,应使用事件或商品参数。 商品参数仅适用于电子商务事件。如需详细了解电子商务事件,请参阅衡量电子商务指南。 |
联合字段 one_filter 。指定一种过滤条件。one_filter 只能是下列其中一项: |
|
stringFilter |
字符串相关过滤条件。 |
inListFilter |
列表值中的过滤器。 |
numericFilter |
数字或日期值的过滤条件。 |
betweenFilter |
两个值之间的过滤条件。 |
FunnelBreakdown
细分维度会向漏斗表格子报告响应中添加维度。
JSON 表示法 |
---|
{
"breakdownDimension": {
object ( |
字段 | |
---|---|
breakdownDimension |
添加到漏斗表子报告响应的维度列。细分维度对每个漏斗步骤进行了细分。如果指定了 |
limit |
要在响应中返回的细分维度不同值的数量上限。如果未指定限制,则使用 |
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_name”和“item_category”等字段。 商品参数只能在细分和漏斗中使用,只能用于 EventFilter 的后代过滤器。在 EventFilter 的后代过滤器中,应使用事件或商品参数。 商品参数仅适用于电子商务事件。如需详细了解电子商务事件,请参阅衡量电子商务指南。 |
联合字段 one_filter 。指定一种过滤条件。one_filter 只能是下列其中一项: |
|
stringFilter |
字符串相关过滤条件。 |
inListFilter |
列表值中的过滤器。 |
numericFilter |
数字或日期值的过滤条件。 |
betweenFilter |
两个值之间的过滤条件。 |
SegmentParameterFilterScoping
范围限定了在评估细分参数过滤器时应如何考虑多个事件。
JSON 表示法 |
---|
{ "inAnyNDayPeriod": string } |
字段 | |
---|---|
inAnyNDayPeriod |
在应用过滤器之前,在指定天数内累计参数。仅当条件范围为 例如,如果“ 我们不会为了在开始日期附近有整整 N 天这一时段而延长日期范围。例如,如果报告的时间范围是 2021-11-01 至 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 条件的事件。 |
FunnelSubReport
漏斗子报告包含维度和指标数据值。例如,有 12 位用户到达了漏斗的第二步。
JSON 表示法 |
---|
{ "dimensionHeaders": [ { object ( |
字段 | |
---|---|
dimensionHeaders[] |
描述维度列。漏斗报告始终会在子报告响应中包含漏斗步骤维度。如果收到请求,响应中可能会包含其他维度,例如细分、日期和后续操作。 |
metricHeaders[] |
说明指标列。漏斗报告在子报告响应中始终包含活跃用户。漏斗表中还包含其他指标,例如完成率、放弃率和放弃率。 |
rows[] |
报告中维度值组合和指标值的行。 |
metadata |
漏斗报告的元数据。 |
FunnelResponseMetadata
漏斗报告的响应元数据包含关于漏斗报告的更多信息。
JSON 表示法 |
---|
{
"samplingMetadatas": [
{
object ( |
字段 | |
---|---|
samplingMetadatas[] |
如果漏斗报告结果是抽样,则表示此漏斗报告中使用的事件所占的百分比。系统会为每个日期范围填充一个 但是,如果未对结果进行抽样,则不会定义此字段。 |
SamplingMetadata
如果对漏斗报告结果进行抽样,此元数据将说明在某个日期范围内此漏斗报告中使用的事件所占的百分比。抽样是指分析所有数据的一个子集,以在较大的数据集中发现有意义的信息。
JSON 表示法 |
---|
{ "samplesReadCount": string, "samplingSpaceSize": string } |
字段 | |
---|---|
samplesReadCount |
在此抽样报告中读取的事件总数。这是在此漏斗报告中分析的该媒体资源数据的子集的规模。 |
samplingSpaceSize |
在相应日期范围内,此媒体资源的数据中本来可以分析在此漏斗报告中的事件总数。抽样揭示了有关较大数据集的有用信息,这表明较大数据集的规模。 若要计算此漏斗报告中所用可用数据的百分比,请计算 |
PropertyQuota
此 Google Analytics(分析)媒体资源的所有配额的当前状态。如果某个媒体资源的任何配额已用尽,对该媒体资源的所有请求都将返回“资源已用尽”错误。
JSON 表示法 |
---|
{ "tokensPerDay": { object ( |
字段 | |
---|---|
tokensPerDay |
标准 Analytics(分析)媒体资源每天最多可以使用 20 万个令牌;Analytics 360 媒体资源每天最多可以使用 200 万个令牌。大部分请求消耗的令牌数都少于 10 个。 |
tokensPerHour |
标准 Google Analytics(分析)媒体资源每小时最多可以使用 4 万个令牌;Analytics 360 媒体资源每小时最多可以使用 40 万个令牌。一个 API 请求使用单一数量的令牌,该数量将从每小时、每日和每个项目每小时的所有配额中扣除。 |
concurrentRequests |
标准 Analytics(分析)媒体资源最多可以发送 10 个并发请求;Analytics 360 媒体资源最多可以使用 50 个并发请求。 |
serverErrorsPerProjectPerHour |
标准 Google Analytics(分析)媒体资源和云项目对每小时最多可以有 10 个服务器错误;Analytics 360 媒体资源和云项目对每小时最多可以有 50 个服务器错误。 |
potentiallyThresholdedRequestsPerHour |
Google Analytics(分析)媒体资源每小时最多可以发送 120 个可能具有阈值维度的请求。在批量请求中,如果每个报告请求包含的维度可能应用了阈值,则系统会单独将其计入此配额。 |
tokensPerProjectPerHour |
每个项目每小时最多可使用 Analytics(分析)媒体资源 35% 的令牌。标准 Google Analytics(分析)媒体资源每小时最多可以使用 14000 个令牌,而 Analytics 360 媒体资源每小时每个项目可使用 140000 个令牌。一个 API 请求使用单一数量的令牌,该数量将从每小时、每日和每个项目每小时的所有配额中扣除。 |
QuotaStatus
特定配额组的当前状态。
JSON 表示法 |
---|
{ "consumed": integer, "remaining": integer } |
字段 | |
---|---|
consumed |
此请求消耗的配额。 |
remaining |
提出此申请后剩余的配额。 |