Method: projects.locations.brands.computeAnalyticsMetrics

Calcule les métriques d'analyse d'une marque donnée pour une période spécifiée, avec un filtre de magasin facultatif.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
brand

string

Obligatoire. Marque pour laquelle obtenir des métriques d'analyse. Format : projects/{project}/locations/{location}/brands/{brand}

Paramètres de requête

Paramètres
timestamps[]

string (Timestamp format)

Obligatoire. Codes temporels qui marquent le début de chaque intervalle pour lequel les métriques d'analyse sont calculées.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
storeIds[]

string

Facultatif. Liste des ID de magasins pour lesquels obtenir des métriques d'analyse. Si ce paramètre n'est pas spécifié, les métriques d'analyse de tous les magasins seront renvoyées. Nécessaire pour interroger par ville ou par État.
analyticsTypes[]

enum (AnalyticsType)

Facultatif. Types d'analyses à calculer. Si ce champ est vide ou non spécifié, tous les types d'analyse disponibles seront calculés.
featureGate

object (FeatureGate)

Facultatif. Feature gates.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Message de réponse pour MenuService.ComputeAnalyticsMetrics.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "analyticsMetrics": {
    object (AnalyticsMetrics)
  }
}
Champs
analyticsMetrics

object (AnalyticsMetrics)

Uniquement en sortie. Les métriques d'analyse de la marque.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.

AnalyticsType

Type d'analyse à calculer.

Enums
ANALYTICS_TYPE_UNSPECIFIED Type d'analyse non spécifié.
GENERIC Calculer des métriques génériques/globales (par exemple, le nombre de commandes, d'escalades, de ventes incitatives).
DAILY Calculer les métriques quotidiennes (par exemple, le nombre de commandes et d'escalades par jour).
PREDICTED_FAILURE_CATEGORIES Calculer les métriques de catégorie de défaillance prédite (par exemple, le nombre de catégories de défaillance prédites).

FeatureGate

Feature gates pour contrôler le comportement de calcul des analyses.

Représentation JSON 
{
  "enableAggregationData": boolean
}
Champs
enableAggregationData

boolean

Facultatif. Pour certaines marques uniquement. Si cette option est définie, calculez les métriques d'analyse à l'aide des données globales.

AnalyticsMetrics

Représente les métriques d'analyse pour une période donnée, avec une comparaison avec une période précédente.

Représentation JSON 
{
  "intervalMetrics": [
    {
      object (IntervalMetrics)
    }
  ]
}
Champs
intervalMetrics[]

object (IntervalMetrics)

Métriques pour les intervalles.

IntervalMetrics

Représente les métriques d'analyse pour un intervalle de temps spécifique.

Représentation JSON 
{
  "interval": {
    object (Interval)
  },
  "totalOrderCount": string,
  "successOrderCount": string,
  "avgOrderDurationMs": string,
  "upsellSuccessRate": number,
  "upsellRevenue": {
    object (Money)
  },
  "escalationCount": string,
  "predictedFailureCategoryCounts": [
    {
      object (PredictedFailureCategoryCount)
    }
  ],
  "invalidOrderCount": string,
  "crewEscalationCount": string
}
Champs
interval

object (Interval)

Heure de début/fin reflétée par ces métriques.
totalOrderCount

string (int64 format)

Uniquement en sortie. Nombre total de commandes.
successOrderCount

string (int64 format)

Uniquement en sortie. Nombre de commandes réussies.
avgOrderDurationMs

string (int64 format)

Uniquement en sortie. Durée moyenne de la commande en ms.
upsellSuccessRate

number

Uniquement en sortie. Taux de réussite de la vente incitative.
upsellRevenue

object (Money)

Uniquement en sortie. Revenus de la vente incitative.
escalationCount

string (int64 format)

Uniquement en sortie. Nombre de groupes de résultats d'escalade.
predictedFailureCategoryCounts[]

object (PredictedFailureCategoryCount)

Uniquement en sortie. Nombre de catégories d'échecs prédites.
invalidOrderCount

string (int64 format)

Uniquement en sortie. Nombre total de commandes non valides.
crewEscalationCount

string (int64 format)

Uniquement en sortie. Nombre d'ordres d'escalade de l'équipage.

PredictedFailureCategoryCount

Nombre de catégories d'échecs prédites.

Représentation JSON 
{
  "category": string,
  "count": string
}
Champs
category

string

Uniquement en sortie. Catégorie d'échec prédite.
count

string (int64 format)

Uniquement en sortie. Nombre de sessions dans cette catégorie.