工具: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 ( |
| 字段 | |
|---|---|
merchantId |
必需。要请求其效果数据的商家的唯一标识符。 |
timeRange |
可选。效果数据的时间范围。 |
TimeRange
数据的时间范围。下一个 ID:4
| 枚举 | |
|---|---|
TIME_RANGE_UNSPECIFIED |
未指定的时间范围。 |
TIME_RANGE_PAST_DAY |
过去一天,即昨天。 |
TIME_RANGE_PAST_THREE_DAYS |
过去三天,不包括当天。 |
TIME_RANGE_PAST_WEEK |
过去一周,不包括当天。 |
输出架构
用于查询商家效果的响应消息。
QueryMerchantPerformanceResponse
| JSON 表示法 |
|---|
{
"merchantPerformanceMetrics": [
{
object ( |
| 字段 | |
|---|---|
merchantPerformanceMetrics[] |
商家的效果数据。 |
MerchantPerformanceMetric
| JSON 表示法 |
|---|
{ "metricDetail": { object ( |
| 字段 | |
|---|---|
metricDetail |
仅限输出。指标的详细信息。 |
hourlyMetricValues[] |
仅限输出。指标值及其时间戳的列表,时间戳四舍五入到最接近的小时。 |
MetricDetail
| JSON 表示法 |
|---|
{
"metricType": enum ( |
| 字段 | |
|---|---|
metricType |
指标的类型。 |
additionalDetails |
有关指标的任何其他详细信息的键值对,例如“gateway”: “stripe”。如需了解详情,请参阅 包含一系列 |
AdditionalDetailsEntry
| JSON 表示法 |
|---|
{ "key": string, "value": string } |
| 字段 | |
|---|---|
key |
|
value |
|
HourlyMetricValue
| JSON 表示法 |
|---|
{ "hourlyTimestamp": string, "value": number } |
| 字段 | |
|---|---|
hourlyTimestamp |
指标值的时间戳,四舍五入到最接近的小时。 采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例: |
value |
实际指标值。对于转化率,该值介于 [0, 1] 范围内。对于其他指标,该值为非负整数。 |
Timestamp
| JSON 表示法 |
|---|
{ "seconds": string, "nanos": integer } |
| 字段 | |
|---|---|
seconds |
表示世界协调时间 (UTC) 的秒数(从 Unix 纪元 1970-01-01T00:00:00Z 开始算起)。必须介于 -62135596800 和 253402300799 之间(含边界值),对应于 0001-01-01T00:00:00Z 到 9999-12-31T23:59:59Z。 |
nanos |
秒数的非负小数部分(以纳秒为单位)。此字段是时长的纳秒部分,而不是秒的替代值。对于含小数部分的负秒数,仍必须包含按时间递升的非负纳秒值。必须在 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,则表示该工具只能与内部实体互动。例如,网络搜索工具属于开放世界,而内存工具则不属于开放世界。
破坏性提示:❌ | 等幂性提示:✅ | 只读提示:✅ | 开放世界提示:❌