يمكنك استخدام هذا الدليل لدمج Merchant API مع طريقة تنفيذ Content API for Shopping الحالية.
البدء
يمكنك الاطّلاع على تصميم Merchant API للحصول على تفاصيل حول Merchant API وواجهات برمجة التطبيقات الفرعية الخاصة بها.
لبدء استخدام Merchant API، غيِّر عناوين URL الخاصة بطلباتك إلى التنسيق التالي:
https://merchantapi.googleapis.com/{sub-API}/{version}/{resource name}/{service}:{method}…
يمكنك الاطّلاع على دليل البدء السريع ومرجع Merchant API للحصول على المزيد من المعلومات.
دعم gRPC
تتيح واجهة Merchant API استخدام gRPC وREST. يمكنك استخدام gRPC لواجهة Merchant API وREST لـ Content API for Shopping في الوقت نفسه.
تتطلّب مكتبات عملاء Merchant API gRPC.
راجِع استخدام gRPC للحصول على مزيد من المعلومات.
التوافق
يصف هذا الدليل التغييرات العامة التي تنطبق على Merchant API بالكامل. يمكنك الاطّلاع على الأدلة التالية لمعرفة التغييرات في ميزات محدّدة:
- نقل الحسابات لإدارة الحسابات
- نقل إعدادات الشحن
- إدارة المنتجات
- نقل إدارة مصادر البيانات
- نقل بيانات إدارة المستودعات
- نقل بيانات إدارة العروض الترويجية
- نقل بيانات إدارة إعداد التقارير
- نقل إدارة مصادر الإحالات الناجحة
- نقل بيانات إدارة الشراكات في الخلاصات المحلية
تم تصميم Merchant API لتعمل إلى جانب ميزات الإصدار 2.1 الحالية من Content API for Shopping.
على سبيل المثال، يمكنك استخدام واجهة Merchant Inventories API إلى جانب مستودعات الإصدار 2.1 من Content API for Shopping الحالية وتنفيذ products. يمكنك استخدام Content API for Shopping لتحميل منتج محلّي جديد (تبيعه في متجر محلّي)، ثم استخدام مورد Merchant Inventories API LocalInventory لإدارة معلومات المنتجات المتوفّرة في المتجر.
الطلبات المجمّعة
لا تتيح واجهة Merchant API استخدام طريقة customBatch المتوفّرة في Content API for Shopping. بدلاً من ذلك، يمكنك الاطّلاع على إرسال طلبات
مجمّعة. إذا كنت من مستخدمي customBatch وكنت بحاجة إلى هذه الميزة في Merchant API، يُرجى إعلامنا بالسبب في ملاحظاتك.
المعرّفات
للالتزام بمبادئ تحسين واجهات برمجة التطبيقات من Google، أجرينا بعض التغييرات على المعرّفات الخاصة بموارد Merchant API.
سيحل الاسم محل المعرّف
تستخدم كل موارد Merchant API الحقل name كمعرّف فريد.
إليك مثال على كيفية استخدام حقل name في المكالمات:
POST https://merchantapi.googleapis.com/inventories/v1beta/{parent}/regionalInventories:insert
يتم عرض حقل name الجديد هذا كمعرّف مورد لجميع طلبات القراءة والكتابة في Merchant API.
تستخدم القيمة المعروضة في حقول name تنسيق المعرّف الجديد.
على سبيل المثال، يمكنك استخدام طريقة getName() لاسترداد name من أحد الموارد، وتخزين المخرجات كمتغيّر بدلاً من إنشاء name من معرّفات التاجر والموارد بنفسك.
التنسيق الجديد لرقم التعريف
تستخدم معرّفات الموارد في Merchant API التنسيق التالي:
channel~language~feedLabel~offerId
استخدمت موارد Content API القيمة : بدلاً من ~ بين كل قيمة في رقم التعريف:
channel:language:feedLabel:offerId
تعرض كل طلبات البيانات من واجهة Merchant API التنسيق الجديد مع ~ بين قيمتَي
المعرّف. ننصحك بتخزين التنسيق الجديد من الردود واستخدامه في طلباتك المستقبلية.
الحقول الرئيسية للموارد الفرعية
في Merchant API، تحتوي كل الموارد الفرعية على الحقل parent. يمكنك استخدام الحقل parent لتحديد name للمورد الذي تريد إدراج العنصر الفرعي فيه، بدلاً من تمرير المورد الرئيسي بأكمله. يمكنك أيضًا استخدام الحقل parent مع الطُرق list لإدراج الموارد الفرعية لهذه parent.
على سبيل المثال، لإدراج المنتجات المتوفرة داخل المتجر لمنتج معيّن، حدِّد name للمنتج في الحقل parent بالنسبة إلى الطريقة list. في هذه الحالة، يكون product المحدَّد هو parent من
LocalInventory
المصادر التي تم عرضها.
الأنواع
في ما يلي بعض الأنواع الشائعة التي تتم مشاركتها بين واجهات برمجة التطبيقات الفرعية الخاصة بـ Merchant API.
السعر
في ما يلي التغييرات التي طرأت على Price في حزمة Merchant Common:
| Content API | واجهة برمجة تطبيقات التاجر | |
|---|---|---|
| حقل المبلغ | value:string |
amountMicros:int64 |
| حقل العملة | currency:string
|
currencyCode:string |
يتم الآن تسجيل المبلغ Price بالمايكرو، حيث يساوي مليون ميكرو
الوحدة العادية لعملتك.
في Content API for Shopping، كان Price رقمًا عشريًا في شكل سلسلة.
تمّ تغيير اسم حقل المبلغ من value إلى amountMicros.
تمّ تغيير اسم حقل العملة من currency إلى currencyCode. ويبقى التنسيق ISO 4217.