Method: properties.runFunnelReport

返回 Google Analytics(分析)事件数据的自定义漏斗报告。从 API 返回的数据会以表格形式列出所请求的维度和指标。

漏斗探索可以直观呈现用户为完成任务而采取的步骤,并让您迅速了解用户在每个步骤上的成功或失败情况。例如,潜在客户如何成为购物者,进而成为买家?一次性买家如何成为回头客?借助这些信息,您可以改进效率低下的或已放弃的客户转化历程。如需了解详情,请参阅 GA4 漏斗探索

此方法是在 Alpha 版稳定性阶段推出的,目的是在进入 Beta 版之前收集有关语法和功能的反馈。欢迎填写 Google Analytics(分析)Data API 漏斗报告反馈,提供您对此 API 的反馈。

HTTP 请求

POST https://analyticsdata.googleapis.com/v1alpha/{property=properties/*}:runFunnelReport

网址采用 gRPC 转码语法。

路径参数

参数
property

string

跟踪事件的 Google Analytics(分析)GA4 媒体资源标识符。在网址路径(而非正文)中指定。如需了解详情,请参阅在哪里可以找到您的媒体资源 ID。在批处理请求中,此属性应未指定或与批次级属性保持一致。

示例:properties/1234

请求正文

请求正文中包含结构如下的数据:

JSON 表示法
{
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "funnel": {
    object (Funnel)
  },
  "funnelBreakdown": {
    object (FunnelBreakdown)
  },
  "funnelNextAction": {
    object (FunnelNextAction)
  },
  "funnelVisualizationType": enum (FunnelVisualizationType),
  "segments": [
    {
      object (Segment)
    }
  ],
  "limit": string,
  "dimensionFilter": {
    object (FilterExpression)
  },
  "returnPropertyQuota": boolean
}
字段
dateRanges[]

object (DateRange)

要读取的数据的日期范围。如果请求了多个日期范围,则每个响应行都会包含一个从零开始的日期范围索引。如果两个日期范围发生重叠,则重叠日期范围的事件数据会同时添加到两个日期范围的响应行中。

funnel

object (Funnel)

此请求的漏斗配置。必须提供此漏斗配置。

funnelBreakdown

object (FunnelBreakdown)

如果指定,此细分会在漏斗表格子报告响应中添加一个维度。此细分维度将每个漏斗步骤扩展为细分维度的唯一值。例如,如果按 deviceCategory 维度进行细分,系统会为 mobiletabletdesktop 以及总计创建行。

funnelNextAction

object (FunnelNextAction)

如果已指定,则下一步操作会为“渠道可视化”子报告响应添加一个维度。此“下一个操作”维度将每个漏斗步骤扩展到下一个操作的“唯一”值。例如,eventName 维度的下一个操作将为多个事件(即 session_start & click)和总计事件创建行。

Next 操作仅支持 eventName 以及大多数页面/屏幕维度,例如 pageTitlepagePath

funnelVisualizationType

enum (FunnelVisualizationType)

漏斗可视化类型用于控制漏斗可视化子报告响应中显示的维度。如果未指定,则系统会使用 STANDARD_FUNNEL

segments[]

object (Segment)

细分的配置。细分是媒体资源数据的子集。在包含细分的漏斗报告中,系统会在每个细分中对漏斗进行评估。

此请求中指定的每个细分都会在响应中生成单独的一行;在响应中,每个细分都由其名称标识。

segments 参数是可选的。请求最多只能包含 4 个细分。

limit

string (int64 format)

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

如果维度值数量少于 limit,该 API 返回的行数也可能低于请求的 limit

dimensionFilter

object (FilterExpression)

通过维度过滤条件,您可以仅要求在报告中提供特定的维度值。如需了解详情,请参阅创建报告:维度过滤条件。此过滤条件中不能使用指标。

returnPropertyQuota

boolean

选择是否返回此 Google Analytics(分析)媒体资源配额的当前状态。配额在 PropertyQuota 中返回。

响应正文

如果成功,响应正文将包含结构如下的数据:

漏斗报告响应包含两个子报告。这两种子报告是维度和指标的组合。

JSON 表示法
{
  "funnelTable": {
    object (FunnelSubReport)
  },
  "funnelVisualization": {
    object (FunnelSubReport)
  },
  "propertyQuota": {
    object (PropertyQuota)
  },
  "kind": string
}
字段
funnelTable

object (FunnelSubReport)

“漏斗表”是一个包含漏斗步骤、细分、细分维度、活跃用户、完整率、放弃率和放弃率的报告。

只有在已请求细分的情况下,此响应中才会显示细分维度。仅当收到细分维度请求时,此维度才会显示在此响应中。

funnelVisualization

object (FunnelSubReport)

“漏斗可视化”报告包含漏斗步骤、细分、日期、下一个操作维度和活跃用户。

只有在已请求细分的情况下,此响应中才会显示细分维度。只有通过 TRENDED_FUNNEL 漏斗类型请求的日期维度才会在此响应中显示。只有在收到请求后,响应中才会显示下一个操作维度。

propertyQuota

object (PropertyQuota)

此 Google Analytics(分析)媒体资源的配额状态,包括此请求。

kind

string

标识此消息的资源类型。此 kind 始终是固定字符串“analyticsData#runFunnelReport”。有助于区分 JSON 中的响应类型。

授权范围

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

string

查询的开始日期(包含该日期),格式为 YYYY-MM-DD。不得晚于 endDate。系统也接受 NdaysAgoyesterdaytoday 格式,在这种情况下,系统会根据媒体资源的报告时区推断日期。

endDate

string

包含查询的结束日期(格式为 YYYY-MM-DD)。不得早于 startDate。系统也接受 NdaysAgoyesterdaytoday 格式,在这种情况下,系统会根据媒体资源的报告时区推断日期。

name

string

为此日期范围指定一个名称。在报告响应中,维度 dateRange 的值为此值。如果设置,则不能以 date_range_RESERVED_ 开头。如果未设置,系统将使用请求中的索引(从零开始)指定日期范围:date_range_0date_range_1 等。

漏斗

在漏斗报告请求中配置漏斗。漏斗报告的是用户经历一系列步骤的情况。

漏斗探索可以直观呈现用户为完成任务而采取的步骤,并让您迅速了解用户在每个步骤上的成功或失败情况。例如,潜在客户如何成为购物者,进而成为买家?一次性买家如何成为回头客?根据这些信息,您可以改进低效或被用户放弃的客户转化历程。

JSON 表示法
{
  "isOpenFunnel": boolean,
  "steps": [
    {
      object (FunnelStep)
    }
  ]
}
字段
isOpenFunnel

boolean

在开放漏斗中,用户可以在任何步骤进入漏斗;在封闭漏斗中,用户必须在第一个步骤进入漏斗。(可选)如果未指定,则使用封闭漏斗。

steps[]

object (FunnelStep)

此漏斗的连续步骤。

漏斗步骤

步骤定义着您要衡量的用户历程。步骤包含一个或多个条件,您的用户必须满足这些条件才能被纳入漏斗历程的相应步骤。

JSON 表示法
{
  "name": string,
  "isDirectlyFollowedBy": boolean,
  "filterExpression": {
    object (FunnelFilterExpression)
  },
  "withinDurationFromPriorStep": string
}
字段
name

string

此步骤的独特名称。如果未指定,步骤将基于从 1 开始编入索引的名称(即 "0)。&tot;1. " 等)。此名称定义了 funnelStepName 维度返回的字符串值。例如,如果在请求的第三个漏斗步骤中指定 name = Purchase,则漏斗报告响应中将生成 3. Purchase

isDirectlyFollowedBy

boolean

如果为 true,则此步骤必须直接执行上一步。如果为 false,则上一步和此步骤之间可能存在事件。如果未指定,则将 isDirectlyFollowedBy 视为 false。

filterExpression

object (FunnelFilterExpression)

用户必须满足的哪些条件,才能纳入漏斗历程的这一步。

withinDurationFromPriorStep

string (Duration format)

如果指定,则此步骤必须在上一步完成的这段时间内完成。withinDurationFromPriorStep 包含以微秒为单位的端点。例如,时长为 5 秒的时长可在 4.9 秒或 5.0 秒内完成,但不能是 5 秒和 1 微秒内完成。

withinDurationFromPriorStep 是可选项,如果未指定,步骤可以按任意时长进行分隔。

此时长以秒为单位,最多包含九个小数位,以 's' 结尾。示例:"3.5s"

漏斗过滤条件表达式

表示漏斗过滤条件的组合。

JSON 表示法
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FunnelFilterExpressionList)
  },
  "orGroup": {
    object (FunnelFilterExpressionList)
  },
  "notExpression": {
    object (FunnelFilterExpression)
  },
  "funnelFieldFilter": {
    object (FunnelFieldFilter)
  },
  "funnelEventFilter": {
    object (FunnelEventFilter)
  }
  // End of list of possible types for union field expr.
}
字段
联合字段 expr。为 FunnelFilterExpression 指定一种类型的过滤器。expr 只能是下列其中一项:
andGroup

object (FunnelFilterExpressionList)

andGroup 中的 FunnelFilterExpression 具有 AND 关系。

orGroup

object (FunnelFilterExpressionList)

orGroup 中的 FunnelFilterExpression 具有 OR 关系。

notExpression

object (FunnelFilterExpression)

FunnelFilterExpression 不是 notExpression

funnelFieldFilter

object (FunnelFieldFilter)

维度或指标的漏斗过滤条件。

funnelEventFilter

object (FunnelEventFilter)

创建与单个事件名称的事件匹配的过滤器。如果指定了参数过滤条件表达式,则只有与单个事件名称和参数过滤条件表达式匹配的部分事件与此事件过滤条件匹配。

FunnelFilterExpressionList

漏斗过滤条件表达式列表。

JSON 表示法
{
  "expressions": [
    {
      object (FunnelFilterExpression)
    }
  ]
}
字段
expressions[]

object (FunnelFilterExpression)

漏斗过滤条件表达式列表。

漏斗字段过滤条件

用于过滤维度或指标值的表达式。

JSON 表示法
{
  "fieldName": string,

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}
字段
fieldName

string

维度名称或指标名称。

联合字段 one_filter。指定一种类型的过滤条件。one_filter 只能是下列其中一项:
stringFilter

object (StringFilter)

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

inListFilter

object (InListFilter)

列表值中的过滤条件。

numericFilter

object (NumericFilter)

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

betweenFilter

object (BetweenFilter)

两个值之间的过滤条件。

字符串过滤器

字符串过滤条件

JSON 表示法
{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}
字段
matchType

enum (MatchType)

此过滤器的匹配类型。

value

string

用于匹配的字符串值。

caseSensitive

boolean

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

MatchType

字符串过滤器的匹配类型

枚举
MATCH_TYPE_UNSPECIFIED 未指定
EXACT 字符串值完全匹配。
BEGINS_WITH 以字符串值开头。
ENDS_WITH 以字符串值结尾。
CONTAINS 包含字符串值。
FULL_REGEXP 正则表达式与字符串值的完全匹配。
PARTIAL_REGEXP 正则表达式与字符串值的部分匹配。

InListFilter

结果必须位于字符串值列表中。

JSON 表示法
{
  "values": [
    string
  ],
  "caseSensitive": boolean
}
字段
values[]

string

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

caseSensitive

boolean

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

数值过滤条件

数值或日期值的过滤条件。

JSON 表示法
{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}
字段
operation

enum (Operation)

此过滤器的操作类型。

value

object (NumericValue)

数值或日期值。

操作

应用于数字过滤器的操作

枚举
OPERATION_UNSPECIFIED 未指定。
EQUAL 等于
LESS_THAN 小于
LESS_THAN_OR_EQUAL 小于或等于
GREATER_THAN 大于
GREATER_THAN_OR_EQUAL 大于或等于

NumericValue

表示数字。

JSON 表示法
{

  // Union field one_value can be only one of the following:
  "int64Value": string,
  "doubleValue": number
  // End of list of possible types for union field one_value.
}
字段
联合字段 one_value。数值 one_value 只能是下列其中一项:
int64Value

string (int64 format)

整数值

doubleValue

number

DoubleValue

介于两者之间

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

JSON 表示法
{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}
字段
fromValue

object (NumericValue)

以此编号开头。

toValue

object (NumericValue)

以此编号结尾。

漏斗事件过滤器

创建与单个事件名称的事件匹配的过滤器。如果指定了参数过滤条件表达式,则只有与单个事件名称和参数过滤条件表达式匹配的部分事件与此事件过滤条件匹配。

JSON 表示法
{
  "eventName": string,
  "funnelParameterFilterExpression": {
    object (FunnelParameterFilterExpression)
  }
}
字段
eventName

string

此过滤条件与这个事件名称中的事件相匹配。事件名称为必填项。

funnelParameterFilterExpression

object (FunnelParameterFilterExpression)

如果指定,此过滤条件将匹配与单个事件名称和参数过滤条件表达式匹配的事件。

在参数过滤条件表达式内,只有参数过滤条件可用。

FunnelParameterFilterExpression

表示参数组合的漏斗过滤条件组合。

JSON 表示法
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FunnelParameterFilterExpressionList)
  },
  "orGroup": {
    object (FunnelParameterFilterExpressionList)
  },
  "notExpression": {
    object (FunnelParameterFilterExpression)
  },
  "funnelParameterFilter": {
    object (FunnelParameterFilter)
  }
  // End of list of possible types for union field expr.
}
字段
联合字段 expr。为 FunnelParameterFilterExpression 指定一种类型的过滤器。expr 只能是下列其中一项:
andGroup

object (FunnelParameterFilterExpressionList)

andGroup 中的 FunnelParameterFilterExpression 具有 AND 关系。

orGroup

object (FunnelParameterFilterExpressionList)

orGroup 中的 FunnelParameterFilterExpression 具有 OR 关系。

notExpression

object (FunnelParameterFilterExpression)

FunnelParameterFilterExpression 不是 notExpression

funnelParameterFilter

object (FunnelParameterFilter)

初始漏斗参数过滤条件。

FunnelParameterFilterExpressionList

漏斗参数过滤条件表达式列表。

JSON 表示法
{
  "expressions": [
    {
      object (FunnelParameterFilterExpression)
    }
  ]
}
字段
expressions[]

object (FunnelParameterFilterExpression)

漏斗参数过滤条件表达式列表。

FunnelParameterFilter

用于过滤漏斗中参数值的表达式。

JSON 表示法
{

  // Union field one_parameter can be only one of the following:
  "eventParameterName": string,
  "itemParameterName": string
  // End of list of possible types for union field one_parameter.

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}
字段
联合字段 one_parameter。要过滤的字段。one_parameter 只能是下列其中一项:
eventParameterName

string

系统将根据指定的事件参数评估此过滤条件。事件参数会记录为事件的参数。事件参数包括 &firebaseotscreen" & "currency" 等字段。

事件参数只能在细分和漏斗中使用,并且只能在 EventFilter 的后代过滤器中使用。在 EventFilter 的后代过滤器中,应使用事件参数或商品参数。

itemParameterName

string

系统将根据指定的 item 参数评估此过滤条件。系统会将 item 参数记录为 item 数组中的参数。商品参数包含 "item_name" & "item_category&quot> 等字段。

Item 参数只能在细分和漏斗中使用,并且只能在 EventFilter 的后代过滤条件中使用。在 EventFilter 的后代过滤器中,应使用事件参数或商品参数。

商品参数仅适用于电子商务事件。如需详细了解电子商务事件,请参阅衡量电子商务指南。

联合字段 one_filter。指定一种类型的过滤条件。one_filter 只能是下列其中一项:
stringFilter

object (StringFilter)

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

inListFilter

object (InListFilter)

列表值中的过滤条件。

numericFilter

object (NumericFilter)

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

betweenFilter

object (BetweenFilter)

两个值之间的过滤条件。

漏斗细分

细分会在漏斗表格子报告响应中添加一个维度。

JSON 表示法
{
  "breakdownDimension": {
    object (Dimension)
  },
  "limit": string
}
字段
breakdownDimension

object (Dimension)

添加到漏斗表子报告响应中的维度列。细分维度会细分每个漏斗步骤。如果指定了 funnelBreakdown,则必须提供有效的 breakdownDimension

limit

string (int64 format)

在响应中返回的细分维度的不同值数上限。如果未指定限制,则系统会使用 5limit。限制必须大于零且不能超过 15。

尺寸

“维度”是指数据的属性。例如,维度“城市”表示产生事件的城市。报告响应中的维度值是字符串;例如,城市可以是“巴黎”或“纽约”。

JSON 表示法
{
  "name": string,
  "dimensionExpression": {
    object (DimensionExpression)
  }
}
字段
name

string

维度的名称。如需查看维度名称列表,请参阅 API 维度

如果指定了 dimensionExpression,则 name 可以是您希望在允许的字符集中使用的任何字符串。例如,如果 dimensionExpressioncountrycity 连接起来,则可调用该维度 countryAndCity。您选择的维度名称必须与正则表达式 ^[a-zA-Z0-9_]$ 匹配。

尺寸由 namedimensionFilterorderBysdimensionExpressionpivots 中引用。

dimensionExpression

object (DimensionExpression)

一个维度可以是多个维度的表达式的结果。例如,维度“国家/地区,城市”:concatenate(国家/地区, ", 和城市)。

DimensionExpression

用于表示一个维度,其结果是包含多个维度的公式的结果。用法示例:1)lowerCase(dimension) 2) concatenate(dimension1, 符号, dimension2)。

JSON 表示法
{

  // Union field one_expression can be only one of the following:
  "lowerCase": {
    object (CaseExpression)
  },
  "upperCase": {
    object (CaseExpression)
  },
  "concatenate": {
    object (ConcatenateExpression)
  }
  // End of list of possible types for union field one_expression.
}
字段
联合字段 one_expression。为 DimensionExpression 指定一种维度表达式。one_expression 只能是下列其中一项:
lowerCase

object (CaseExpression)

用于将维度值转换为小写。

upperCase

object (CaseExpression)

用于将维度值转换为大写。

concatenate

object (ConcatenateExpression)

用于将维度值合并到单个维度。例如,维度“国家/地区,城市”:concatenate(国家/地区, ", 和城市)。

案例表达式

用于将维度值转换为单一大小写。

JSON 表示法
{
  "dimensionName": string
}
字段
dimensionName

string

维度的名称。名称必须引用该请求的维度字段中的名称。

串联表达式

用于将维度值合并到单个维度。

JSON 表示法
{
  "dimensionNames": [
    string
  ],
  "delimiter": string
}
字段
dimensionNames[]

string

维度的名称。名称必须引用到相应请求的维度字段中的名称。

delimiter

string

维度名称之间的分隔符。

分隔符通常是单个字符,如“|”或“,”,但也可以是更长的字符串。如果维度值包含分隔符,两者都会同时出现且不区分。例如,如果维度 1 值 =“US,FR”、维度 2 值 =“JP”和分隔符 =“&”,则响应会包含“US,FR,JP”。

漏斗下一步操作

“下一项操作”会在用户完成一个步骤之后但同一用户还未完成下一步之前说明该维度的值。例如,如果 nextActionDimensioneventName,则第 i 个漏斗步骤行中的 nextActionDimension 将返回符合让用户进入第 i 个漏斗步骤但还未达到第 i+1 个漏斗步骤的事件之前的首个事件。

JSON 表示法
{
  "nextActionDimension": {
    object (Dimension)
  },
  "limit": string
}
字段
nextActionDimension

object (Dimension)

添加到漏斗可视化图表子报告响应中的维度列。在用户完成第 i 个漏斗步骤后,“下一个操作”维度会返回此维度的下一个维度值。

nextActionDimension目前仅支持 eventName 以及大多数页面 / 屏幕维度(例如 pageTitlepagePath)。“nextActionDimension”不能是维度表达式。

limit

string (int64 format)

在响应中返回的细分维度的不同值数上限。如果未指定限制,则系统会使用 5limit。限值必须大于 0 且不能超过 5。

漏斗可视化类型

控制“渠道可视化”子报告响应中显示的维度。

枚举
FUNNEL_VISUALIZATION_TYPE_UNSPECIFIED 未指定类型。
STANDARD_FUNNEL 标准(阶梯式)漏斗。响应中的漏斗可视化子报告将不包含日期。
TRENDED_FUNNEL 一种趋势(折线图)漏斗。响应中的漏斗可视化子报告将包含日期维度。

片段

“细分”是指您的一部分 Google Analytics(分析)数据。例如,在您的整个用户群中,您可使用一个细分来指定来自特定国家/地区或城市的用户,您还可以使用另一个细分来指定购买特定产品系列、访问网站上特定部分或触发应用中某些事件的用户。

如需了解详情,请参阅 GA4 细分生成工具

JSON 表示法
{
  "name": string,

  // Union field one_segment_scope can be only one of the following:
  "userSegment": {
    object (UserSegment)
  },
  "sessionSegment": {
    object (SessionSegment)
  },
  "eventSegment": {
    object (EventSegment)
  }
  // End of list of possible types for union field one_segment_scope.
}
字段
name

string

此细分受众群的名称。如果未指定,则将细分受众群命名为“细分受众群”。此名称定义了 segment 维度返回的字符串值。segment 维度在请求中为细分的前缀名称添加从 1 开始的细分编号(即 "1)。细分受众群”、“2. 片段”等)。

联合字段 one_segment_scope。在一个范围内指定细分。one_segment_scope 只能是下列其中一项:
userSegment

object (UserSegment)

细分用户群是指与您的网站或应用进行过互动的用户的子集。

sessionSegment

object (SessionSegment)

会话细分是在您的网站或应用上发生的一部分会话。

eventSegment

object (EventSegment)

事件细分是在您的网站或应用上触发的事件子集。

用户细分

用户细分是与您的网站或应用进行过互动的部分用户。例如,之前有过购买行为的用户;向购物车添加了商品,但并未完成购买的用户。

JSON 表示法
{
  "userInclusionCriteria": {
    object (UserSegmentCriteria)
  },
  "exclusion": {
    object (UserSegmentExclusion)
  }
}
字段
userInclusionCriteria

object (UserSegmentCriteria)

定义哪些用户包含在此细分受众群中。可选。

exclusion

object (UserSegmentExclusion)

定义在此细分中排除哪些用户。可选。

用户细分条件

如果用户的事件满足条件中的条件,就会匹配该条件。

JSON 表示法
{
  "andConditionGroups": [
    {
      object (UserSegmentConditionGroup)
    }
  ],
  "andSequenceGroups": [
    {
      object (UserSegmentSequenceGroup)
    }
  ]
}
字段
andConditionGroups[]

object (UserSegmentConditionGroup)

如果用户符合所有这些 andConditionGroups 和每个 andSequenceGroups,就会匹配此条件。如果指定了 andSequenceGroups,则 andConditionGroups 可能为空。

andSequenceGroups[]

object (UserSegmentSequenceGroup)

如果用户符合所有这些 andSequenceGroups 和每个 andConditionGroups,就会匹配此条件。如果指定了 andConditionGroups,则 andSequenceGroups 可能为空。

用户细分条件组

条件用于告知 Google Analytics(分析)要在细分中包含或排除哪些数据。

JSON 表示法
{
  "conditionScoping": enum (UserCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
字段
conditionScoping

enum (UserCriteriaScoping)

根据数据是否与条件组匹配,在细分中包含或排除数据。这种范围界定了在确定条件组是否匹配之前,segmentFilterExpression 会评估多少事件。例如,如果 conditionScoping = USER_CRITERIA_WITHIN_SAME_SESSION,系统会针对会话中的所有事件对表达式求值,然后确定该用户与此条件组是否匹配。例如,如果值为 conditionScoping = USER_CRITERIA_WITHIN_SAME_EVENT,则针对单个事件对表达式求值,然后判断该用户对于条件组是否匹配。

(可选)如果未指定,系统会使用 conditionScoping = ACROSS_ALL_SESSIONS

segmentFilterExpression

object (SegmentFilterExpression)

根据是否与此表达式匹配,在细分中包含或排除数据。表达式表示对维度、指标和/或参数的条件。

用户条件范围

限定范围可指定在评估用户是否符合条件时要考虑哪些事件。

枚举
USER_CRITERIA_SCOPING_UNSPECIFIED 未指定条件范围。请勿指定。
USER_CRITERIA_WITHIN_SAME_EVENT 如果在一个事件中满足条件,用户与该条件匹配。
USER_CRITERIA_WITHIN_SAME_SESSION 如果在一个会话中满足条件,用户便会匹配该条件。
USER_CRITERIA_ACROSS_ALL_SESSIONS 如果用户的任何事件都满足条件,用户就会匹配该条件。

SegmentFilter 表达式

表示对细分过滤器的组合。

JSON 表示法
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (SegmentFilterExpressionList)
  },
  "orGroup": {
    object (SegmentFilterExpressionList)
  },
  "notExpression": {
    object (SegmentFilterExpression)
  },
  "segmentFilter": {
    object (SegmentFilter)
  },
  "segmentEventFilter": {
    object (SegmentEventFilter)
  }
  // End of list of possible types for union field expr.
}
字段
联合字段 expr。为 SegmentFilterExpression 指定一种类型的过滤器。expr 只能是下列其中一项:
andGroup

object (SegmentFilterExpressionList)

andGroup 中的 SegmentFilterExpression 具有 AND 关系。

orGroup

object (SegmentFilterExpressionList)

orGroup 中的 SegmentFilterExpression 具有 OR 关系。

notExpression

object (SegmentFilterExpression)

SegmentFilterExpression 不是 notExpression

segmentFilter

object (SegmentFilter)

基本细分过滤器。

segmentEventFilter

object (SegmentEventFilter)

创建与单个事件名称的事件匹配的过滤器。如果指定了参数过滤条件表达式,则只有与单个事件名称和参数过滤条件表达式匹配的部分事件与此事件过滤条件匹配。

细分过滤条件表达式列表

细分过滤条件表达式列表。

JSON 表示法
{
  "expressions": [
    {
      object (SegmentFilterExpression)
    }
  ]
}
字段
expressions[]

object (SegmentFilterExpression)

细分过滤条件表达式列表

SegmentFilter

用于过滤维度或指标值的表达式。

JSON 表示法
{
  "fieldName": string,
  "filterScoping": {
    object (SegmentFilterScoping)
  },

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}
字段
fieldName

string

维度名称或指标名称。

filterScoping

object (SegmentFilterScoping)

指定过滤器的范围。

联合字段 one_filter。为 Filter 指定一种类型的过滤器。one_filter 只能是下列其中一项:
stringFilter

object (StringFilter)

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

inListFilter

object (InListFilter)

列表值中的过滤条件。

numericFilter

object (NumericFilter)

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

betweenFilter

object (BetweenFilter)

两个值之间的过滤条件。

细分过滤条件范围

界定范围指定在评估细分过滤器时应如何考虑多个事件的维度与指标。

JSON 表示法
{
  "atAnyPointInTime": boolean
}
字段
atAnyPointInTime

boolean

如果 atAnyPointInTime 为 true,则对于所有请求的评估时间范围内的任何事件,此过滤器的计算结果为 true。

atAnyPointInTime 参数不会延长报告中事件的日期范围。如果 atAnyPointInTime 为 true,系统在评估此过滤条件时只会考虑报告日期范围内发生的事件。

只有在条件范围限定为 ACROSS_ALL_SESSIONS 时,才能指定此 atAnyPointInTime,且无法依序指定。

如果条件范围限定为 ACROSS_ALL_SESSIONS,如果未指定,则使用 atAnyPointInTime = false。

SegmentEventFilter

创建与单个事件名称的事件匹配的过滤器。如果指定了参数过滤条件表达式,则只有与单个事件名称和参数过滤条件表达式匹配的部分事件与此事件过滤条件匹配。

JSON 表示法
{
  "eventName": string,
  "segmentParameterFilterExpression": {
    object (SegmentParameterFilterExpression)
  }
}
字段
eventName

string

此过滤条件与这个事件名称中的事件相匹配。事件名称为必填项。

segmentParameterFilterExpression

object (SegmentParameterFilterExpression)

如果指定,此过滤条件将匹配与单个事件名称和参数过滤条件表达式匹配的事件。

在参数过滤条件表达式内,只有参数过滤条件可用。

SegmentParameterFilter 表达式

表示对参数的细分过滤条件组合。

JSON 表示法
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (SegmentParameterFilterExpressionList)
  },
  "orGroup": {
    object (SegmentParameterFilterExpressionList)
  },
  "notExpression": {
    object (SegmentParameterFilterExpression)
  },
  "segmentParameterFilter": {
    object (SegmentParameterFilter)
  }
  // End of list of possible types for union field expr.
}
字段
联合字段 expr。为 SegmentParameterFilterExpression 指定一种类型的过滤器。expr 只能是下列其中一项:
andGroup

object (SegmentParameterFilterExpressionList)

andGroup 中的 SegmentParameterFilterExpression 具有 AND 关系。

orGroup

object (SegmentParameterFilterExpressionList)

orGroup 中的 SegmentParameterFilterExpression 具有 OR 关系。

notExpression

object (SegmentParameterFilterExpression)

SegmentParameterFilterExpression 不是 notExpression

segmentParameterFilter

object (SegmentParameterFilter)

基本细分参数过滤条件。

SegmentParameterFilterExpressionList

细分参数过滤条件表达式列表。

JSON 表示法
{
  "expressions": [
    {
      object (SegmentParameterFilterExpression)
    }
  ]
}
字段
expressions[]

object (SegmentParameterFilterExpression)

细分参数过滤条件表达式列表。

SegmentParameterFilter

用于过滤细分中的参数值的表达式。

JSON 表示法
{
  "filterScoping": {
    object (SegmentParameterFilterScoping)
  },

  // Union field one_parameter can be only one of the following:
  "eventParameterName": string,
  "itemParameterName": string
  // End of list of possible types for union field one_parameter.

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}
字段
filterScoping

object (SegmentParameterFilterScoping)

指定过滤器的范围。

联合字段 one_parameter。要过滤的字段。one_parameter 只能是下列其中一项:
eventParameterName

string

系统将根据指定的事件参数评估此过滤条件。事件参数会记录为事件的参数。事件参数包括 &firebaseotscreen" & "currency" 等字段。

事件参数只能在细分和漏斗中使用,并且只能在 EventFilter 的后代过滤器中使用。在 EventFilter 的后代过滤器中,应使用事件参数或商品参数。

itemParameterName

string

系统将根据指定的 item 参数评估此过滤条件。系统会将 item 参数记录为 item 数组中的参数。商品参数包含 "item_name" & "item_category&quot> 等字段。

Item 参数只能在细分和漏斗中使用,并且只能在 EventFilter 的后代过滤条件中使用。在 EventFilter 的后代过滤器中,应使用事件参数或商品参数。

商品参数仅适用于电子商务事件。如需详细了解电子商务事件,请参阅衡量电子商务指南。

联合字段 one_filter。指定一种类型的过滤条件。one_filter 只能是下列其中一项:
stringFilter

object (StringFilter)

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

inListFilter

object (InListFilter)

列表值中的过滤条件。

numericFilter

object (NumericFilter)

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

betweenFilter

object (BetweenFilter)

两个值之间的过滤条件。

SegmentParameterFilterScoping

限定范围用于指定在评估细分参数过滤条件时应考虑多个事件。

JSON 表示法
{
  "inAnyNDayPeriod": string
}
字段
inAnyNDayPeriod

string (int64 format)

应用过滤器之前,在指定天数内累积参数。仅在范围限定为 ACROSS_ALL_SESSIONSWITHIN_SAME_SESSION 时才支持。仅当参数为 event_count 时支持。

例如,如果 inAnyNDayPeriod 为 3,eventName 为“purchase”,事件参数为“event_count”,且过滤条件大于 5,则该过滤条件会在报告日期范围内连续 3 天连续统计购买事件的事件数;如果满足此条件,那么用户在 3 天(不含 39 天)内都会超过此细分,且在 35 天(不含 39 天)内,用户都会通过此过滤器。例如,系统会考虑 2021-11-01 至 2021-11-03、2021-11-02 至 2021-11-04、2021-11-03 至 2021-11-05 等时间段。

日期范围不会延长,以便在日期范围即将开始之际留出完整的 N 天时间范围。例如,如果报表针对 2021-11-01 至 2021-11-10,且 inAnyNDayPeriod = 3,则前两天的数据会有效地缩短,因为系统不会读取报表日期范围之外的事件数据。例如,前四个时间段实际上是 2021 年 11 月 1 日至 2021 年 11 月 1 日、2021 年 11 月 1 日至 2021 年 11 月 2 日、2021 年 11 月 1 日至 2021 年 11 月 3 日和 2021 年 11 月 2 日。

inAnyNDayPeriod 是可选项。如果未指定,segmentParameterFilter 将单独应用于每个事件。

用户细分序列组

以特定顺序定义用户必须是细分受众群成员的条件。

JSON 表示法
{
  "sequenceScoping": enum (UserCriteriaScoping),
  "sequenceMaximumDuration": string,
  "userSequenceSteps": [
    {
      object (UserSequenceStep)
    }
  ]
}
字段
sequenceScoping

enum (UserCriteriaScoping)

必须在作用域内满足所有序列步骤,才能使用户序列匹配。例如,如果为 sequenceScoping = USER_CRITERIA_WITHIN_SAME_SESSION,则所有序列步骤必须在一个会话中完成,用户才能匹配序列。不支持sequenceScoping = USER_CRITERIA_WITHIN_SAME_EVENT

(可选)如果未指定,系统会使用 conditionScoping = ACROSS_ALL_SESSIONS

sequenceMaximumDuration

string (Duration format)

指定整个序列必须在多长时间内完成,例如 30 分钟。sequenceMaximumDuration 包含以微秒为单位的端点。例如,时长不超过 5 秒的序列可在 4.9 秒或 5.0 秒内完成,但不能在 5 秒和 1 秒内完成。

sequenceMaximumDuration 是可选的,如果未指定,序列可在任何时长内完成。

此时长以秒为单位,最多包含九个小数位,以 's' 结尾。示例:"3.5s"

userSequenceSteps[]

object (UserSequenceStep)

条件步骤的有序序列。用户的事件必须完成每个步骤,用户才会与 UserSegmentSequenceGroup 匹配。

用户序列步骤

必须按指定步骤顺序执行的条件,用户才能与序列匹配。

JSON 表示法
{
  "isDirectlyFollowedBy": boolean,
  "stepScoping": enum (UserCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
字段
isDirectlyFollowedBy

boolean

如果为 true,则满足此步骤的事件必须是在满足最后一个步骤之后的下一个事件。如果为 false,则此步骤会间接后跟上一步;例如,上一步和此步骤之间可能存在事件。第一步的 isDirectlyFollowedBy 必须为 false。

stepScoping

enum (UserCriteriaScoping)

必须在范围限定中满足此序列步骤,才能使用户序列匹配。例如,如果为 sequenceScoping = WITHIN_SAME_SESSION,则该序列步骤必须在一个会话中完成,用户才能匹配序列。仅当 sequenceScoping = ACROSS_ALL_SESSIONS 时,才允许使用 stepScoping = ACROSS_ALL_SESSIONS

(可选)如果未指定,stepScoping 会使用与 sequenceScoping 相同的 UserCriteriaScoping

segmentFilterExpression

object (SegmentFilterExpression)

如果用户的事件与此表达式步骤匹配,则与其匹配。表达式表示对维度、指标和/或参数的条件。

用户细分排除

指定要在此细分中排除的用户。

JSON 表示法
{
  "userExclusionDuration": enum (UserExclusionDuration),
  "userExclusionCriteria": {
    object (UserSegmentCriteria)
  }
}
字段
userExclusionDuration

enum (UserExclusionDuration)

指定当用户与 userExclusionCriteria 匹配时排除对象将持续的时间。

(可选)如果未指定,系统会使用 userExclusionDuration(共 USER_EXCLUSION_TEMPORARY 个)。

userExclusionCriteria

object (UserSegmentCriteria)

如果用户满足此条件,该用户就会从“userExclusionDuration”的细分受众群中排除。

用户排除时长

枚举排除时长与 userExclusionCriteria 匹配的用户选项。

枚举
USER_EXCLUSION_DURATION_UNSPECIFIED 未指定的排除时长。请勿指定。
USER_EXCLUSION_TEMPORARY 在用户满足 userExclusionCriteria 条件期间暂时将用户排除在细分受众群之外。
USER_EXCLUSION_PERMANENT 如果用户满足 userExclusionCriteria 条件,则将用户从细分中永久排除。

会话细分

会话细分是在您的网站或应用上发生的一部分会话,例如:源自特定广告系列的所有会话。

JSON 表示法
{
  "sessionInclusionCriteria": {
    object (SessionSegmentCriteria)
  },
  "exclusion": {
    object (SessionSegmentExclusion)
  }
}
字段
sessionInclusionCriteria

object (SessionSegmentCriteria)

定义此细分中包含哪些会话。可选。

exclusion

object (SessionSegmentExclusion)

定义此细分中排除了哪些会话。可选。

SessionSegmentCriteria

如果某个会话的事件满足条件中的条件,那么此会话就会匹配该条件。

JSON 表示法
{
  "andConditionGroups": [
    {
      object (SessionSegmentConditionGroup)
    }
  ]
}
字段
andConditionGroups[]

object (SessionSegmentConditionGroup)

如果某个会话与上述每一个 andConditionGroups 匹配,则会话就会与此条件匹配。

SessionSegmentConditionGroup

条件用于告知 Google Analytics(分析)要在细分中包含或排除哪些数据。

JSON 表示法
{
  "conditionScoping": enum (SessionCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
字段
conditionScoping

enum (SessionCriteriaScoping)

根据数据是否与条件组匹配,在细分中包含或排除数据。这种范围界定了在确定条件组是否匹配之前,segmentFilterExpression 会评估多少事件。例如,如果 conditionScoping = SESSION_CRITERIA_WITHIN_SAME_SESSION,系统会针对会话中的所有事件对表达式求值,然后确定此会话的匹配条件组。例如,如果 conditionScoping = SESSION_CRITERIA_WITHIN_SAME_EVENT,系统会针对单个事件评估表达式,然后确定条件会话与此会话是否匹配。

(可选)如果未指定,系统会使用 WITHIN_SAME_SESSIONconditionScoping

segmentFilterExpression

object (SegmentFilterExpression)

根据是否与此表达式匹配,在细分中包含或排除数据。表达式表示对维度、指标和/或参数的条件。

SessionCriteriaScoping

界定范围指定评估会话是否符合条件时要考虑哪些事件。

枚举
SESSION_CRITERIA_SCOPING_UNSPECIFIED 未指定条件范围。请勿指定。
SESSION_CRITERIA_WITHIN_SAME_EVENT 如果在一个事件内满足条件,会话将与该条件匹配。
SESSION_CRITERIA_WITHIN_SAME_SESSION 如果在一个会话中满足条件,则该会话与条件匹配。

SessionSegmentExclusion

指定要在此细分中排除的会话。

JSON 表示法
{
  "sessionExclusionDuration": enum (SessionExclusionDuration),
  "sessionExclusionCriteria": {
    object (SessionSegmentCriteria)
  }
}
字段
sessionExclusionDuration

enum (SessionExclusionDuration)

指定会话持续与 sessionExclusionCriteria 匹配时将持续的时间。

(可选)如果未指定,系统会使用 SESSION_EXCLUSION_TEMPORARYsessionExclusionDuration

sessionExclusionCriteria

object (SessionSegmentCriteria)

如果某个会话满足此条件,该会话将不会是 sessionExclusionDuration 的细分受众群中的成员。

会话排除时长

枚举在会话与 sessionExclusionCriteria 匹配的情况下将排除对象持续多长时间的选项。

枚举
SESSION_EXCLUSION_DURATION_UNSPECIFIED 未指定的排除时长。请勿指定。
SESSION_EXCLUSION_TEMPORARY 在会话满足 sessionExclusionCriteria 条件期间暂时从细分中排除会话。
SESSION_EXCLUSION_PERMANENT 如果会话曾满足 sessionExclusionCriteria 条件,则会从细分中永久排除会话。

事件细分

事件细分是在您的网站或应用上触发的事件子集,例如,在特定位置发生的所有购买事件;在特定操作系统上发生的 app_exception 事件。

JSON 表示法
{
  "eventInclusionCriteria": {
    object (EventSegmentCriteria)
  },
  "exclusion": {
    object (EventSegmentExclusion)
  }
}
字段
eventInclusionCriteria

object (EventSegmentCriteria)

定义此细分中包含哪些事件。可选。

exclusion

object (EventSegmentExclusion)

定义在此细分中排除哪些事件。可选。

EventSegmentCriteria

如果事件满足条件中的条件,则该事件与条件匹配。

JSON 表示法
{
  "andConditionGroups": [
    {
      object (EventSegmentConditionGroup)
    }
  ]
}
字段
andConditionGroups[]

object (EventSegmentConditionGroup)

如果某个事件与所有这些 andConditionGroups 匹配,则一个事件与此条件匹配。

EventSegmentConditionGroup

条件用于告知 Google Analytics(分析)要在细分中包含或排除哪些数据。

JSON 表示法
{
  "conditionScoping": enum (EventCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
字段
conditionScoping

enum (EventCriteriaScoping)

conditionScoping 应始终为 EVENT_CRITERIA_WITHIN_SAME_EVENT

(可选)如果未指定,系统会使用 EVENT_CRITERIA_WITHIN_SAME_EVENTconditionScoping

segmentFilterExpression

object (SegmentFilterExpression)

根据是否与此表达式匹配,在细分中包含或排除数据。表达式表示对维度、指标和/或参数的条件。

EventCriteriaScoping

限定范围可指定在评估事件是否符合条件时要考虑哪些事件。

枚举
EVENT_CRITERIA_SCOPING_UNSPECIFIED 未指定条件范围。请勿指定。
EVENT_CRITERIA_WITHIN_SAME_EVENT 如果一个事件满足条件,该事件就会匹配该条件。

EventSegmentExclusion

指定要在此细分中排除哪些事件。

JSON 表示法
{
  "eventExclusionDuration": enum (EventExclusionDuration),
  "eventExclusionCriteria": {
    object (EventSegmentCriteria)
  }
}
字段
eventExclusionDuration

enum (EventExclusionDuration)

eventExclusionDuration 应始终为 PERMANENTLY_EXCLUDE

(可选)如果未指定,系统会使用 EVENT_EXCLUSION_PERMANENTeventExclusionDuration

eventExclusionCriteria

object (EventSegmentCriteria)

如果某个事件满足此条件,系统会从 eventExclusionDuration 的细分受众群中排除该事件。

事件排除时长

枚举在事件与 eventExclusionCriteria 匹配时排除项将持续的时间选项。

枚举
EVENT_EXCLUSION_DURATION_UNSPECIFIED 未指定的排除时长。请勿指定。
EVENT_EXCLUSION_PERMANENT 如果事件曾经满足 eventExclusionCriteria 条件,则会从细分中永久排除事件。

FilterExpression

表示维度或指标过滤条件。同一 FilterExpression 中的字段需要是所有维度或所有指标。

JSON 表示法
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FilterExpressionList)
  },
  "orGroup": {
    object (FilterExpressionList)
  },
  "notExpression": {
    object (FilterExpression)
  },
  "filter": {
    object (Filter)
  }
  // End of list of possible types for union field expr.
}
字段
联合字段 expr。为 FilterExpression 指定一种类型的过滤条件表达式。expr 只能是下列其中一项:
andGroup

object (FilterExpressionList)

andGroup 中的 FilterExpression 具有 AND 关系。

orGroup

object (FilterExpressionList)

OrGroup 中的 FilterExpression 具有 OR 关系。

notExpression

object (FilterExpression)

Filter 表达式不是 NOT 表达式。

filter

object (Filter)

基本过滤条件。在同一过滤条件表达式中,过滤条件的所有字段名称都必须是所有维度或所有指标。

FilterExpressionList

过滤条件表达式列表。

JSON 表示法
{
  "expressions": [
    {
      object (FilterExpression)
    }
  ]
}
字段
expressions[]

object (FilterExpression)

过滤条件表达式列表。

过滤

用于过滤维度或指标值的表达式。

JSON 表示法
{
  "fieldName": string,

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}
字段
fieldName

string

维度名称或指标名称。必须是维度或指标中定义的名称。

联合字段 one_filter。为 Filter 指定一种类型的过滤器。one_filter 只能是下列其中一项:
stringFilter

object (StringFilter)

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

inListFilter

object (InListFilter)

列表值中的过滤条件。

numericFilter

object (NumericFilter)

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

betweenFilter

object (BetweenFilter)

两个值之间的过滤条件。

漏斗子报告

漏斗子报告包含维度和指标数据值。例如,12 位用户到达了漏斗的第二个步骤。

JSON 表示法
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "metadata": {
    object (FunnelResponseMetadata)
  }
}
字段
dimensionHeaders[]

object (DimensionHeader)

描述维度列。漏斗报告始终在子报告响应中包含漏斗步骤维度。若有请求,响应中可能会显示细分、日期和后续操作等其他维度。

metricHeaders[]

object (MetricHeader)

描述指标列。漏斗报告始终在子报告响应中包括活跃用户。漏斗表包含其他指标,例如完成率、放弃率和放弃率。

rows[]

object (Row)

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

metadata

object (FunnelResponseMetadata)

漏斗报告的元数据。

DimensionHeader

说明报告中的维度列。报告中请求的维度会在行和 DimensionHeaders 内生成列条目。但是,仅在过滤器或表达式中使用的维度不会在报表中生成列;因此,这些维度不会生成标题。

JSON 表示法
{
  "name": string
}
字段
name

string

维度的名称。

MetricHeader

描述报告中的指标列。报告中请求的可见指标会在各行和 MetricHeaders 中生成列条目。但是,仅在过滤器或表达式中使用的指标不会在报表中生成列;因此,这些指标不会生成标题。

JSON 表示法
{
  "name": string,
  "type": enum (MetricType)
}
字段
name

string

指标的名称。

type

enum (MetricType)

指标的数据类型。

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,15 作为 eventCount,则:

"dimensionValues": [
  {
    "value": "in_app_purchase"
  },
  {
    "value": "JP"
  }
],
"metricValues": [
  {
    "value": "15"
  }
]
JSON 表示法
{
  "dimensionValues": [
    {
      object (DimensionValue)
    }
  ],
  "metricValues": [
    {
      object (MetricValue)
    }
  ]
}
字段
dimensionValues[]

object (DimensionValue)

请求的维度值列表。在 PivotReport 中,系统只会针对数据透视中包含的维度列出维度值。

metricValues[]

object (MetricValue)

所请求的可见指标值的列表。

DimensionValue

维度的值。

JSON 表示法
{
  "value": string
}
字段
value

string

如果维度类型是字符串,则为字符串值。

MetricValue

指标的值。

JSON 表示法
{
  "value": string
}
字段
value

string

测量值。如需了解类型,请参阅 MetricHeader。

漏斗响应元数据

漏斗报告的响应元数据中包含有关漏斗报告的其他信息。

JSON 表示法
{
  "samplingMetadatas": [
    {
      object (SamplingMetadata)
    }
  ]
}
字段
samplingMetadatas[]

object (SamplingMetadata)

如果对漏斗报告结果进行抽样,则表示此漏斗报告中所用的事件所占百分比。系统会为每个日期范围填充一个 samplingMetadatas。每个 samplingMetadatas 对应一个日期范围,按照在请求中指定的日期范围排序。

但如果未对结果进行抽样,则不会定义此字段。

抽样元数据

如果对漏斗报告结果进行抽样,此元数据可描述该日期范围内此漏斗报告中所用的事件所占百分比。抽样是指分析所有数据的子集,以发现较大数据集中的有意义的信息。

JSON 表示法
{
  "samplesReadCount": string,
  "samplingSpaceSize": string
}
字段
samplesReadCount

string (int64 format)

此抽样报告中针对某一日期范围内读取的事件总数。这是此漏斗报告中分析的此媒体资源的数据大小。

samplingSpaceSize

string (int64 format)

此漏斗报告中针对某个日期范围的媒体资源中的数据可能进行分析的事件总数。抽样揭示的是有关较大数据集的有意义的信息,这就是较大数据集的大小。

要计算此漏斗报告中使用的可用数据所占的百分比,请计算 samplesReadCount/samplingSpaceSize

PropertyQuota

此 Google Analytics(分析)媒体资源的所有配额的当前状态。如果资源有任何配额已用尽,则向该资源发出的所有请求都将返回“资源用尽”错误。

JSON 表示法
{
  "tokensPerDay": {
    object (QuotaStatus)
  },
  "tokensPerHour": {
    object (QuotaStatus)
  },
  "concurrentRequests": {
    object (QuotaStatus)
  },
  "serverErrorsPerProjectPerHour": {
    object (QuotaStatus)
  },
  "potentiallyThresholdedRequestsPerHour": {
    object (QuotaStatus)
  },
  "tokensPerProjectPerHour": {
    object (QuotaStatus)
  }
}
字段
tokensPerDay

object (QuotaStatus)

标准 Analytics 媒体资源每天最多可以使用 25000 个令牌;Analytics 360 媒体资源每天最多可以使用 250000 个令牌。大部分请求消耗的令牌数都少于 10 个。

tokensPerHour

object (QuotaStatus)

标准 Analytics 媒体资源每小时最多可以使用 5000 个令牌;Analytics 360 媒体资源每小时最多可以使用 50000 个令牌。API 请求消耗单个令牌,并且该数字将从所有每小时、每日和每个项目每小时配额中扣除。

concurrentRequests

object (QuotaStatus)

标准 Analytics(分析)媒体资源最多可以发送 10 个并发请求;Analytics 360 媒体资源最多可以使用 50 个并发请求。

serverErrorsPerProjectPerHour

object (QuotaStatus)

标准 Google Analytics(分析)媒体资源和云项目对每小时最多可以出现 10 个服务器错误;Analytics 360 媒体资源和云项目对每小时最多可以出现 50 个服务器错误。

potentiallyThresholdedRequestsPerHour

object (QuotaStatus)

Google Analytics(分析)媒体资源每小时最多可以发送 120 个请求,其中可能会包含阈值阈值。在批量请求中,如果请求包含可能达到阈值的维度,则系统会针对该请求分别计算每个报告请求。

tokensPerProjectPerHour

object (QuotaStatus)

Google Analytics(分析)媒体资源每小时最多可以使用 25% 的令牌。标准 Analytics(分析)媒体资源每小时最多可以使用 1250 个令牌,Analytics 360 媒体资源每小时最多可以使用 12500 个令牌。API 请求消耗单个令牌,并且该数字将从所有每小时、每日和每个项目每小时配额中扣除。

QuotaStatus

特定配额组的当前状态。

JSON 表示法
{
  "consumed": integer,
  "remaining": integer
}
字段
consumed

integer

此请求消耗的配额。

remaining

integer

此请求后剩余配额。