Method: projects.locations.brands.computeAnalyticsMetrics

指定されたブランドの分析指標を、指定された期間について計算します。オプションで店舗フィルタを適用できます。

HTTP リクエスト

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

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
brand

string

必須。分析指標を取得するブランド。形式: projects/{project}/locations/{location}/brands/{brand}

クエリ パラメータ

パラメータ
timestamps[]

string (Timestamp format)

必須。分析指標が計算される各間隔の開始を示すタイムスタンプ。

RFC 3339 を使用します。生成された出力は常に 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)

出力専用。このカテゴリのセッション数。