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

必須。パフォーマンス データの取得対象となる販売者の一意の識別子。

timeRange

enum (TimeRange)

省略可。パフォーマンス データの期間。

TimeRange

データの期間。次の ID: 4

列挙型
TIME_RANGE_UNSPECIFIED 期間が指定されていません。
TIME_RANGE_PAST_DAY 過去 1 日間(昨日)。
TIME_RANGE_PAST_THREE_DAYS 過去 3 日間(当日を除く)。
TIME_RANGE_PAST_WEEK 過去 1 週間(当日を除く)。

出力スキーマ

販売者のパフォーマンスをクエリするためのレスポンス メッセージ。

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)

指標に関する追加の詳細の Key-Value ペア(例: "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 からの UTC 時刻の秒数を表します。-62135596800~253402300799 の範囲(両端を含む)にする必要があります(これは 0001-01-01T00:00:00Z~9999-12-31T23:59:59Z に対応します)。

nanos

integer

ナノ秒分解能による、秒の負ではない小数以下部分。このフィールドは、秒の代替ではなく、期間のナノ秒部分です。小数以下を含む負の秒の値は、時間を前方にカウントする負ではない 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 の場合、ツールは内部エンティティとのみやり取りできます。たとえば、ウェブ検索ツールはオープン ワールドですが、メモリツールはオープン ワールドではありません。

破壊的ヒント: ❌ | べき等ヒント: ✅ | 読み取り専用ヒント: ✅ | オープン ワールド ヒント: ❌