העברת ניהול משתמשים וגישה

ב-Content API for Shopping, ניהלתם את המשתמשים ואת הרשאות הגישה שלהם באמצעות שדה במשאב Account. ב-Merchant API, המשאב הזה מוחלף במשאב הייעודי User ובשיטות המתאימות (create,‏ delete,‏ get,‏ list,‏ path). מידע נוסף זמין במאמר שליטה בגישה לחשבון.

ההבדלים העיקריים

בהשוואה ל-Content API for Shopping, ל-Merchant API יש את היתרונות הבאים בכל מה שקשור לניהול משתמשים:

  • משאב ייעודי: דרך מפורטת וישירה יותר לקבוע למי יש גישה לחשבון Merchant Center ומה הוא יכול לעשות.
  • שמות משאבים של RESTful: ב-Merchant API, משאבי User מזוהים לפי שם המשאב המלא, לדוגמה, accounts/12345/users/example@example.com.
  • ‫כינוי me: אתם יכולים להשתמש בכינוי me במקום בכתובת אימייל בשם המשאב כדי להתייחס למשתמש המאומת, לדוגמה accounts/12345/users/me.
  • הרשאות גישה מאוחדות: Merchant API מאחד שדות גישה בוליאניים מ-Content API (לדוגמה, admin, reportingManager) לשדה אחד שניתן לחזור עליו access_rights.
  • הזמנת משתמשים ואימות: ב-Merchant API יש סטטוס משתמש מפורש (PENDING או VERIFIED). כשיוצרים משתמש חדש, הוא נמצא בסטטוס PENDING עד שהוא מאשר את ההזמנה. הוא מספק ל-API גישה לסטטוס של המשתמש, שלא הייתה זמינה ב-Content API for Shopping. הוספה ## בקשות

כדי לנהל משתמשים, Merchant API משתמש בכתובות ה-URL הבאות לבקשות:

  • GET /accounts/v1/accounts/{account}/users/{email}
  • GET /accounts/v1/accounts/{account}/users
  • POST /accounts/v1/accounts/{account}/users
  • PATCH /accounts/v1/accounts/{account}/users/{email}
  • DELETE /accounts/v1/accounts/{account}/users/{email}

בטבלה הבאה מוצגת השוואה בין כתובות ה-URL של הבקשות ב-Content API for Shopping וב-Merchant API.

תיאור הבקשה Content API for Shopping Merchant API
קבלת משתמשים של חשבון GET {api_version}/{merchantId}/accounts/{accountId} GET {api_version}/accounts/{account}/users
יצירת משתמש PATCH {api_version}/{merchantId}/accounts/{accountId} POST {api_version}/accounts/{account}/users
עדכון משתמש PATCH {api_version}/{merchantId}/accounts/{accountId} PATCH {api_version}/accounts/{account}/users/{email}
מחיקת משתמש PATCH {api_version}/{merchantId}/accounts/{accountId} DELETE {api_version}/accounts/{account}/users/{email}

מזהים

בטבלה הבאה מוצגת השוואה בין המזהים שמשמשים בבקשות ב-Content API for Shopping וב-Merchant API.

תיאור המזהה Content API for Shopping Merchant API
מזהה החשבון accountId account ב-accounts/{account}
מזהה המשתמש email_address בתוך האובייקט AccountUser email ב-accounts/{account}/users/{email}

Methods

בטבלה הבאה מוצגת השוואה בין השיטות של Content API for Shopping לבין אלה של Merchant API.

Content API for Shopping Merchant API זמינות והערות
accounts.update users.create יוצרת משתמש חדש בחשבון.
accounts.get users.get אחזור של משתמש יחיד.
accounts.get users.list הצגת רשימה של כל המשתמשים בחשבון.
accounts.update users.patch עדכון הרשאות הגישה של משתמש.
accounts.update users.delete מחיקת משתמש מחשבון.

שינויים מפורטים בשדות

כדי לעדכן את השימוש בשדות:

Content API for Shopping Merchant API תיאור
users (חזרה AccountUser) users (חזרה User) המשאב User הוא עכשיו משאב ברמה העליונה עם שירות משלו.
AccountUser.email_address ‫CreateUserRequest.user_id וחלק מ-User.name כתובת האימייל של המשתמש היא עכשיו חלק משם המשאב. מציינים אותו בשדה user_id במהלך היצירה.
AccountUser.admin access_rights: "ADMIN" ב-Merchant API, השדה הבוליאני admin מוחלף בערך ADMIN ב-enum‏ access_rights.
AccountUser.order_manager,‏ AccountUser.payments_manager,‏ AccountUser.payments_analyst access_rights: "STANDARD" ב-Merchant API, התפקידים האלה מוחלפים בהרשאת הגישה STANDARD.
AccountUser.reporting_manager access_rights: "PERFORMANCE_REPORTING" התפקיד reporting_manager הוא עכשיו הרשאת הגישה PERFORMANCE_REPORTING.
AccountUser.read_only access_rights: "READ_ONLY" התפקיד read_only הוא עכשיו הרשאת הגישה READ_ONLY.
לא זמין User.name מכיל את השם המלא של המשאב של המשתמש, לדוגמה accounts/{account}/users/{email}.
לא זמין User.state מציין את סטטוס ההזמנה של המשתמש, PENDING או VERIFIED.