MCP Tools Reference: paydeveloper.googleapis.com

כלי: list_principals

רשימה של הגורמים (משתמשים) שיש להם גישה למוֹכר ספציפי. כדי לבצע את הפעולה הזו, נדרשת גישת אדמין לחשבון של המוכר.

בדוגמת הקוד הבאה מוצג שימוש בפקודה curl כדי להפעיל את הכלי list_principals 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": "list_principals",
    "arguments": {
      // Provide these details according to the MCP tool specification.
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

סכימת הקלט

הודעת בקשה לציון בעלי עניין בעסק של מוכר.

ListPrincipalsRequest

ייצוג JSON 
{
  "merchantId": string
}
שדות
merchantId

string

חובה. מספר החשבון של המוכר שרוצים להציג את הגורמים האחראים שלו.

סכימת הפלט

הודעת תגובה לבקשה לקבלת רשימה של בעלי העניין העיקריים של מוכר.

ListPrincipalsResponse

ייצוג JSON 
{
  "principals": [
    {
      object (Principal)
    }
  ]
}
שדות
principals[]

object (Principal)

חשבונות המשתמשים שיש להם גישה למוכר.

חשבון משתמש

ייצוג JSON 
{
  "email": string,
  "displayName": string,
  "role": enum (PrincipalRole),
  "state": enum (State)
}
שדות
email

string

חובה. כתובת האימייל של חשבון המשתמש.
displayName

string

פלט בלבד. השם המוצג של הגורם הראשי.
role

enum (PrincipalRole)

התפקיד של החשבון הראשי אצל המוכר.
state

enum (State)

פלט בלבד. מצב הגישה של החשבון הראשי בחשבון המוכר.

PrincipalRole

תפקיד שאפשר להעניק לישות (משתמש) אצל מוֹכר.

טיפוסים בני מנייה (enum)
PRINCIPAL_ROLE_UNSPECIFIED התפקיד לא צוין.
ADMIN גישה מלאה למוכר, כולל ניהול משתמשים.
DEVELOPER גישה שמיועדת למפתחים שמבצעים שילוב עם המוכר.

מדינה (State)

מצב הגישה של בעל עסק ראשי אצל סוחר.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED לא צוין מצב הגישה.
ACTIVE לחשבון יש גישה פעילה ומאושרת.
PENDING המשתמש הוזמן אבל עדיין לא אישר את ההזמנה.
EXPIRED פג תוקף ההזמנה של הגורם הראשי.

הערות על כלים

הערות על כלים נשלחות ללקוחות MCP כדי לתאר את הסיכון הבסיסי של כלי מסוים. רוב הלקוחות מתייחסים לרמזים האלה כאל רמזים לא מהימנים, אבל אפשר להשתמש בהם כדי להחליט מתי לשלוח למשתמש בקשת אישור.

בנוסף למחרוזת הכותרת, מוגדרים הרמזים הבוליאניים הבאים:

  • ‫readOnlyHint: אם הערך הוא true, הכלי לא משנה את הסביבה שלו. ברירת מחדל: false.
  • ‫destructiveHint: אם הערך הוא True, הכלי יכול לבצע פעולות הרסניות. אם הערך הוא false, הכלי יכול לבצע רק פעולות של הוספה. ברירת מחדל: true.
  • ‫idempotentHint: אם הערך הוא True, קריאה חוזרת לכלי עם אותם ארגומנטים לא תשפיע על הסביבה שלו. ברירת מחדל: false.
  • ‫openWorldHint: אם הערך הוא True, הכלי יכול ליצור אינטראקציה עם 'עולם פתוח' של ישויות חיצוניות. אם הערך הוא false, הכלי יכול ליצור אינטראקציה רק עם ישויות פנימיות. לדוגמה, כלי לחיפוש באינטרנט יהיה עולם פתוח, אבל כלי לזיכרון לא יהיה עולם פתוח.

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