MCP Tools Reference: analyticsdata.googleapis.com

工具：run_report

返回包含 Google Analytics 事件数据的自定义报告。

以下示例演示了如何使用 curl 调用 run_report MCP 工具。

Curl 请求 
                  
curl --location 'https://analyticsdata.googleapis.com/mcp/v1' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "run_report",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

输入架构

生成报告的请求。

RunReportRequest

JSON 表示法 
{
  "property": string,
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean,
  "comparisons": [
    {
      object (Comparison)
    }
  ]
}
字段
property

string

要跟踪其事件的 Google Analytics 媒体资源标识符。在网址路径中指定，而不是在正文中指定。如需了解详情，请参阅在哪里查找媒体资源 ID。在批处理请求中，此属性应未指定或与批处理级属性保持一致。

示例：properties/1234
dimensions[]

object (Dimension)

所请求和显示的维度。
metrics[]

object (Metric)

请求和显示的指标。
dateRanges[]

object (DateRange)

要读取的数据的日期范围。如果请求了多个日期范围，则每个响应行都将包含一个从零开始的日期范围索引。如果两个日期范围重叠，则重叠日期的事件数据会包含在两个日期范围的响应行中。在同类群组请求中，此 dateRanges 必须处于未指定状态。
dimensionFilter

object (FilterExpression)

借助维度过滤条件，您可以要求报告中仅显示特定的维度值。如需了解详情，请参阅维度过滤条件基础知识，其中包含相关示例。此过滤条件不支持使用指标。
metricFilter

object (FilterExpression)

指标的过滤条件子句。在汇总报告的行后应用，类似于 SQL 的 having 子句。此过滤条件中不能使用维度。
offset

string (int64 format)

起始行的行数。第一行计为第 0 行。

分页时，第一个请求不指定偏移量；或者等效地将偏移量设置为 0；第一个请求返回前 limit 行。第二个请求将偏移量设置为第一个请求的 limit；第二个请求返回第二个 limit 行。

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

string (int64 format)

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

如果维度值的数量少于 limit，API 也可以返回少于所请求 limit 的行。例如，维度 country 的可能值少于 300 个，因此在仅针对 country 生成报告时，即使您将 limit 设置为更高的值，也无法获得超过 300 行的数据。

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

enum (MetricAggregation)

指标的聚合。汇总指标值将显示在 dimension_values 设置为“RESERVED_(MetricAggregation)”的行中。包含比较和多个日期范围的汇总将根据日期范围进行汇总。
orderBys[]

object (OrderBy)

指定响应中各行的排序方式。如果请求同时包含比较和多个日期范围，则会针对比较应用排序。
currencyCode

string

采用 ISO4217 格式的币种代码，例如“AED”“USD”“JPY”。如果该字段为空，报告将使用媒体资源的默认币种。
cohortSpec

object (CohortSpec)

与此请求关联的同类群组。如果请求中包含同类群组，则必须包含“cohort”维度。
keepEmptyRows

boolean

如果为 false 或未指定，则不会返回所有指标都等于 0 的每一行。如果为 true，则在未被过滤器单独移除的情况下，系统会返回这些行。

无论此 keep_empty_rows 设置如何，报告中都只能显示 Google Analytics 媒体资源记录的数据。

例如，如果某媒体资源从未记录过 purchase 事件，那么针对 eventName 维度和 eventCount 指标的查询将不会包含 eventName: "purchase" 和 eventCount: 0 的行。
returnPropertyQuota

boolean

切换是否返回相应 Google Analytics 媒体资源的配额的当前状态。配额将在 PropertyQuota 中返回。
comparisons[]

object (Comparison)

可选。所请求和显示的比较配置。该请求只需要一个 comparisons 字段，即可在响应中收到比较列。

维度

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

string

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

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

维度在 dimensionFilter、orderBys、dimensionExpression 和 pivots 中由 name 引用。
dimensionExpression

object (DimensionExpression)

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

DimensionExpression

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

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

string

维度的名称。该名称必须指回请求的维度字段中的某个名称。

ConcatenateExpression

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

string

维度的名称。这些名称必须与请求的维度字段中的名称相对应。
delimiter

string

放置在维度名称之间的分隔符。

分隔符通常是单个字符，例如“|”或“,”，但也可以是较长的字符串。如果维度值包含分隔符，则两者都会显示在响应中，但不会区分。例如，如果维度 1 的值为“US,FR”，维度 2 的值为“JP”，分隔符为“,”，则响应将包含“US,FR,JP”。

指标

JSON 表示法 
{
  "name": string,
  "expression": string,
  "invisible": boolean
}
字段
name

string

相应指标的名称。如需查看核心报告方法（例如 runReport 和 batchRunReports）支持的指标名称列表，请参阅 API 指标。如需查看 runRealtimeReport 方法支持的指标名称列表，请参阅实时指标。如需查看 runFunnelReport 方法支持的指标名称列表，请参阅漏斗图指标。

如果指定了 expression，则 name 可以是您希望使用的任何字符串，但必须在允许的字符集内。例如，如果 expression 为 screenPageViews/sessions，您可以将相应指标的名称设为 viewsPerSession。您选择的指标名称必须与正则表达式 ^[a-zA-Z0-9_]$ 匹配。

指标在 metricFilter、orderBys 和指标 expression 中通过 name 进行引用。
expression

string

派生指标的数学表达式。例如，“每位用户的事件数”指标为 eventCount/totalUsers。
invisible

boolean

指示指标在报告响应中是否不可见。如果某个指标处于不可见状态，则该指标不会在响应中生成列，但可用于 metricFilter、orderBys 或指标 expression。

DateRange

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

string

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

string

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

string

为相应日期范围分配名称。在报告响应中，维度 dateRange 的值为此名称。如果设置，则不能以 date_range_ 或 RESERVED_ 开头。如果未设置，日期范围将按其在请求中的从零开始的索引命名：date_range_0、date_range_1 等。

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)

and_group 中的 FilterExpressions 具有 AND 关系。
orGroup

object (FilterExpressionList)

or_group 中的 FilterExpression 具有 OR 关系。
notExpression

object (FilterExpression)

FilterExpression 不是 not_expression。
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)
  },
  "emptyFilter": {
    object (EmptyFilter)
  }
  // End of list of possible types for union field one_filter.
}
字段
fieldName

string

维度名称或指标名称。

在大多数方法中，维度和指标可以首次在此字段中使用。不过，在 RunPivotReportRequest 中，此字段还必须在 RunPivotReportRequest 的维度或指标中按名称指定。
联合字段 one_filter。为 Filter 指定一种过滤条件类型。one_filter 只能是下列其中一项：
stringFilter

object (StringFilter)

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

object (InListFilter)

用于过滤列表中的值的过滤条件。
numericFilter

object (NumericFilter)

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

object (BetweenFilter)

一种用于过滤两个值的过滤条件。
emptyFilter

object (EmptyFilter)

用于过滤空值（例如“（未设置）”值和“”值）的过滤条件。

StringFilter

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

enum (MatchType)

相应过滤条件的匹配类型。
value

string

用于匹配的字符串值。
caseSensitive

boolean

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

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)

数值或日期值。

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)

以该数字结尾。

OrderBy

JSON 表示法 
{
  "desc": boolean,

  // Union field one_order_by can be only one of the following:
  "metric": {
    object (MetricOrderBy)
  },
  "dimension": {
    object (DimensionOrderBy)
  },
  "pivot": {
    object (PivotOrderBy)
  }
  // End of list of possible types for union field one_order_by.
}
字段
desc

boolean

如果为 true，则按降序排序。
联合字段 one_order_by。为 OrderBy 指定一种排序依据类型。one_order_by 只能是下列其中一项：
metric

object (MetricOrderBy)

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

object (DimensionOrderBy)

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

object (PivotOrderBy)

按数据透视列组中的指标值对结果进行排序。

MetricOrderBy

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

string

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

DimensionOrderBy

JSON 表示法 
{
  "dimensionName": string,
  "orderType": enum (OrderType)
}
字段
dimensionName

string

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

enum (OrderType)

控制维度值排序的规则。

PivotOrderBy

JSON 表示法 
{
  "metricName": string,
  "pivotSelections": [
    {
      object (PivotSelection)
    }
  ]
}
字段
metricName

string

在“按顺序排列”的响应中，按此列对行进行排序。必须是请求中的指标名称。
pivotSelections[]

object (PivotSelection)

用于选择维度名称和值透视。如果指定了多个透视选择，则排序会发生在所有透视选择维度名称和值对都与相应行的维度名称和值对匹配的行上。

PivotSelection

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

string

必须是请求中的维度名称。
dimensionValue

string

仅当指定维度的值为此值时才进行排序。

CohortSpec

JSON 表示法 
{
  "cohorts": [
    {
      object (Cohort)
    }
  ],
  "cohortsRange": {
    object (CohortsRange)
  },
  "cohortReportSettings": {
    object (CohortReportSettings)
  }
}
字段
cohorts[]

object (Cohort)

定义将用户分组到同类群组中的选择条件。

大多数同类群组报告仅定义一个同类群组。如果指定了多个同类群组，则可以在报告中按名称识别每个同类群组。
cohortsRange

object (CohortsRange)

同类群组报告会在较长的报告日期范围内跟踪同类群组。此范围指定了要跟踪的同群组的偏移时长。
cohortReportSettings

object (CohortReportSettings)

同类群组报告的可选设置。

同类群组

JSON 表示法 
{
  "name": string,
  "dimension": string,
  "dateRange": {
    object (DateRange)
  }
}
字段
name

string

为此群组分配名称。在报告响应中，维度 cohort 的值为此名称。如果设置，则不能以 cohort_ 或 RESERVED_ 开头。如果未设置，则根据从零开始的指数 cohort_0、cohort_1 等为同类群组命名。
dimension

string

同类群组使用的维度。必需，且仅支持 firstSessionDate。
dateRange

object (DateRange)

同类群组会选择首次接触日期介于 dateRange 中定义的开始日期和结束日期之间的用户。此 dateRange 未指定同类群组报告中显示的事件数据的完整日期范围。在同类群组报告中，此 dateRange 会根据 cohortsRange 中存在的粒度和偏移量进行扩展；扩展后的报告日期范围对应的事件数据会显示在同类群组报告中。

在同类群组请求中，此 dateRange 是必需的，并且 RunReportRequest 或 RunPivotReportRequest 中的 dateRanges 必须未指定。

此 dateRange 通常应与同群组的粒度保持一致。如果 CohortsRange 使用的是每日粒度，则此 dateRange 可以是单日。如果 CohortsRange 使用的是每周粒度，则此 dateRange 可以与周边界对齐，从周日开始到周六结束。如果 CohortsRange 使用的是月级粒度，则此 dateRange 可以与一个月对齐，从当月的第一天开始，到当月的最后一天结束。

CohortsRange

JSON 表示法 
{
  "granularity": enum (Granularity),
  "startOffset": integer,
  "endOffset": integer
}
字段
granularity

enum (Granularity)

必需。用于解读同类群组报告的扩展报告日期范围的 startOffset 和 endOffset 的粒度。
startOffset

integer

startOffset 用于指定同类群组报告的延长报告日期范围的开始日期。startOffset 通常设置为 0，以便报告包含从相应同群组的获取日期开始的数据。

如果 granularity 为 DAILY，则扩展报告日期范围的 startDate 为同类群组的 startDate 加上 startOffset 天。

如果 granularity 为 WEEKLY，则扩展报告日期范围的 startDate 为同类群组的 startDate 加上 startOffset * 7 天。

如果 granularity 为 MONTHLY，则扩展报告日期范围的 startDate 为同类群组的 startDate 加上 startOffset * 30 天。
endOffset

integer

必需。endOffset 用于指定同类群组报告的扩展报告日期范围的结束日期。endOffset 可以是任何正整数，但通常设置为 5 到 10，以便报告包含未来几个时间粒度的时间段的同类群组数据。

如果 granularity 为 DAILY，则扩展报告日期范围的 endDate 为同类群组的 endDate 加上 endOffset 天。

如果 granularity 为 WEEKLY，则扩展报告日期范围的 endDate 为同类群组的 endDate 加上 endOffset * 7 天。

如果 granularity 为 MONTHLY，则扩展报告日期范围的 endDate 为同类群组的 endDate 加上 endOffset * 30 天。

CohortReportSettings

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

boolean

如果为 true，则从首次触达日期到结束日期累积结果。在 RunReportRequest 中不受支持。

比较

JSON 表示法 
{

  // Union field _name can be only one of the following:
  "name": string
  // End of list of possible types for union field _name.

  // Union field one_comparison can be only one of the following:
  "dimensionFilter": {
    object (FilterExpression)
  },
  "comparison": string
  // End of list of possible types for union field one_comparison.
}
字段

联合字段 _name。

_name 只能是下列其中一项：
name

string

每次比较都会在响应中生成单独的行。在响应中，此比较对象将通过此名称进行标识。如果未指定名称，我们将使用已保存的比较的显示名称。
联合字段 one_comparison。一种比较值 one_comparison 只能是以下值之一：
dimensionFilter

object (FilterExpression)

基本比较。
comparison

string

由比较对象的资源名称标识的已保存比较对象。例如，'comparisons/1234'。

MatchType

字符串过滤器的匹配类型

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

操作

应用于数字过滤器的操作

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

MetricAggregation

表示指标的汇总。

枚举
METRIC_AGGREGATION_UNSPECIFIED 未指定运算符。
TOTAL SUM 运算符。
MINIMUM 最小值运算符。
MAXIMUM 最大值运算符。
COUNT Count 运算符。

OrderType

用于对字符串维度值进行排序的规则。

枚举
ORDER_TYPE_UNSPECIFIED 未指定。
ALPHANUMERIC 按 Unicode 码位进行字母数字排序。例如，“2”<“A”<“X”<“b”<“z”。
CASE_INSENSITIVE_ALPHANUMERIC 按小写 Unicode 码位进行不区分大小写的字母数字排序。例如，“2”<“A”<“b”<“X”<“z”。
NUMERIC 维度值会在排序之前转换为数字。例如，在 NUMERIC 排序中，“25”<“100”，而在 ALPHANUMERIC 排序中，“100”<“25”。所有非数值维度值的排序值都相等，且低于所有数值。

粒度

用于解读同类群组报告的扩展报告日期范围的 startOffset 和 endOffset 的粒度。

枚举
GRANULARITY_UNSPECIFIED 切勿指定。
DAILY 每日粒度。如果群组的 dateRange 为单日，且请求包含 cohortNthDay，则通常使用此值。
WEEKLY 每周粒度。如果群组的 dateRange 为一周（从周日开始到周六结束），且请求包含 cohortNthWeek，则通常使用此函数。
MONTHLY 月度粒度。如果群组的 dateRange 为一个月，且请求包含 cohortNthMonth，则通常使用此值。

输出架构

与请求对应的响应报告表。

RunReportResponse

JSON 表示法 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "metadata": {
    object (ResponseMetaData)
  },
  "propertyQuota": {
    object (PropertyQuota)
  },
  "kind": string
}
字段
dimensionHeaders[]

object (DimensionHeader)

描述维度列。DimensionHeaders 的数量和顺序与行中存在的维度一致。
metricHeaders[]

object (MetricHeader)

描述指标列。MetricHeaders 的数量和顺序与行中存在的指标相匹配。
rows[]

object (Row)

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

object (Row)

如果请求了指标，则为指标的总计值。
maximums[]

object (Row)

如果请求，则为指标的最大值。
minimums[]

object (Row)

如果请求，则为指标的最小值。
rowCount

integer

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

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

object (ResponseMetaData)

报告的元数据。
propertyQuota

object (PropertyQuota)

相应 Google Analytics 媒体资源的配额状态（包括此请求）。
kind

string

指明相应消息所属的资源种类。此 kind 始终为固定字符串“analyticsData#runReport”。有助于区分 JSON 中的响应类型。

DimensionHeader

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

string

维度的名称。

MetricHeader

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

string

指标的名称。
type

enum (MetricType)

指标的数据类型。

行

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

object (DimensionValue)

所请求的维度值列表。在 PivotReport 中，仅列出透视中包含的维度的 dimension_values。
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 以了解类型。

ResponseMetaData

JSON 表示法 
{
  "dataLossFromOtherRow": boolean,
  "samplingMetadatas": [
    {
      object (SamplingMetadata)
    }
  ],

  // Union field _schema_restriction_response can be only one of the following:
  "schemaRestrictionResponse": {
    object (SchemaRestrictionResponse)
  }
  // End of list of possible types for union field _schema_restriction_response.

  // Union field _currency_code can be only one of the following:
  "currencyCode": string
  // End of list of possible types for union field _currency_code.

  // Union field _time_zone can be only one of the following:
  "timeZone": string
  // End of list of possible types for union field _time_zone.

  // Union field _empty_reason can be only one of the following:
  "emptyReason": string
  // End of list of possible types for union field _empty_reason.

  // Union field _subject_to_thresholding can be only one of the following:
  "subjectToThresholding": boolean
  // End of list of possible types for union field _subject_to_thresholding.
}
字段
dataLossFromOtherRow

boolean

如果为 true，则表示某些维度组合的桶会汇总到“（其他）”行中。高基数报告可能会出现这种情况。

metadata 参数 dataLossFromOtherRow 会根据报告中使用的汇总数据表进行填充。无论报告中存在哪些过滤条件和限制，系统都会准确填充相应参数。

例如，由于请求包含针对 sessionSource = google 的过滤条件，因此报告中可能会舍弃“(other)”行。如果用于生成此报告的输入汇总数据中存在来自其他行的数据丢失，系统仍会填充此参数。

如需了解详情，请参阅“（其他）”行和数据抽样简介。
samplingMetadatas[]

object (SamplingMetadata)

如果此报告的结果是抽样的，则此属性会说明此报告中使用的事件百分比。每个日期范围都会填充一个 samplingMetadatas。每个 samplingMetadatas 对应于请求中指定的日期范围（按日期范围在请求中指定的顺序）。

不过，如果结果未经过抽样，则不会定义此字段。

联合字段 _schema_restriction_response。

_schema_restriction_response 只能是下列其中一项：
schemaRestrictionResponse

object (SchemaRestrictionResponse)

描述了在创建此报告时有效实施的架构限制。如需了解详情，请参阅访问权限和数据限制管理。

联合字段 _currency_code。

_currency_code 只能是下列其中一项：
currencyCode

string

相应报告中使用的币种代码。旨在用于格式化货币指标（例如 purchaseRevenue）以进行可视化。如果请求中指定了 currency_code，此响应参数将与请求参数相同；否则，此响应参数将是房源的当前 currency_code。

货币代码是 ISO 4217 标准 (https://en.wikipedia.org/wiki/ISO_4217) 中货币类型的字符串编码；例如“USD”“EUR”“JPY”。如需了解详情，请访问 https://support.google.com/analytics/answer/9796179。

联合字段 _time_zone。

_time_zone 只能是下列其中一项：
timeZone

string

房源的当前时区。旨在用于解读基于时间的维度，例如 hour 和 minute。格式为 IANA 时区数据库 (https://www.iana.org/time-zones) 中的字符串；例如“America/New_York”或“Asia/Tokyo”。

联合字段 _empty_reason。

_empty_reason 只能是下列其中一项：
emptyReason

string

如果指定了空原因，则报告为空。

联合字段 _subject_to_thresholding。

_subject_to_thresholding 只能是下列其中一项：
subjectToThresholding

boolean

如果 subjectToThresholding 为 true，则此报告会受到最低数据量要求的限制，并且仅返回达到最低汇总数据量要求的数据。如果所有数据都高于阈值，则请求可能会受到阈值处理，但报告中不会缺少任何数据。如需了解详情，请参阅最低数据量。

SchemaRestrictionResponse

JSON 表示法 
{
  "activeMetricRestrictions": [
    {
      object (ActiveMetricRestriction)
    }
  ]
}
字段
activeMetricRestrictions[]

object (ActiveMetricRestriction)

在创建报告时主动强制执行的所有限制。例如，purchaseRevenue 始终具有限制类型 REVENUE_DATA。不过，只有当用户的自定义角色禁止访问 REVENUE_DATA 时，才会填充此有效响应限制。

ActiveMetricRestriction

JSON 表示法 
{
  "restrictedMetricTypes": [
    enum (RestrictedMetricType)
  ],

  // Union field _metric_name can be only one of the following:
  "metricName": string
  // End of list of possible types for union field _metric_name.
}
字段
restrictedMetricTypes[]

enum (RestrictedMetricType)

相应指标受到限制的原因。

联合字段 _metric_name。

_metric_name 只能是下列其中一项：
metricName

string

受限指标的名称。

SamplingMetadata

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

string (int64 format)

相应日期范围内此抽样报告中读取的事件总数。这是相应媒体资源的数据子集的大小，该子集的数据已在此报告中进行分析。
samplingSpaceSize

string (int64 format)

相应日期范围内，相应媒体资源的数据中可在此报告中进行分析的事件总数。抽样可发掘出有关更大数据集的有意义信息，而这是更大数据集的大小。

如需计算此报告中使用的可用数据百分比，请计算 samplesReadCount/samplingSpaceSize。

PropertyQuota

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

object (QuotaStatus)

标准 Google Analytics 媒体资源每天最多可以使用 20 万个令牌；Google Analytics 360 媒体资源每天可以使用 200 万个令牌。大部分请求消耗的令牌数都少于 10 个。
tokensPerHour

object (QuotaStatus)

标准 Google Analytics 媒体资源每小时最多可以使用 4 万个令牌；Google Analytics 360 媒体资源每小时可以使用 40 万个令牌。一个 API 请求会消耗一定数量的令牌，该数量会从所有的小时配额、每日配额和每个项目的小时配额中扣除。
concurrentRequests

object (QuotaStatus)

标准 Google Analytics 媒体资源最多可以同时发送 10 个请求；Google Analytics 360 媒体资源最多可以同时发送 50 个请求。
serverErrorsPerProjectPerHour

object (QuotaStatus)

标准版 Google Analytics 媒体资源和云项目对每小时最多可以有 10 个服务器错误；Analytics 360 媒体资源和云项目对每小时最多可以有 50 个服务器错误。
potentiallyThresholdedRequestsPerHour

object (QuotaStatus)

Google Analytics 媒体资源每小时最多可以发送 120 个包含可能达到阈值的维度的请求。在批量请求中，如果报告请求包含可能受阈值限制的维度，则每个报告请求都会单独计入此配额。
tokensPerProjectPerHour

object (QuotaStatus)

Google Analytics 媒体资源每小时每个项目最多可以使用 35% 的令牌。也就是说，标准 Google Analytics 媒体资源每小时每个项目最多可以使用 14,000 个令牌，而 Google Analytics 360 媒体资源每小时每个项目最多可以使用 140,000 个令牌。一个 API 请求会消耗一定数量的令牌，该数量会从所有的小时配额、每日配额和每个项目的小时配额中扣除。

QuotaStatus

JSON 表示法 
{

  // Union field _consumed can be only one of the following:
  "consumed": integer
  // End of list of possible types for union field _consumed.

  // Union field _remaining can be only one of the following:
  "remaining": integer
  // End of list of possible types for union field _remaining.
}
字段

联合字段 _consumed。

_consumed 只能是下列其中一项：
consumed

integer

相应请求消耗的配额。

联合字段 _remaining。

_remaining 只能是下列其中一项：
remaining

integer

此请求后的剩余配额。

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 以公里为单位的长度；一种特殊的浮点类型。

RestrictedMetricType

您可能无法在某些 Google Analytics 媒体资源中查看的数据类别。

枚举
RESTRICTED_METRIC_TYPE_UNSPECIFIED 未指定的类型。
COST_DATA 费用指标，例如 adCost。
REVENUE_DATA 收入指标，例如 purchaseRevenue。

工具注释

破坏性提示：❌ | 等幂性提示：✅ | 只读提示：✅ | 开放世界提示：✅