في 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
إلى أن يقبل الدعوة. يتيح ذلك إمكانية الاطّلاع على حالة المستخدم من خلال واجهة برمجة التطبيقات، وهو أمر لم يكن متاحًا في Content API for Shopping. إضافة ## طلبات
تستخدم Merchant API عناوين URL التالية للطلبات من أجل إدارة المستخدمين:
GET /accounts/v1beta/accounts/{account}/users/{email}
GET /accounts/v1beta/accounts/{account}/users
POST /accounts/v1beta/accounts/{account}/users
PATCH /accounts/v1beta/accounts/{account}/users/{email}
DELETE /accounts/v1beta/accounts/{account}/users/{email}
يقارن الجدول التالي بين عناوين URL للطلبات في Content API for Shopping وMerchant API.
وصف الطلب | واجهة برمجة تطبيقات المحتوى في 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.
وصف المعرّف | واجهة برمجة تطبيقات المحتوى في Shopping | Merchant API |
---|---|---|
معرّف الحساب | accountId |
account في accounts/{account} |
معرّف المستخدم | email_address ضمن العنصر AccountUser |
email في accounts/{account}/users/{email} |
الطُرق
يقارن الجدول التالي بين طرق Content API for Shopping وMerchant API.
واجهة برمجة تطبيقات المحتوى في Shopping | Merchant API | التوفّر والملاحظات |
---|---|---|
accounts.update |
users.create |
تنشئ هذه الطريقة مستخدمًا جديدًا لحساب. |
accounts.get |
users.get |
لاسترداد مستخدم واحد |
accounts.get |
users.list |
تعرض هذه الطريقة قائمة بجميع المستخدمين في حساب معيّن. |
accounts.update |
users.update |
تعديل حقوق وصول المستخدم |
accounts.update |
users.delete |
يحذف هذا الإجراء مستخدمًا من حساب. |
تغييرات الحقول التفصيلية
عدِّل استخدامك للحقول على النحو التالي:
واجهة برمجة تطبيقات المحتوى في 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 في تعداد 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 . |