MCP Tools Reference: paydeveloper.googleapis.com

Ferramenta: query_merchant_performance

Recupera dados de performance agregados de alto nível e métricas pós-integração para um perfil de empresa de comerciante específico.

O exemplo a seguir demonstra como usar curl para invocar a ferramenta query_merchant_performance MCP.

Solicitação 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 tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'
                

Esquema de entrada

Mensagem de solicitação para consultar dados de performance do comerciante.

QueryMerchantPerformanceRequest

Representação JSON
{
  "merchantId": string,
  "timeRange": enum (TimeRange)
}
Campos
merchantId

string

Obrigatório. O identificador exclusivo do comerciante para quem os dados de performance estão sendo solicitados.

timeRange

enum (TimeRange)

Opcional. O período dos dados de performance.

Esquema de saída

Mensagem de resposta para consultar a performance do comerciante.

QueryMerchantPerformanceResponse

Representação JSON
{
  "merchantPerformanceMetrics": [
    {
      object (MerchantPerformanceMetric)
    }
  ]
}
Campos
merchantPerformanceMetrics[]

object (MerchantPerformanceMetric)

Os dados de performance do comerciante.

MerchantPerformanceMetric

Representação JSON
{
  "metricDetail": {
    object (MetricDetail)
  },
  "hourlyMetricValues": [
    {
      object (HourlyMetricValue)
    }
  ]
}
Campos
metricDetail

object (MetricDetail)

Apenas saída. Detalhes da métrica.

hourlyMetricValues[]

object (HourlyMetricValue)

Apenas saída. Uma lista do valor da métrica e do carimbo de data/hora, arredondados para o início da hora mais próxima.

MetricDetail

Representação JSON
{
  "metricType": enum (MetricType),
  "additionalDetails": {
    string: string,
    ...
  }
}
Campos
metricType

enum (MetricType)

Tipo da métrica.

additionalDetails

map (key: string, value: string)

Pares de chave-valor para detalhes adicionais sobre a métrica, por exemplo, "gateway": "stripe". Confira mais detalhes em

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

AdditionalDetailsEntry

Representação JSON
{
  "key": string,
  "value": string
}
Campos
key

string

value

string

HourlyMetricValue

Representação JSON
{
  "hourlyTimestamp": string,
  "value": number
}
Campos
hourlyTimestamp

string (Timestamp format)

O carimbo de data/hora do valor da métrica arredondado para o início da hora mais próxima.

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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

value

number

O valor real da métrica. Para a taxa de conversão, o valor está no intervalo [0, 1]. Para outras métricas, o valor é um número inteiro não negativo.

Carimbo de data/hora

Representação JSON
{
  "seconds": string,
  "nanos": integer
}
Campos
seconds

string (int64 format)

Representa os segundos do horário UTC desde a época Unix 1970-01-01T00:00:00Z. Precisa estar entre -62135596800 e 253402300799 (o que corresponde a 0001-01-01T00:00:00Z a 9999-12-31T23:59:59Z).

nanos

integer

Frações não negativas de um segundo com resolução de nanossegundos. Esse campo é a parte de nanossegundos da duração, não uma alternativa aos segundos. Os valores de segundos negativos com frações ainda precisam ter valores em nanossegundos não negativos que representam períodos posteriores. O valor precisa estar entre 0 e 999.999.999 (inclusive).

Anotações de ferramentas

Dica destrutiva: ❌ | Dica idempotente: ✅ | Dica somente leitura: ✅ | Dica de mundo aberto: ❌