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 comercial específico do comerciante.

O exemplo de código a seguir mostra como usar curl para chamar a ferramenta query_merchant_performance do 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 MCP tool 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 o qual os dados de performance estão sendo solicitados.
timeRange

enum (TimeRange)

Opcional. O período dos dados de performance.

TimeRange

O período dos dados. Próximo código: 4

Tipos enumerados
TIME_RANGE_UNSPECIFIED Período não especificado.
TIME_RANGE_PAST_DAY O dia anterior, ontem.
TIME_RANGE_PAST_THREE_DAYS Os três dias anteriores, excluindo o dia atual.
TIME_RANGE_PAST_WEEK A semana anterior, excluindo o dia atual.

Esquema de saída

Mensagem de resposta para consultar o desempenho 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 de valores de métricas e o carimbo de data/hora correspondente, arredondado para a 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 outros detalhes sobre a métrica, por exemplo, "gateway": "stripe". Para mais detalhes, consulte

Um objeto que contém uma lista de "key": value pares. 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 a 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 de [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 (inclusive), 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. Precisa estar entre 0 e 999.999.999 (inclusive).

MetricType

O tipo de métrica que está sendo medida.

Tipos enumerados
METRIC_TYPE_UNSPECIFIED Tipo de métrica não especificado.
FACILITATION_COUNT O número de facilitação da API GPay bem-sucedida.
VISIT_COUNT O número de cliques no botão da API GPay.
CONVERSION_RATE A taxa de conversão do botão para finalizar a compra, definida como a proporção do número de facilitação da API GPay bem-sucedida para o número de cliques no botão da API GPay.

Anotações da ferramenta

As anotações da ferramenta são enviadas aos clientes do MCP para descrever o risco básico de uma determinada ferramenta. A maioria dos clientes trata essas dicas como não confiáveis, mas elas podem ser usadas para decidir quando um aviso de confirmação pode ser enviado a um usuário.

Além da string de título, as seguintes dicas booleanas são definidas da seguinte maneira:

  • readOnlyHint: se for verdadeiro, a ferramenta não modifica o ambiente. Padrão: falso.
  • destructiveHint: se for verdadeiro, a ferramenta poderá realizar ações destrutivas. Se for falso, a ferramenta só poderá realizar ações aditivas. Padrão: verdadeiro.
  • idempotentHint: se for verdadeiro, chamar a ferramenta repetidamente com os mesmos argumentos não terá efeito adicional no ambiente. Padrão: falso.
  • openWorldHint: se for verdadeiro, a ferramenta poderá interagir com um "mundo aberto" de entidades externas. Se for falso, a ferramenta só poderá interagir com entidades internas. Por exemplo, uma ferramenta de pesquisa na Web seria de mundo aberto, enquanto uma ferramenta de memória não seria.

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