MCP Tools Reference: paydeveloper.googleapis.com

Tool: query_merchant_performance

Ruft aggregierte Leistungsdaten auf hoher Ebene und Messwerte nach der Integration für ein bestimmtes Händler-Unternehmensprofil ab.

Das folgende Codebeispiel zeigt, wie Sie curl verwenden, um das MCP-Tool query_merchant_performance aufzurufen.

cURL-Anfrage
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
}'

Eingabeschema

Anfragenachricht zum Abfragen von Leistungsdaten von Händlern.

QueryMerchantPerformanceRequest

JSON-Darstellung
{
  "merchantId": string,
  "timeRange": enum (TimeRange)
}
Felder
merchantId

string

Erforderlich. Die eindeutige Kennung des Händlers, für den Leistungsdaten angefordert werden.

timeRange

enum (TimeRange)

Optional. Der Zeitraum der Leistungsdaten.

TimeRange

Der Zeitraum der Daten. Nächste ID: 4

Enums
TIME_RANGE_UNSPECIFIED Nicht angegebener Zeitraum.
TIME_RANGE_PAST_DAY Der vergangene Tag, gestern.
TIME_RANGE_PAST_THREE_DAYS Die letzten drei Tage, ohne den aktuellen Tag.
TIME_RANGE_PAST_WEEK Die letzte Woche, ohne den aktuellen Tag.

Ausgabeschema

Antwortnachricht zum Abfragen der Händlerleistung.

QueryMerchantPerformanceResponse

JSON-Darstellung
{
  "merchantPerformanceMetrics": [
    {
      object (MerchantPerformanceMetric)
    }
  ]
}
Felder
merchantPerformanceMetrics[]

object (MerchantPerformanceMetric)

Die Leistungsdaten des Händlers.

MerchantPerformanceMetric

JSON-Darstellung
{
  "metricDetail": {
    object (MetricDetail)
  },
  "hourlyMetricValues": [
    {
      object (HourlyMetricValue)
    }
  ]
}
Felder
metricDetail

object (MetricDetail)

Nur Ausgabe. Details zum Messwert.

hourlyMetricValues[]

object (HourlyMetricValue)

Nur Ausgabe. Eine Liste mit Messwert und Zeitstempel, gerundet auf die nächste volle Stunde.

MetricDetail

JSON-Darstellung
{
  "metricType": enum (MetricType),
  "additionalDetails": {
    string: string,
    ...
  }
}
Felder
metricType

enum (MetricType)

Typ des Messwerts.

additionalDetails

map (key: string, value: string)

Schlüssel/Wert-Paare für zusätzliche Details zum Messwert, z.B. „gateway“: „stripe“. Weitere Informationen

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

AdditionalDetailsEntry

JSON-Darstellung
{
  "key": string,
  "value": string
}
Felder
key

string

value

string

HourlyMetricValue

JSON-Darstellung
{
  "hourlyTimestamp": string,
  "value": number
}
Felder
hourlyTimestamp

string (Timestamp format)

Der Zeitstempel des Messwerts, gerundet auf die nächste volle Stunde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

value

number

Der tatsächliche Messwert. Bei der Conversion-Rate liegt der Wert im Bereich [0, 1]. Bei anderen Messwerten ist der Wert eine nicht negative Ganzzahl.

Zeitstempel

JSON-Darstellung
{
  "seconds": string,
  "nanos": integer
}
Felder
seconds

string (int64 format)

Stellt Sekunden der UTC-Zeit seit Unix-Epoche 1970-01-01T00:00:00Z dar. Muss zwischen -62135596800 und 253402300799 liegen (entspricht 0001-01-01T00:00:00Z bis 9999-12-31T23:59:59Z).

nanos

integer

Nicht negative Sekundenbruchteile Nanosekunden-Auflösung. Dieses Feld ist der Nanosekundenanteil der Dauer und keine Alternative zu Sekunden. Negative Sekundenwerte mit Bruchteilen müssen weiterhin nicht negative Nano-Werte haben, die zeitlich vorwärts gezählt werden. Muss zwischen 0 und 999.999.999 liegen.

MetricType

Der Typ des gemessenen Messwerts.

Enums
METRIC_TYPE_UNSPECIFIED Nicht angegebener Messwerttyp.
FACILITATION_COUNT Die Anzahl der erfolgreichen GPay API-Abwicklungen.
VISIT_COUNT Die Anzahl der Klicks auf die Schaltfläche „GPay API“.
CONVERSION_RATE Die Conversion-Rate der Schaltfläche „Zur Kasse“, definiert als das Verhältnis zwischen der Anzahl der erfolgreichen GPay API-Abwicklungen und der Anzahl der Klicks auf die Schaltfläche „GPay API“.

Toolanmerkungen

Toolanmerkungen werden an MCP-Clients gesendet, um das grundlegende Risiko eines bestimmten Tools zu beschreiben. Die meisten Clients behandeln diese Hinweise als nicht vertrauenswürdig, sie können aber verwendet werden, um zu entscheiden, wann eine Bestätigungsaufforderung an einen Nutzer gesendet werden soll.

Neben dem Titelstring sind die folgenden booleschen Hinweise definiert:

  • readOnlyHint: Wenn „true“ (wahr), ändert das Tool seine Umgebung nicht. Standardeinstellung: „false“ (falsch).
  • destructiveHint: Wenn „true“ (wahr), kann das Tool destruktive Aktionen ausführen. Wenn „false“ (falsch), kann das Tool nur additive Aktionen ausführen. Standardeinstellung: „true“ (wahr).
  • idempotentHint: Wenn „true“ (wahr), hat das wiederholte Aufrufen des Tools mit denselben Argumenten keine zusätzlichen Auswirkungen auf seine Umgebung. Standardeinstellung: „false“ (falsch).
  • openWorldHint: Wenn „true“ (wahr), kann das Tool mit einer „offenen Welt“ externer Entitäten interagieren. Wenn „false“ (falsch), kann das Tool nur mit internen Entitäten interagieren. Ein Tool für die Websuche wäre beispielsweise eine offene Welt, ein Speichertool jedoch nicht.

Destruktiver Hinweis: ❌ | Idempotenter Hinweis: ✅ | Hinweis „Nur lesen“: ✅ | Hinweis „Offene Welt“: ❌