MCP Tools Reference: paydeveloper.googleapis.com

工具：query_merchant_performance

擷取特定商家商家檔案的高層級匯總成效資料和整合後指標。

下列程式碼範例說明如何使用 curl 呼叫 query_merchant_performance MCP 工具。

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

輸入內容的結構定義

查詢商家成效資料的要求訊息。

QueryMerchantPerformanceRequest

JSON 表示法 
{
  "merchantId": string,
  "timeRange": enum (TimeRange)
}
欄位
merchantId

string

必填。要取得成效資料的商家專屬 ID。
timeRange

enum (TimeRange)

(選用步驟) 成效資料的時間範圍。

TimeRange

資料的時間範圍。下一個 ID：4

列舉
TIME_RANGE_UNSPECIFIED 未指定時間範圍。
TIME_RANGE_PAST_DAY 過去一天，也就是昨天。
TIME_RANGE_PAST_THREE_DAYS 過去三天 (不含當天)。
TIME_RANGE_PAST_WEEK 過去一週 (不含當天)。

輸出內容的結構定義

查詢商家成效的回應訊息。

QueryMerchantPerformanceResponse

JSON 表示法 
{
  "merchantPerformanceMetrics": [
    {
      object (MerchantPerformanceMetric)
    }
  ]
}
欄位
merchantPerformanceMetrics[]

object (MerchantPerformanceMetric)

商家的成效資料。

MerchantPerformanceMetric

JSON 表示法 
{
  "metricDetail": {
    object (MetricDetail)
  },
  "hourlyMetricValues": [
    {
      object (HourlyMetricValue)
    }
  ]
}
欄位
metricDetail

object (MetricDetail)

僅供輸出。指標詳細資料。
hourlyMetricValues[]

object (HourlyMetricValue)

僅供輸出。指標值和時間戳記的清單，時間戳記會四捨五入至最接近的小時整點。

MetricDetail

JSON 表示法 
{
  "metricType": enum (MetricType),
  "additionalDetails": {
    string: string,
    ...
  }
}
欄位
metricType

enum (MetricType)

指標類型。
additionalDetails

map (key: string, value: string)

指標任何其他詳細資料的鍵/值組，例如「gateway」：「stripe」。詳情請參閱

這個物件中包含 "key": value 組合的清單，範例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

AdditionalDetailsEntry

JSON 表示法 
{
  "key": string,
  "value": string
}
欄位
key

string
value

string

HourlyMetricValue

JSON 表示法 
{
  "hourlyTimestamp": string,
  "value": number
}
欄位
hourlyTimestamp

string (Timestamp format)

指標值的時間戳記 (四捨五入至最接近的小時)。

使用 RFC 3339，產生的輸出內容一律會經過 Z 正規化，並使用 0、3、6 或 9 個小數位數，也接受「Z」以外的偏移量。範例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
value

number

實際指標值。轉換率的值介於 [0, 1] 之間。其他指標的值為非負整數。

時間戳記

JSON 表示法 
{
  "seconds": string,
  "nanos": integer
}
欄位
seconds

string (int64 format)

代表自 Unix 紀元 1970-01-01T00:00:00Z 起算的世界標準時間秒數。必須介於 -62135596800 和 253402300799 之間 (含)，對應至 0001-01-01T00:00:00Z 至 9999-12-31T23:59:59Z。
nanos

integer

以奈秒為單位的非負秒數小數。這個欄位是時間長度的奈秒部分，並非秒數的替代值。如果秒數值為負數，且包含小數，奈秒值仍須為非負數，且會往前計算時間。必須介於 0 至 999,999,999 之間 (含)。

MetricType

要測量的指標類型。

列舉
METRIC_TYPE_UNSPECIFIED 未指定指標類型。
FACILITATION_COUNT 成功透過 GPay API 促成的交易次數。
VISIT_COUNT GPay API 按鈕的點擊次數。
CONVERSION_RATE 結帳按鈕的轉換率，定義為成功使用 GPay API 促成交易的次數，與點選 GPay API 按鈕次數的比率。

工具註解

工具註解會傳送至 MCP 用戶端，說明特定工具的基本風險。大多數用戶端會將這些提示視為不受信任，但可用於決定何時向使用者傳送確認提示。

除了標題字串外，以下布林提示的定義如下：

  • readOnlyHint：如果為 true，工具不會修改環境。預設值：false。
  • destructiveHint：如果為 true，工具可以執行破壞性動作。如果為 false，工具只能執行加法動作。預設值：true。
  • idempotentHint：如果為 true，以相同引數重複呼叫工具，對環境不會有額外影響。預設值：false。
  • openWorldHint：設為 true 時，工具可以與外部實體的「開放世界」互動。如果為 false，工具只能與內部實體互動。舉例來說，網頁搜尋工具屬於開放世界，記憶體工具則不屬於開放世界。

破壞性提示：❌ | 等冪提示：✅ | 唯讀提示：✅ | 開放世界提示：❌