Method: properties.runFunnelReport

返回包含 Google Analytics（分析）事件数据的自定义漏斗报告。该 API 返回的数据是一个表格，其中包含所请求的维度和指标。

漏斗探索可以直观呈现用户为完成任务而采取的步骤，并让您迅速了解用户在每个步骤上的成功或失败情况。例如，潜在客户是如何一步步提高购买意向并最终出手购买的？一次性买家是如何成为回头客的？根据这些信息，您可以改进低效或被用户放弃的客户转化历程。如需了解详情，请参阅 GA4 漏斗探索。

此方法是在 Alpha 版稳定性阶段推出的，目的是在进入 Beta 版之前收集有关语法和功能的反馈。如需提供您对此 API 的反馈，请填写 Google Analytics（分析）Data 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”维度进行细分，系统将会针对mobile、tablet、desktop以及总计数据创建相应的行。
funnelNextAction

object (FunnelNextAction)

可选。如果指定，“下一项”操作会向漏斗可视化子报告响应添加一个维度。此“下一个操作”维度会将每个漏斗步骤展开为下一个操作的唯一值。例如，“eventName”维度的下一项操作会针对多个事件（例如 session_start 和 click）及事件总数创建行。

“下一项”操作仅支持 eventName 和大多数网页 / 屏幕维度，例如 pageTitle 和 pagePath。
funnelVisualizationType

enum (FunnelVisualizationType)

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

object (Segment)

可选。细分的配置。细分是媒体资源数据的子集。在包含细分的漏斗报告中，每个细分中的漏斗都会进行评估。

此请求中指定的每个片段都会在响应中生成单独的一行；在响应中，每个片段均由其名称标识。

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

string (int64 format)

可选。要返回的行数。如果未指定，将返回 10,000 行。无论您请求返回多少行，每个请求最多返回 250,000 行。“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。系统也接受 NdaysAgo、yesterday 或 today 格式，在这种情况下，系统会根据媒体资源的报告时区推断日期。
endDate

string

查询的结束日期，格式为 YYYY-MM-DD。不得早于 startDate。系统也接受 NdaysAgo、yesterday 或 today 格式，在这种情况下，系统会根据媒体资源的报告时区推断日期。
name

string

用于为此日期范围指定名称。在报告响应中，维度 dateRange 使用此名称。如果设置了此字段，则不能以 date_range_ 或 RESERVED_ 开头。如果未设置，日期范围将按请求中从零开始的索引命名：date_range_0、date_range_1 等。

漏斗图

配置漏斗报告请求中的漏斗。漏斗可报告用户完成一系列步骤的情况。

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

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

boolean

在开放漏斗中，用户可以在任何步骤进入漏斗；在封闭漏斗中，用户必须在第一个步骤进入漏斗。可选。如果未指定，则使用封闭漏斗。
steps[]

object (FunnelStep)

此漏斗的后续步骤。

FunnelStep

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

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

string

此步骤的独有名称。如果未指定，步骤将使用从 1 开始编号的索引名称（例如“0. ”“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"。

FunnelFilterExpression

表示漏斗过滤器的组合。

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)

漏斗过滤器表达式列表。

FunnelFieldFilter

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

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)

两个值之间的过滤条件。

StringFilter

字符串过滤器

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，则字符串值区分大小写。

NumericFilter

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

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

BetweenFilter

表示结果需要介于两个数字（含）之间。

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

object (NumericValue)

以此数字开头。
toValue

object (NumericValue)

以此数字结尾。

FunnelEventFilter

创建一个过滤器，用于匹配具有单个事件名称的各个事件。如果指定了参数过滤器表达式，则只有同时与单个事件名称和参数过滤器表达式都匹配的事件子集匹配此事件过滤器。

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

系统将根据指定的事件参数评估此过滤器。事件参数会记录为事件的参数。事件参数包括“firebase_screen”和“currency”等字段。

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

string

系统将根据指定的项参数评估此过滤器。商品参数会作为参数记录在 item 数组中。商品参数包括“item_name”和“item_category”等字段。

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

商品参数仅适用于电子商务事件。如需详细了解电子商务事件，请参阅衡量电子商务指南。
联合字段 one_filter。指定一种过滤条件。one_filter 只能是下列其中一项：
stringFilter

object (StringFilter)

字符串相关过滤条件。
inListFilter

object (InListFilter)

列表值中的过滤器。
numericFilter

object (NumericFilter)

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

object (BetweenFilter)

两个值之间的过滤条件。

FunnelBreakdown

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

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

object (Dimension)

添加到漏斗表子报告响应的维度列。细分维度对每个漏斗步骤进行了细分。如果指定了 funnelBreakdown，则需要有效的 breakdownDimension。
limit

string (int64 format)

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

维度

“维度”是指数据的属性。例如，维度“城市”表示事件发起城市。报告响应中的维度值是字符串；例如，城市可以是“Paris”或“New York”。

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

string

维度的名称。请参阅 API 维度，了解核心报告方法（例如 runReport 和 batchRunReports）支持的维度名称列表。有关 runRealtimeReport 方法支持的维度名称列表，请参阅实时维度。如需查看 runFunnelReport 方法支持的维度名称列表，请参阅漏斗维度。

如果指定了 dimensionExpression，则 name 可以是您希望在允许的字符集中添加的任何字符串。例如，如果 dimensionExpression 将 country 和 city 串联在一起，您可以调用该维度 countryAndCity。您选择的维度名称必须与正则表达式 ^[a-zA-Z0-9_]$ 匹配。

尺寸由 name 在 dimensionFilter、orderBys、dimensionExpression 和 pivots 中引用。
dimensionExpression

object (DimensionExpression)

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

DimensionExpression

用于表示一个维度，该维度是多个维度的公式的结果。用法示例：1) lowerCase(dimension) 2) concatenate(dimension1, signed, 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(国家/地区, ", ", 城市)。

CaseExpression

用于将维度值转换为单一 case。

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

string

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

ConcatenateExpression

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

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

string

维度名称。这些名称必须引用请求的维度字段中的名称。
delimiter

string

维度名称之间的分隔符。

分隔符通常是单个字符，例如“|”或“,”，但也可以是较长的字符串。如果某个维度值包含分隔符，则这两个分隔符都会出现在响应中，不会有任何区别。例如，如果维度 1 的值 =“US,FR”，维度 2 的值 =“JP”，分隔符 =“,”，则响应将包含“US,FR,JP”。

FunnelNextAction

后续操作会指明用户完成下一步但之后该用户完成下一步骤之前的维度值。例如，如果 nextActionDimension 为 eventName，则第 i 个漏斗步骤行中的 nextActionDimension 将返回第一个事件，发生在使用户进入第 i 个漏斗步骤、但该用户尚未完成第 i+1 个漏斗步骤的事件之后。

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

object (Dimension)

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

nextActionDimension 目前仅支持 eventName 以及大多数网页 / 屏幕维度，例如 pageTitle 和 pagePath。“nextActionDimension”不能是维度表达式。
limit

string (int64 format)

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

FunnelVisualizationType

控制漏斗可视化子报告响应中显示的维度。

枚举
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)

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

UserSegment

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

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

object (UserSegmentCriteria)

定义此细分中包含哪些用户。可选。
exclusion

object (UserSegmentExclusion)

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

UserSegmentCriteria

如果用户的事件符合条件中的条件，则用户符合条件。

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

object (UserSegmentConditionGroup)

如果用户与这些 andConditionGroups 中的每一个以及每个 andSequenceGroups 都匹配，则用户与此条件相符。如果指定了 andSequenceGroups，则 andConditionGroups 可以为空。
andSequenceGroups[]

object (UserSegmentSequenceGroup)

如果用户与这些 andSequenceGroups 中的每一个以及每个 andConditionGroups 都匹配，则用户与此条件相符。如果指定了 andConditionGroups，则 andSequenceGroups 可以为空。

UserSegmentConditionGroup

条件用于指示 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)

系统会根据数据是否与此表达式匹配，将数据添加到细分中或从中排除。表达式表达维度、指标和/或参数的条件。

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

创建一个过滤器，用于匹配具有单个事件名称的各个事件。如果指定了参数过滤器表达式，则只有同时与单个事件名称和参数过滤器表达式都匹配的事件子集匹配此事件过滤器。

SegmentFilterExpressionList

细分过滤器表达式列表。

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)

两个值之间的过滤条件。

SegmentFilterScoping

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

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

boolean

如果 atAnyPointInTime 为 true，那么当此过滤条件针对请求日期范围内的所有事件的求值结果为 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)

如果指定，此过滤器会匹配同时与单个事件名称和参数过滤器表达式匹配的事件。

在参数过滤器表达式中，只有参数过滤器可用。

SegmentParameterFilterExpression

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

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

系统将根据指定的事件参数评估此过滤器。事件参数会记录为事件的参数。事件参数包括“firebase_screen”和“currency”等字段。

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

string

系统将根据指定的项参数评估此过滤器。商品参数会作为参数记录在 item 数组中。商品参数包括“item_name”和“item_category”等字段。

商品参数只能在细分和漏斗中使用，只能用于 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_SESSIONS 或 WITHIN_SAME_SESSION 时才受支持。仅当参数为 event_count 时才受支持。

例如，如果“inAnyNDayPeriod”为 3，eventName 为“purchase”，事件参数为“event_count”，且过滤条件的条件大于 5 个，则此过滤条件会累积在报表日期范围内每 3 天发生的购买事件的事件数；如果用户在任意连续 3 天内的购买事件数超过 5，则符合此过滤条件的条件会计入此细分。例如，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-01 至 2021-11-01、2021-11-01 至 2021-11-02、2021-11-01 至 2021-11-03 和 2021-11-01-1。

inAnyNDayPeriod 是可选项。如果未指定，segmentParameterFilter 会分别应用于每个事件。

UserSegmentSequenceGroup

定义用户要成为细分受众群成员所必须按特定顺序发生的条件。

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 匹配。

UserSequenceStep

使此用户符合序列的指定步骤顺序中必须出现的条件。

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)

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

UserSegmentExclusion

指定将哪些用户排除在此细分中。

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

enum (UserExclusionDuration)

指定当用户与 userExclusionCriteria 匹配时，排除项的持续时长。

可选。如果未指定，则使用 USER_EXCLUSION_TEMPORARY 的 userExclusionDuration。
userExclusionCriteria

object (UserSegmentCriteria)

如果用户满足此条件，则该用户会从 userExclusionDuration 的细分受众群中排除。

UserExclusionDuration

枚举相关选项，指定当用户与 userExclusionCriteria 匹配时，排除操作会持续多长时间。

枚举
USER_EXCLUSION_DURATION_UNSPECIFIED 未指定排除持续时间。不指定。
USER_EXCLUSION_TEMPORARY 在用户满足 userExclusionCriteria 条件期间暂时从细分中排除用户。
USER_EXCLUSION_PERMANENT 如果用户曾满足 userExclusionCriteria 条件，则从细分中永久排除用户。

SessionSegment

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

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_SESSION 的 conditionScoping。
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_TEMPORARY 的 sessionExclusionDuration。
sessionExclusionCriteria

object (SessionSegmentCriteria)

如果某个会话满足此条件，则该会话会从“sessionExclusionDuration”的细分受众群中排除。

SessionExclusionDuration

枚举相关选项，指定会话与 sessionExclusionCriteria 匹配时排除项的持续时间。

枚举
SESSION_EXCLUSION_DURATION_UNSPECIFIED 未指定排除持续时间。不指定。
SESSION_EXCLUSION_TEMPORARY 在会话满足 sessionExclusionCriteria 条件期间暂时从细分中排除会话。
SESSION_EXCLUSION_PERMANENT 从细分中永久排除会话，前提是会话曾满足 sessionExclusionCriteria 条件。

EventSegment

事件细分是在您的网站或应用上触发的一部分事件。例如，在特定位置发生的所有购买事件；在特定操作系统上发生的 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_EVENT 的 conditionScoping。
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_PERMANENT 的 eventExclusionDuration。
eventExclusionCriteria

object (EventSegmentCriteria)

如果某个事件满足此条件，系统会将该事件从 eventExclusionDuration 的细分受众群成员资格中排除。

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 中的 FilterExpressions 具有 AND 关系。
orGroup

object (FilterExpressionList)

orGroup 中的 FilterExpressions 具有 OR 关系。
notExpression

object (FilterExpression)

FilterExpression 不是 notExpression。
filter

object (Filter)

初始过滤器。在同一 FilterExpression 中，过滤器的所有字段名称都需要是所有维度或所有指标。

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)

两个值之间的过滤条件。

FunnelSubReport

漏斗子报告包含维度和指标数据值。例如，有 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

描述报告中的维度列。报告中请求的维度会在行和 DimensionHeader 中生成列条目。不过，专用于过滤器或表达式的维度不会在报告中生成列；相应地，这些维度也不会生成标题。

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

string

维度的名称。

MetricHeader

描述报告中的指标列。报告中请求的可见指标会在行和 MetricHeader 中生成列条目。不过，专用于过滤器或表达式的指标不会在报告中生成列；相应地，这些指标也不会生成标题。

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”和“eventCount”为 15 的一行如下所示：

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

object (DimensionValue)

所请求的维度值列表。在 数据透视表报告中，仅列出数据透视中包含的维度的维度值。
metricValues[]

object (MetricValue)

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

DimensionValue

维度的值。

JSON 表示法 
{

  // Union field one_value can be only one of the following:
  "value": string
  // End of list of possible types for union field one_value.
}
字段
联合字段 one_value。一类维度值 one_value 只能是下列其中一项：
value

string

以字符串表示的值（如果维度类型是字符串）。

MetricValue

指标的值。

JSON 表示法 
{

  // Union field one_value can be only one of the following:
  "value": string
  // End of list of possible types for union field one_value.
}
字段
联合字段 one_value。指标值“one_value”只能是下列其中一项：
value

string

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

FunnelResponseMetadata

漏斗报告的响应元数据包含关于漏斗报告的更多信息。

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

object (SamplingMetadata)

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

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

SamplingMetadata

如果对漏斗报告结果进行抽样，此元数据将说明在某个日期范围内此漏斗报告中使用的事件所占的百分比。抽样是指分析所有数据的一个子集，以在较大的数据集中发现有意义的信息。

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（分析）媒体资源每天最多可以使用 20 万个令牌；Analytics 360 媒体资源每天最多可以使用 200 万个令牌。大部分请求消耗的令牌数都少于 10 个。
tokensPerHour

object (QuotaStatus)

标准 Google Analytics（分析）媒体资源每小时最多可以使用 4 万个令牌；Analytics 360 媒体资源每小时最多可以使用 40 万个令牌。一个 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)

每个项目每小时最多可使用 Analytics（分析）媒体资源 35% 的令牌。标准 Google Analytics（分析）媒体资源每小时最多可以使用 14000 个令牌，而 Analytics 360 媒体资源每小时每个项目可使用 140000 个令牌。一个 API 请求使用单一数量的令牌，该数量将从每小时、每日和每个项目每小时的所有配额中扣除。

QuotaStatus

特定配额组的当前状态。

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

integer

此请求消耗的配额。
remaining

integer

提出此申请后剩余的配额。