- 资源:ReportTask
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- ReportDefinition
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- 尺寸
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- DimensionExpression
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- CaseExpression
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- ConcatenateExpression
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- 指标
- DateRange
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- FilterExpression
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- FilterExpressionList
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- 过滤
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- StringFilter
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- MatchType
- InListFilter
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- NumericFilter
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- 操作
- NumericValue
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- BetweenFilter
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- MetricAggregation
- OrderBy
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- MetricOrderBy
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- DimensionOrderBy
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- OrderType
- CohortSpec
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- 同类群组
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- CohortsRange
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- 粒度
- CohortReportSettings
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- ReportMetadata
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- 状态
- 方法
资源:ReportTask
特定报告任务配置。
JSON 表示法 |
---|
{ "name": string, "reportDefinition": { object ( |
字段 | |
---|---|
name |
仅限输出。标识符。创建期间分配的报告任务资源名称。格式:“properties/{property}/reportTasks/{reportTask}” |
reportDefinition |
可选。用于提取报告数据的报告定义,描述了报告的结构。它通常包括将包含在报告中的字段以及用于过滤数据的条件。 |
reportMetadata |
仅限输出。特定报告任务的报告元数据,用于提供报告的相关信息。它通常包括以下信息:报告的资源名称、报告状态、创建报告的时间戳等。 |
ReportDefinition
有关如何生成报告的定义。
JSON 表示法 |
---|
{ "dimensions": [ { object ( |
字段 | |
---|---|
dimensions[] |
可选。请求并显示的维度。 |
metrics[] |
可选。请求并显示的指标。 |
dateRanges[] |
可选。要读取的数据的日期范围。如果请求了多个日期范围,则每个响应行都将包含一个从零开始的日期范围索引。如果两个日期范围重叠,则重叠日期的事件数据会同时包含在这两个日期范围的响应行中。在同类群组请求中,必须未指定此 |
dimensionFilter |
可选。借助维度过滤条件,您可以只要求在报告中提供特定的维度值。要了解详情,请参阅维度过滤条件基础知识中的示例。此过滤条件中不能使用指标。 |
metricFilter |
可选。指标的过滤子句。在汇总报告行后应用,类似于 SQL 的包含子句。维度不能用于此过滤条件。 |
offset |
可选。Google Analytics 存储空间中起始行的行数。第一行计为第 0 行。 创建报告任务时, |
limit |
可选。要在报告中返回的行数。如果未指定,则返回 10,000 行。无论您要求返回多少行,对于每个请求,API 最多只能返回 25 万行。 如果维度值没有 |
metricAggregations[] |
可选。指标汇总。汇总的指标值显示在维度值设为“RESERVED_(MetricAggregation)”的行中。 |
orderBys[] |
可选。指定响应中各行的排序方式。 |
currencyCode |
可选。采用 ISO4217 格式的货币代码,例如“AED”“USD”“JPY”。如果此字段为空,报告将使用媒体资源的默认货币。 |
cohortSpec |
可选。与此请求关联的同类群组。如果请求中包含同类群组组,则为“同类群组”维度。 |
keepEmptyRows |
可选。如果为 false 或未指定,则系统不会返回所有指标都等于 0 的每一行。如果为 true,系统将返回这些行,前提是它们没有被过滤器单独移除。 无论这项 例如,如果媒体资源从不记录 |
维度
“维度”是指数据的属性。例如,“城市”维度表示事件发起城市。报告响应中的维度值是字符串;例如,城市可以是“巴黎”或“纽约”
JSON 表示法 |
---|
{
"name": string,
"dimensionExpression": {
object ( |
字段 | |
---|---|
name |
维度的名称。有关核心报告方法(例如 如果指定了 维度由 |
dimensionExpression |
一个维度可以是多个维度表达式的结果。例如,维度“国家/地区, 城市”:concatenate(country, ", ", city)。 |
DimensionExpression
用于表示由多个维度的公式计算得出的维度。用法示例:1) lowerCase(维度) 2) concatenate(dimension1, sign, dimension2)。
JSON 表示法 |
---|
{ // Union field |
字段 | |
---|---|
联合字段 one_expression 。为 DimensionExpression 指定一种类型的维度表达式。one_expression 只能是下列其中一项: |
|
lowerCase |
用于将维度值转换为小写。 |
upperCase |
用于将维度值转换为大写。 |
concatenate |
用于将多个维度值合并为一个维度。例如,维度“国家/地区, 城市”:concatenate(country, ", ", city)。 |
CaseExpression
用于将维度值转换为单一 case。
JSON 表示法 |
---|
{ "dimensionName": string } |
字段 | |
---|---|
dimensionName |
维度的名称。该名称必须引用请求的维度字段中的名称。 |
ConcatenateExpression
用于将多个维度值合并为一个维度。
JSON 表示法 |
---|
{ "dimensionNames": [ string ], "delimiter": string } |
字段 | |
---|---|
dimensionNames[] |
维度的名称。这些名称必须引用请求的维度字段中的名称。 |
delimiter |
维度名称之间的分隔符。 分隔符通常是单个字符,如“|”或“,”但可以是较长的字符串。如果某个维度值包含分隔符,它们会同时出现在响应中且没有区别。例如,如果维度 1 的值 =“US,FR”,维度 2 的值 =“JP”,分隔符 =“,”,则响应将包含“US,FR,JP”。 |
指标
报告的量化衡量标准。例如,eventCount
指标表示事件总数。最多允许请求 10 个指标。
JSON 表示法 |
---|
{ "name": string, "expression": string, "invisible": boolean } |
字段 | |
---|---|
name |
指标的名称。有关核心报告方法(例如 如果指定了
|
expression |
派生指标的数学表达式。例如,“每位用户的事件数”指标为 |
invisible |
指明某个指标是否在报告响应中不可见。如果某个指标不可见,则它不会在响应中生成列,但可以在 |
DateRange
一组连续的日期:startDate
、startDate + 1
、...、endDate
。最多允许 4 个日期范围。
JSON 表示法 |
---|
{ "startDate": string, "endDate": string, "name": string } |
字段 | |
---|---|
startDate |
查询的开始日期(包含此日期),格式为 |
endDate |
查询的结束日期(包含此结束日期),格式为 |
name |
为此日期范围指定名称。报告响应中,维度“ |
FilterExpression
表示维度或指标过滤条件。同一过滤器表达式中的字段必须是所有维度或所有指标。
JSON 表示法 |
---|
{ // Union field |
字段 | |
---|---|
联合字段 expr 。为 FilterExpression 指定一种类型的过滤器表达式。expr 只能是下列其中一项: |
|
andGroup |
andGroup 中的 Filter 表达式具有 AND 关系。 |
orGroup |
orGroup 中的 Filter 表达式具有 OR 关系。 |
notExpression |
Filter 表达式 不是 notExpress 表达式。 |
filter |
原初过滤器。在同一个过滤器表达式中,过滤器的所有字段名称必须是所有维度或所有指标。 |
FilterExpressionList
过滤表达式列表。
JSON 表示法 |
---|
{
"expressions": [
{
object ( |
字段 | |
---|---|
expressions[] |
过滤表达式列表。 |
过滤
用于过滤维度或指标值的表达式。
JSON 表示法 |
---|
{ "fieldName": string, // Union field |
字段 | |
---|---|
fieldName |
维度名称或指标名称。必须是维度或指标中定义的名称。 |
联合字段 one_filter 。为 Filter 指定一种类型的过滤条件。one_filter 只能是下列其中一项: |
|
stringFilter |
与字符串相关的过滤条件。 |
inListFilter |
列表中值的过滤条件。 |
numericFilter |
数值或日期值的过滤器。 |
betweenFilter |
介于两个值之间的过滤条件。 |
StringFilter
字符串的过滤器
JSON 表示法 |
---|
{
"matchType": enum ( |
字段 | |
---|---|
matchType |
此过滤器的匹配类型。 |
value |
用于匹配的字符串值。 |
caseSensitive |
如果为 true,则字符串值区分大小写。 |
MatchType
字符串过滤条件的匹配类型
枚举 | |
---|---|
MATCH_TYPE_UNSPECIFIED |
未指定 |
EXACT |
与字符串值完全匹配。 |
BEGINS_WITH |
以字符串值开头。 |
ENDS_WITH |
以字符串值结尾。 |
CONTAINS |
包含字符串值。 |
FULL_REGEXP |
具有字符串值的正则表达式的完全匹配。 |
PARTIAL_REGEXP |
具有字符串值的正则表达式的部分匹配。 |
InListFilter
结果必须是字符串值列表。
JSON 表示法 |
---|
{ "values": [ string ], "caseSensitive": boolean } |
字段 | |
---|---|
values[] |
字符串值列表。不得为空。 |
caseSensitive |
如果为 true,则字符串值区分大小写。 |
NumericFilter
用于过滤数字值或日期值。
JSON 表示法 |
---|
{ "operation": enum ( |
字段 | |
---|---|
operation |
此过滤器的操作类型。 |
value |
数值或日期值。 |
操作
对数值过滤器应用的运算
枚举 | |
---|---|
OPERATION_UNSPECIFIED |
未指定。 |
EQUAL |
等于 |
LESS_THAN |
小于 |
LESS_THAN_OR_EQUAL |
小于或等于 |
GREATER_THAN |
大于 |
GREATER_THAN_OR_EQUAL |
大于或等于 |
NumericValue
用于表示数字。
JSON 表示法 |
---|
{ // Union field |
字段 | |
---|---|
联合字段 one_value 。数值 one_value 只能是下列其中一项: |
|
int64Value |
整数值 |
doubleValue |
DoubleValue |
BetweenFilter
用于表示结果需要介于两个数字(包括这两个数字)之间。
JSON 表示法 |
---|
{ "fromValue": { object ( |
字段 | |
---|---|
fromValue |
以此数字开头。 |
toValue |
以此数字结尾。 |
MetricAggregation
表示指标的汇总。
枚举 | |
---|---|
METRIC_AGGREGATION_UNSPECIFIED |
未指定的运算符。 |
TOTAL |
SUM 运算符。 |
MINIMUM |
最小运算符。 |
MAXIMUM |
运算符数量上限。 |
COUNT |
计数运算符。 |
OrderBy
排序依据定义了响应中的行排序方式。例如,按事件数降序对行进行排序,按事件名称字符串对行排序是一种不同的排序。
JSON 表示法 |
---|
{ "desc": boolean, // Union field |
字段 | |
---|---|
desc |
如果为 true,则按降序排序。 |
联合字段 one_order_by 。为 OrderBy 指定一种排序依据类型。one_order_by 只能是下列其中一项: |
|
metric |
按指标值对结果进行排序。 |
dimension |
按维度值对结果进行排序。 |
MetricOrderBy
按指标值排序。
JSON 表示法 |
---|
{ "metricName": string } |
字段 | |
---|---|
metricName |
排序依据请求中的指标名称。 |
DimensionOrderBy
按维度值排序。
JSON 表示法 |
---|
{
"dimensionName": string,
"orderType": enum ( |
字段 | |
---|---|
dimensionName |
排序依据的请求中的维度名称。 |
orderType |
控制维度值排序规则。 |
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”。非数字维度值在所有数值下方均具有相同的排序值。 |
CohortSpec
同类群组报告的同类群组规范。
同类群组报告会为同类群组创建用户留存率时间序列。例如,您可以选择在 9 月第一周获取的用户同类群组,并在接下来的 6 周内关注该同类群组。在 cohort
对象中指定在 9 月同类群组的第 1 周获取的用户。在 cohortsRange
对象中指定该同类群组后接下来的六周。
如需查看示例,请参阅同类群组报告示例。
报告响应可以显示每周时间序列,其中您的应用在 3 周后保留了该同类群组的 60%,在 6 周后保留了该同类群组的 25%。这两个百分比可以按“cohortActiveUsers/cohortTotalUsers
”指标计算,在报告中显示为单独的行。
JSON 表示法 |
---|
{ "cohorts": [ { object ( |
字段 | |
---|---|
cohorts[] |
定义将用户划分到同类群组的选择条件。 大多数同类群组报告仅定义一个同类群组。如果指定了多个同类群组,则在报告中可以通过每个同类群组的名称识别每个同类群组。 |
cohortsRange |
同类群组报告跟踪的是在更长的报告日期范围内的同类群组。此范围指定同类群组的偏移时长。 |
cohortReportSettings |
同类群组报告的可选设置。 |
同类群组
定义同类群组选择条件。同类群组是具有共同特征的一组用户。例如,具有相同 firstSessionDate
的用户属于同一个同类群组。
JSON 表示法 |
---|
{
"name": string,
"dimension": string,
"dateRange": {
object ( |
字段 | |
---|---|
name |
为此同类群组指定名称。报告响应中,维度“ |
dimension |
同类群组使用的维度。必需,且仅支持 |
dateRange |
同类群组选择首次接触日期介于 在同类群组请求中,此 此 |
CohortsRange
为同类群组报告配置延长的报告日期范围。指定同类群组的偏移时长。
JSON 表示法 |
---|
{
"granularity": enum ( |
字段 | |
---|---|
granularity |
必需。用于解读同类群组报告的扩大报告日期范围内的 |
startOffset |
如果 如果 如果 |
endOffset |
必需。 如果 如果 如果 |
粒度
用于解读同类群组报告的扩大报告日期范围内的startOffset
和endOffset
的粒度。
枚举 | |
---|---|
GRANULARITY_UNSPECIFIED |
不应指定。 |
DAILY |
按天细分。通常在同类群组的 dateRange 为一天且请求包含 cohortNthDay 时使用。 |
WEEKLY |
按周细分。如果同类群组的 dateRange 持续一周(从星期日开始到星期六结束),并且请求包含 cohortNthWeek ,通常使用这种方式。 |
MONTHLY |
按月细分。如果同类群组的 dateRange 为一个月且请求包含 cohortNthMonth ,则通常使用此属性。 |
CohortReportSettings
同类群组报告的可选设置。
JSON 表示法 |
---|
{ "accumulate": boolean } |
字段 | |
---|---|
accumulate |
如果为 true,则累计从首次联系日到结束日的结果。在 |
ReportMetadata
特定报告任务的报告元数据。
JSON 表示法 |
---|
{
"creationQuotaTokensCharged": integer,
"state": enum ( |
字段 | |
---|---|
creationQuotaTokensCharged |
仅限输出。报告创建期间收取的配额令牌总数。由于此令牌数量取决于处于 |
state |
仅限输出。此报告任务的当前状态。 |
beginCreatingTime |
仅限输出。调用 时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例: |
taskRowCount |
仅限输出。报告结果中的总行数。如果状态为活跃,系统会填充此字段。您可以在现有报告范围内使用 |
errorMessage |
仅限输出。如果报告任务在创建过程中失败,系统会填充错误消息。 |
totalRowCount |
仅限输出。Google Analytics 存储空间中的总行数。如果您想查询当前报告之外的其他数据行,它们可以根据
例如,假设当前报告的 |
州
处理状态。
枚举 | |
---|---|
STATE_UNSPECIFIED |
绝不会使用未指定的状态。 |
CREATING |
该报告目前正在创建中,将在未来可用。调用 CreateReport 后立即创建。 |
ACTIVE |
报告已完全创建,可以进行查询了。 |
FAILED |
未能创建报告。 |
方法 |
|
---|---|
|
开始创建报告任务。 |
|
获取有关特定报告任务的报告元数据。 |
|
列出媒体资源的所有报告任务。 |
|
检索报告任务的内容。 |