Method: projects.locations.brands.computeAnalyticsMetrics

计算指定时间段内指定品牌(可选商店过滤条件)的分析指标。

HTTP 请求

GET https://foodorderingaiagent.googleapis.com/v1/{brand=projects/*/locations/*/brands/*}:computeAnalyticsMetrics

网址采用 gRPC 转码语法。

路径参数

参数
brand

string

必需。要获取分析指标的品牌。格式:projects/{project}/locations/{location}/brands/{brand}

查询参数

参数
timestamps[]

string (Timestamp format)

必需。标记计算分析指标的每个时间间隔的开始时间的时间戳。

采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

storeIds[]

string

可选。要获取分析指标的商店 ID 列表。如果未指定,则返回所有实体店的分析指标。需要按城市或州/省/自治区/直辖市进行查询。

analyticsTypes[]

enum (AnalyticsType)

可选。要计算的分析类型。如果为空或未指定,则会计算所有可用的分析类型。

featureGate

object (FeatureGate)

可选。功能门控。

请求正文

请求正文必须为空。

响应正文

MenuService.ComputeAnalyticsMetrics 的响应消息。

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

JSON 表示法
{
  "analyticsMetrics": {
    object (AnalyticsMetrics)
  }
}
字段
analyticsMetrics

object (AnalyticsMetrics)

仅限输出。品牌的分析指标。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

AnalyticsType

要计算的分析类型。

枚举
ANALYTICS_TYPE_UNSPECIFIED 未指定的分析类型。
GENERIC 计算一般/总体指标(例如,订单数、升级数、追加销售数)。
DAILY 计算每日指标(例如,每日订单数和升级次数)。
PREDICTED_FAILURE_CATEGORIES 计算预测的故障类别指标(例如,预测的故障类别数量)。

FeatureGate

用于控制分析计算行为的特征门控。

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

boolean

可选。仅适用于部分品牌。如果已设置,则使用汇总数据计算分析指标。

AnalyticsMetrics

表示指定时间段的分析指标,并与上一时间段进行比较。

JSON 表示法
{
  "intervalMetrics": [
    {
      object (IntervalMetrics)
    }
  ]
}
字段
intervalMetrics[]

object (IntervalMetrics)

相应时间段的指标。

IntervalMetrics

表示特定时间间隔的分析指标。

JSON 表示法
{
  "interval": {
    object (Interval)
  },
  "totalOrderCount": string,
  "successOrderCount": string,
  "avgOrderDurationMs": string,
  "upsellSuccessRate": number,
  "upsellRevenue": {
    object (Money)
  },
  "escalationCount": string,
  "predictedFailureCategoryCounts": [
    {
      object (PredictedFailureCategoryCount)
    }
  ],
  "invalidOrderCount": string,
  "crewEscalationCount": string
}
字段
interval

object (Interval)

这些指标反映的开始 / 结束时间。

totalOrderCount

string (int64 format)

仅限输出。订单总数。

successOrderCount

string (int64 format)

仅限输出。成功订单的数量。

avgOrderDurationMs

string (int64 format)

仅限输出。平均订单时长(以毫秒为单位)。

upsellSuccessRate

number

仅限输出。追加销售成功率。

upsellRevenue

object (Money)

仅限输出。追加销售收入。

escalationCount

string (int64 format)

仅限输出。升级结果组数量。

predictedFailureCategoryCounts[]

object (PredictedFailureCategoryCount)

仅限输出。预测的故障类别数量。

invalidOrderCount

string (int64 format)

仅限输出。无效订单的总数。

crewEscalationCount

string (int64 format)

仅限输出。乘务员升级订单的数量。

PredictedFailureCategoryCount

预测的故障类别数量。

JSON 表示法
{
  "category": string,
  "count": string
}
字段
category

string

仅限输出。预测的故障类别。

count

string (int64 format)

仅限输出。相应类别的会话次数。