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

טווח הזמן של הנתונים. המזהה הבא: 4

טיפוסים בני מנייה (enum)
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)

מייצג את השניות של זמן UTC מאז ראשית זמן יוניקס (Unix epoch) ‏1970-01-01T00:00:00Z. הערך חייב להיות בין ‎-62135596800 ל-‎253402300799, כולל (שמתאים לטווח 0001-01-01T00:00:00Z עד 9999-12-31T23:59:59Z).
nanos

integer

שבריר לא שלילי של שנייה ברזולוציית ננו-שנייה. השדה הזה מייצג את החלק של משך הזמן בננו-שניות, ולא מהווה חלופה לשניות. ערכי שניות שליליים עם שברים עדיין צריכים לכלול ערכי ננו-שניות לא שליליים שסופרים קדימה בזמן. הערך חייב להיות בין 0 ל-999,999,999, כולל.

MetricType

סוג המדד שנמדד.

טיפוסים בני מנייה (enum)
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, הכלי יכול ליצור אינטראקציה רק עם ישויות פנימיות. לדוגמה, כלי לחיפוש באינטרנט יהיה עולם פתוח, אבל כלי לזיכרון לא יהיה עולם פתוח.

רמז הרסני: ❌ | רמז אידמפוטנטי: ✅ | רמז לקריאה בלבד: ✅ | רמז לעולם פתוח: ❌