- Solicitação HTTP
- Parâmetros de caminho
- Parâmetros de consulta
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- AnalyticsType
- FeatureGate
- AnalyticsMetrics
- IntervalMetrics
- PredictedFailureCategoryCount
Calcula as métricas de análise de uma determinada marca para um período especificado com um filtro de loja opcional.
Solicitação HTTP
GET https://foodorderingaiagent.googleapis.com/v1beta/{brand=projects/*/locations/*/brands/*}:computeAnalyticsMetrics
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
| Parâmetros | |
|---|---|
brand |
Obrigatório. A marca para receber as métricas de análise. Formato: projects/{project}/locations/{location}/brands/{brand} |
Parâmetros de consulta
| Parâmetros | |
|---|---|
timestamps[] |
Obrigatório. Os carimbos de data/hora que marcam o início de cada intervalo para o qual as métricas de análise são calculadas. Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: |
storeIds[] |
Opcional. A lista de IDs de loja para receber métricas de análise. Se não for especificado, as métricas de análise de todas as lojas serão retornadas. Necessário para consultar por cidade ou estado. |
analyticsTypes[] |
Opcional. Os tipos de análise a serem calculados. Se estiver vazio ou não for especificado, todos os tipos de análise disponíveis serão calculados. |
featureGate |
Opcional. Feature gates. |
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
Mensagem de resposta para MenuService.ComputeAnalyticsMetrics.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
| Representação JSON |
|---|
{
"analyticsMetrics": {
object ( |
| Campos | |
|---|---|
analyticsMetrics |
Apenas saída. As métricas de análise da marca. |
Escopos de autorização
Requer o seguinte escopo OAuth:
https://www.googleapis.com/auth/cloud-platform
Para mais informações, consulte Authentication Overview.
AnalyticsType
O tipo de análise a ser calculada.
| Tipos enumerados | |
|---|---|
ANALYTICS_TYPE_UNSPECIFIED |
Tipo de análise não especificado. |
GENERIC |
Calcular métricas genéricas/gerais (por exemplo, contagem de pedidos, contagem de encaminhamentos, contagem de upsells). |
DAILY |
Calcular métricas diárias (por exemplo, contagens diárias de pedidos e encaminhamentos). |
PREDICTED_FAILURE_CATEGORIES |
Calcule as métricas de categoria de falha prevista (por exemplo, contagem de categorias de falha prevista). |
FeatureGate
Feature gates para controlar o comportamento de computação de análise.
| Representação JSON |
|---|
{ "enableAggregationData": boolean } |
| Campos | |
|---|---|
enableAggregationData |
Opcional. Apenas para marcas limitadas. Se definido, calcula as métricas de análise usando dados agregados. |
AnalyticsMetrics
Representa as métricas de análise de um determinado período, com uma comparação com um período anterior.
| Representação JSON |
|---|
{
"intervalMetrics": [
{
object ( |
| Campos | |
|---|---|
intervalMetrics[] |
Métricas para os intervalos. |
IntervalMetrics
Representa métricas de análise para um intervalo de tempo específico.
| Representação JSON |
|---|
{ "interval": { object ( |
| Campos | |
|---|---|
interval |
O horário de início / término refletido por essas métricas. |
totalOrderCount |
Apenas saída. O número total de pedidos. |
successOrderCount |
Apenas saída. O número de pedidos concluídos. |
avgOrderDurationMs |
Apenas saída. A duração média do pedido em ms. |
upsellSuccessRate |
Apenas saída. A taxa de sucesso do upsell. |
upsellRevenue |
Apenas saída. A receita de upsell. |
escalationCount |
Apenas saída. A contagem de grupos de resultados de encaminhamento. |
predictedFailureCategoryCounts[] |
Apenas saída. As contagens de categorias de falha previstas. |
invalidOrderCount |
Apenas saída. O número total de pedidos inválidos. |
crewEscalationCount |
Apenas saída. O número de pedidos de escalonamento de tripulação. |
PredictedFailureCategoryCount
Contagem de categorias de falha previstas.
| Representação JSON |
|---|
{ "category": string, "count": string } |
| Campos | |
|---|---|
category |
Apenas saída. A categoria de falha prevista. |
count |
Apenas saída. O número de sessões nessa categoria. |