MCP Tools Reference: paydeveloper.googleapis.com

Herramienta: query_merchant_performance

Recupera datos de rendimiento agregados de alto nivel y métricas posteriores a la integración para un perfil de empresa de comercio específico.

En el siguiente ejemplo de código, se muestra cómo usar curl para llamar a la herramienta query_merchant_performance del MCP.

Solicitud curl 
curl --location 'https://paydeveloper.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "query_merchant_performance",
    "arguments": {
      // Provide these details according to the MCP tool specification.
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

Esquema de entrada

Mensaje de solicitud para consultar datos de rendimiento del comercio.

QueryMerchantPerformanceRequest

Representación JSON 
{
  "merchantId": string,
  "timeRange": enum (TimeRange)
}
Campos
merchantId

string

Obligatorio. Es el identificador único del comercio para el que se solicitan los datos de rendimiento.
timeRange

enum (TimeRange)

Es opcional. Es el intervalo de tiempo de los datos de rendimiento.

TimeRange

Es el intervalo de tiempo de los datos. ID siguiente: 4

Enums
TIME_RANGE_UNSPECIFIED Indica un intervalo de tiempo no especificado.
TIME_RANGE_PAST_DAY Indica el día anterior, ayer.
TIME_RANGE_PAST_THREE_DAYS Indica los tres días anteriores, sin incluir el día actual.
TIME_RANGE_PAST_WEEK Indica la semana anterior, sin incluir el día actual.

Esquema de salida

Mensaje de respuesta para consultar el rendimiento del comercio.

QueryMerchantPerformanceResponse

Representación JSON 
{
  "merchantPerformanceMetrics": [
    {
      object (MerchantPerformanceMetric)
    }
  ]
}
Campos
merchantPerformanceMetrics[]

object (MerchantPerformanceMetric)

Son los datos de rendimiento del comercio.

MerchantPerformanceMetric

Representación JSON 
{
  "metricDetail": {
    object (MetricDetail)
  },
  "hourlyMetricValues": [
    {
      object (HourlyMetricValue)
    }
  ]
}
Campos
metricDetail

object (MetricDetail)

Solo salida. Son los detalles de la métrica.
hourlyMetricValues[]

object (HourlyMetricValue)

Solo salida. Es una lista del valor de la métrica y su marca de tiempo, redondeada a la hora más cercana.

MetricDetail

Representación JSON 
{
  "metricType": enum (MetricType),
  "additionalDetails": {
    string: string,
    ...
  }
}
Campos
metricType

enum (MetricType)

Es el tipo de métrica.
additionalDetails

map (key: string, value: string)

Son pares clave-valor para cualquier detalle adicional sobre la métrica, por ejemplo, "gateway": "stripe". Para obtener más información, consulta

Un objeto que contiene una lista de "key": value pares. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

AdditionalDetailsEntry

Representación JSON 
{
  "key": string,
  "value": string
}
Campos
key

string
value

string

HourlyMetricValue

Representación JSON 
{
  "hourlyTimestamp": string,
  "value": number
}
Campos
hourlyTimestamp

string (Timestamp format)

Es la marca de tiempo del valor de la métrica redondeada a la hora más cercana.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
value

number

Es el valor real de la métrica. En el caso del porcentaje de conversiones, el valor está en el rango de [0, 1]. Para otras métricas, el valor es un número entero no negativo.

Marca de tiempo

Representación JSON 
{
  "seconds": string,
  "nanos": integer
}
Campos
seconds

string (int64 format)

Representa los segundos de la hora UTC desde la época de Unix 1970-01-01T00:00:00Z. Debe estar entre -62135596800 y 253402300799 inclusive (lo que corresponde a 0001-01-01T00:00:00Z a 9999-12-31T23:59:59Z).
nanos

integer

Fracciones no negativas de un segundo a una resolución de nanosegundos. Este campo es la parte de nanosegundos de la duración, no una alternativa a los segundos. Los valores de segundos negativos con fracciones deben tener valores nanos no negativos que se cuentan hacia adelante en el tiempo. Debe estar entre 0 y 999,999,999 inclusive.

MetricType

Es el tipo de métrica que se mide.

Enums
METRIC_TYPE_UNSPECIFIED Indica un tipo de métrica no especificado.
FACILITATION_COUNT Es la cantidad de facilitaciones correctas de la API de GPay.
VISIT_COUNT Es la cantidad de clics en el botón de la API de GPay.
CONVERSION_RATE Es el porcentaje de conversiones del botón de confirmación de compra, definido como la proporción entre la cantidad de facilitaciones correctas de la API de GPay y la cantidad de clics en el botón de la API de GPay.

Anotaciones de herramientas

Las anotaciones de herramientas se envían a los clientes del MCP para describir el riesgo básico de una herramienta determinada. La mayoría de los clientes tratan estas sugerencias como no confiables, pero se pueden usar para decidir cuándo se puede enviar un mensaje de confirmación a un usuario.

Junto con la cadena de título, las siguientes sugerencias booleanas se definen de la siguiente manera:

  • readOnlyHint: Si es verdadero, la herramienta no modifica su entorno. Valor predeterminado: false.
  • destructiveHint: Si es verdadero, la herramienta puede realizar acciones destructivas. Si es falso, la herramienta solo puede realizar acciones aditivas. Valor predeterminado: true.
  • idempotentHint: Si es verdadero, llamar a la herramienta de forma repetida con los mismos argumentos no tendrá ningún efecto adicional en su entorno. Valor predeterminado: false.
  • openWorldHint: Si es verdadero, la herramienta puede interactuar con un "mundo abierto" de entidades externas. Si es falso, la herramienta solo puede interactuar con entidades internas. Por ejemplo, una herramienta de búsqueda web sería de mundo abierto, mientras que una herramienta de memoria no lo sería.

Sugerencia destructiva: ❌ | Sugerencia idempotente: ✅ | Sugerencia de solo lectura: ✅ | Sugerencia de mundo abierto: ❌