REST Resource: properties.reportTasks

{
  "name": string,
  "reportDefinition": {
    object (ReportDefinition)
  },
  "reportMetadata": {
    object (ReportMetadata)
  }
}

string

仅限输出。标识符。创建报告任务时分配的资源名称。格式：“properties/{property}/reportTasks/{reportTask}”

object (ReportDefinition)

可选。用于提取报告数据的报告定义，描述了报告的结构。它通常包含将包含在报告中的字段以及用于过滤数据的条件。

object (ReportMetadata)

仅限输出。特定报告任务的报告元数据，用于提供报告的相关信息。它通常包括以下信息：报告的资源名称、报告状态、创建报告的时间戳等。

{
  "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,
  "samplingLevel": enum (SamplingLevel)
}

object (Dimension)

可选。请求和显示的维度。

object (Metric)

可选。请求并显示的指标。

object (DateRange)

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

object (FilterExpression)

可选。借助维度过滤条件，您可以仅在报告中请求特定的维度值。如需了解详情，请参阅尺寸过滤条件基础知识，查看示例。此过滤条件中不能使用指标。

object (FilterExpression)

可选。指标的过滤条件子句。在汇总报告行后应用，类似于 SQL 的包含子句。维度不能用于此过滤条件。

string (int64 format)

可选。Google Analytics 存储空间中起始行的行数。第一行计为第 0 行。

创建报告任务时，offset 和 limit 参数用于定义要包含在生成的报告中的 Google Analytics 存储空间中的数据行子集。例如，如果 Google Analytics 存储空间中总共有 30 万行，则初始报告任务可能包含前 1 万行，行数上限为 1 万，偏移量为 0。随后，另一个报告任务可以涵盖接下来的 10,000 行，上限为 10,000，偏移量为 10,000。

string (int64 format)

可选。报告中要返回的行数。如果未指定，则返回 10,000 行。无论您请求多少行，该 API 每个请求最多只会返回 25 万行。limit 必须为正数。

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

enum (MetricAggregation)

可选。指标汇总。汇总指标值将显示在 dimensionValues 设置为“RESERVED_(MetricAggregation)”的行中。

object (OrderBy)

可选。指定响应中各行的排序方式。

string

可选。采用 ISO4217 格式的货币代码，例如“AED”“USD”“JPY”。如果此字段为空，报告将使用房源的默认币种。

object (CohortSpec)

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

boolean

可选。如果为 false 或未指定，则将不会返回所有指标都等于 0 的每一行。如果为 true，系统将返回这些行，前提是它们没有被过滤器单独移除。

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

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

enum (SamplingLevel)

可选。报告的抽样级别。

{
  "name": string,
  "dimensionExpression": {
    object (DimensionExpression)
  }
}

string

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

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

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

object (DimensionExpression)

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

{

  // 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.
}

object (CaseExpression)

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

object (CaseExpression)

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

object (ConcatenateExpression)

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

{
  "dimensionName": string
}

string

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

{
  "dimensionNames": [
    string
  ],
  "delimiter": string
}

string

维度的名称。这些名称必须与请求的“维度”字段中的名称相关联。

string

维度名称之间的分隔符。

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

{
  "name": string,
  "expression": string,
  "invisible": boolean
}

string

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

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

指标由 metricFilter、orderBys 和指标 expression 中的 name 引用。

string

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

boolean

指示指标是否在报告响应中不可见。如果指标不可见，则指标不会在响应中生成列，但可在 metricFilter、orderBys 或指标 expression 中使用。

{
  "startDate": string,
  "endDate": string,
  "name": string
}

string

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

string

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

string

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

{

  // 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.
}

object (FilterExpressionList)

andGroup 中的 Filter 表达式具有 AND 关系。

object (FilterExpressionList)

orGroup 中的 FilterExpression 具有 OR 关系。

object (FilterExpression)

FilterExpression 不是 notExpression。

object (Filter)

基元过滤器。在同一 FilterExpression 中，过滤条件的所有字段名称都必须是所有维度或所有指标。

{
  "expressions": [
    {
      object (FilterExpression)
    }
  ]
}

object (FilterExpression)

过滤表达式列表。

{
  "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.
}

string

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

object (StringFilter)

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

object (InListFilter)

用于过滤“in”列表值的过滤条件。

object (NumericFilter)

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

object (BetweenFilter)

用于过滤介于两个值之间的数据的过滤条件。

{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}

enum (MatchType)

此过滤器的匹配类型。

string

用于匹配的字符串值。

boolean

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

{
  "values": [
    string
  ],
  "caseSensitive": boolean
}

string

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

boolean

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

{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}

enum (Operation)

此过滤器的操作类型。

object (NumericValue)

数值或日期值。

{

  // 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.
}

string (int64 format)

整数值

number

DoubleValue

{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}

object (NumericValue)

以此号码开头。

object (NumericValue)

以此编号结尾。

{
  "desc": boolean,

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

boolean

如果为 true，则按降序排序。

object (MetricOrderBy)

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

object (DimensionOrderBy)

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

{
  "metricName": string
}

string

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

{
  "dimensionName": string,
  "orderType": enum (OrderType)
}

string

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

enum (OrderType)

控制维度值排序规则。

{
  "cohorts": [
    {
      object (Cohort)
    }
  ],
  "cohortsRange": {
    object (CohortsRange)
  },
  "cohortReportSettings": {
    object (CohortReportSettings)
  }
}

object (Cohort)

定义用于将用户划分为同类群组的选择条件。

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

object (CohortsRange)

同类群组报告会跟踪在扩展的报告日期范围内所涵盖的同类群组。此范围指定要跟踪同类群组的偏移时长。

object (CohortReportSettings)

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

{
  "name": string,
  "dimension": string,
  "dateRange": {
    object (DateRange)
  }
}

string

为此同类群组指定名称。报告响应中，维度“cohort”的值为此名称。如果设置，则不能以 cohort_ 或 RESERVED_ 开头。如果未设置，则同类群组按其从零开始的索引（cohort_0、cohort_1 等）命名。

string

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

object (DateRange)

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

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

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

{
  "granularity": enum (Granularity),
  "startOffset": integer,
  "endOffset": integer
}

enum (Granularity)

必需。用于解读同类群组报告的延长报告日期范围的 startOffset 和 endOffset 的精细程度。

integer

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

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

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

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

integer

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

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

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

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

{
  "accumulate": boolean
}

boolean

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

{
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "taskRowCount": integer,
  "errorMessage": string,
  "totalRowCount": integer
}

integer

仅限输出。创建报告期间消耗的配额令牌总数。由于此令牌数基于 CREATING 状态下的活动，因此报告任务进入 ACTIVE 或 FAILED 状态后，此令牌消耗将固定不变。

enum (State)

仅限输出。此报告任务的当前状态。

string (Timestamp format)

仅限输出。调用 reportTasks.create 并使报告进入 CREATING 状态的时间。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

integer

仅限输出。报告结果中的总行数。如果状态为活跃，系统会填充此字段。您可以在现有报告中使用 taskRowCount 进行分页。

string

仅限输出。如果报告任务在创建过程中失败，系统会填充错误消息。

integer

仅限输出。Google Analytics 存储空间中的总行数。如果您想查询当前报告之外的其他数据行，它们可以根据 totalRowCount 启动新的报告任务。

taskRowCount 表示与当前报告具体相关的行数，而 totalRowCount 则涵盖从 Google Analytics 存储空间检索的所有数据的行总数。

例如，假设当前报告的 taskRowCount 为 20，显示的是前 20 行的数据。同时，totalRowCount 为 30，表示所有 30 行都有数据。taskRowCount 可用于对前 20 行进行分页。如需展开报告并包含所有 30 行中的数据，可以使用 totalRowCount 创建一个新的报告任务，以访问 30 行数据的完整集。