يشرح هذا الدليل كيفية نقل عملية الدمج من RegionsService في Content API for Shopping إلى RegionsService ضمن واجهة برمجة التطبيقات الفرعية للحسابات.
تتيح لك خدمة "المناطق" تحديد مناطق جغرافية مخصّصة لحالات الاستخدام، مثل
إلغاء السعر والشحن على مستوى منطقة معيّنة. يمكنك استخدام المناطق مع خدمات
مثل RegionalInventory وShippingSettings.
الاختلافات الرئيسية
- بنية واجهة برمجة التطبيقات: أصبحت خدمة "المناطق" الآن جزءًا من واجهة برمجة التطبيقات الفرعية
Accountsفي Merchant API (على سبيل المثال،merchantapi.googleapis.com/accounts/v1/...). - أسماء الموارد: تستخدم Merchant API أسماء الموارد
(
accounts/{account}/regions/{region}) بدلاً من مَعلمتَيmerchant_idوregion_idالمنفصلتين في مسار عنوان URL لعمليات الحصول على البيانات والتعديل والحذف. - التوافق مع AIP: تتّبع طرق Merchant API أنماط اقتراحات تحسين واجهة برمجة التطبيقات العادية (مثل استخدام
parentلـ List/Create وnameلـ Get/Delete واستخدامupdate_maskالعادي). - أنواع برامج تضمين البيانات: الحقول التي كانت تستخدم سابقًا
google.protobuf.StringValueأوgoogle.protobuf.BoolValueفي Content API أصبحت الآن تستخدم حقولoptionalالعادية في Merchant API. - الميزات الجديدة:
- توفّر Merchant API نوع
RadiusAreaضمن المرجعRegionلتحديد المناطق استنادًا إلى نطاق جغرافي حول نقطة معيّنة (في البداية مع إذن الوصولTRUST_TESTER). - تتوفّر طرق الدُفعات:
BatchCreateRegionsوBatchUpdateRegionsوBatchDeleteRegions.
- توفّر Merchant API نوع
- معالجة الأخطاء: توفّر رموز الخطأ ورسائله ملاحظات أكثر تحديدًا.
الطلبات
في ما يلي كيفية تغيُّر أنماط الطلبات:
| Item | Content API for Shopping | Merchant API | الوصف |
|---|---|---|---|
| Endpoint | https://shoppingcontent.googleapis.com |
https://merchantapi.googleapis.com |
تغيير النطاق الأساسي |
| Get Path | /content/v2.1/{merchant_id}/regions/{region_id} |
/accounts/v1/{name=accounts/*/regions/*} |
تستخدم Merchant API واجهة برمجة التطبيقات الفرعية accounts والمرجع name. |
| List Path | /content/v2.1/{merchant_id}/regions |
/accounts/v1/{parent=accounts/*}/regions |
تستخدم Merchant API السمة parent لتحديد الحساب. |
| إنشاء مسار | /content/v2.1/{merchant_id}/regions |
/accounts/v1/{parent=accounts/*}/regions |
تستخدم Merchant API السمة parent. region_id هو حقل في نص الطلب. |
| تعديل المسار | /content/v2.1/{merchant_id}/regions/{region_id} |
/accounts/v1/{name=accounts/*/regions/*} |
اسم المورد في Merchant API هو جزء من عنصر region في النص. |
| حذف المسار | /content/v2.1/{merchant_id}/regions/{region_id} |
/accounts/v1/{name=accounts/*/regions/*} |
يتم استخدام المرجع name. |
المعرّفات
يُرجى تغيير طريقة استخدام المعرّفات على النحو التالي:
| Item | Content API for Shopping | Merchant API | الوصف |
|---|---|---|---|
| الحساب | merchant_id (عدد صحيح) |
account (عدد صحيح، جزء من سلسلة name أو parent) |
ابحث عن رقم تعريف الحساب المضمّن في سلسلة اسم المورد، على سبيل المثال، accounts/{account}. |
| الإقليم | region_id (سلسلة) |
{region} (سلسلة، جزء من سلسلة name) |
ابحث عن رقم تعريف المنطقة المضمّن في سلسلة اسم المورد، مثلاً accounts/{account}/regions/{region}. |
| اسم المورد | لا يتم استخدامه بشكل صارم للطلبات. | name: accounts/{account}/regions/{region} |
المعرّف العادي لطلبات الحصول على البيانات أو تعديلها أو حذفها |
| اسم أحد الوالدَين | لا يتم استخدامه بشكل صارم للطلبات. | parent: accounts/{account} |
المعرّف العادي لطلبات List/Create. |
الموارد
تم إجراء تغييرات طفيفة على بنية المورد Region:
| Item | Content API for Shopping | Merchant API | الوصف |
|---|---|---|---|
| معرّف المورد | region_id (سلسلة)، merchant_id (int64) |
name (سلسلة): accounts/{account}/regions/{region} |
تستخدم Merchant API حقل name واحدًا كمعرّف للمرجع. |
display_name |
google.protobuf.StringValue |
optional string |
تمت إزالة نوع وحدة التغليف. |
radius_area |
لا ينطبق (N/A) | RadiusArea |
يحدّد هذا النوع الجديد المناطق حسب نصف القطر. تشمل
region_code وlat_lng وradius
وradius_units. تكون إمكانية العرض مقيّدة تلقائيًا.
|
regional_inventory_eligible |
google.protobuf.BoolValue (للإخراج فقط) |
optional bool (للإخراج فقط) |
تمت إزالة نوع وحدة التغليف. |
shipping_eligible |
google.protobuf.BoolValue (للإخراج فقط) |
optional bool (للإخراج فقط) |
تمت إزالة نوع وحدة التغليف. |
الطُرق
غيِّر استخدامك للطرق على النحو التالي:
| Item | Content API for Shopping | Merchant API | الوصف |
|---|---|---|---|
| Get Region | GetRegion |
GetRegion |
يستخدم الطلب name. |
| إنشاء منطقة | CreateRegion |
CreateRegion |
يأخذ الطلب parent من عنوان URL، بينما يتضمّن نص الطلب العنصر region وregion_id.
|
| تعديل المنطقة | UpdateRegion |
UpdateRegion |
يستخدم الطلب region (الذي يجب أن يتضمّن region.name) وupdate_mask.
|
| حذف المنطقة | DeleteRegion
|
DeleteRegion
|
يستخدم الطلب name.
|
| List Regions | ListRegions |
ListRegions |
يستخدم الطلب parent. page_size وpage_token متّسق.
|
| إنشاء دُفعة | لا ينطبق | BatchCreateRegions |
هذه طريقة جديدة. |
| تعديلات مجمَّعة | لا ينطبق | BatchUpdateRegions |
هذه طريقة جديدة. |
| الحذف المجمّع | لا ينطبق | BatchDeleteRegions |
هذه طريقة جديدة. |
الحقول التي تمت إعادة تسميتها
| Item | Content API for Shopping | Merchant API | الوصف |
|---|---|---|---|
| رقم تعريف الحساب | merchant_id |
account (جزء من name أو parent) |
تم دمجها في سلاسل موارد name. يؤثّر ذلك في Region (الاستجابة) ورسائل protobuf المستخدَمة لإجراء طلبات البيانات من واجهة برمجة التطبيقات، مثل CreateRegionRequest, GetRegionRequest, UpdateRegionRequest, DeleteRegionRequest وListRegionsRequest.
|
| رقم تعريف المنطقة | region_id |
region (جزء من name)، region_id |
مدمجة في name لمعظم الحالات، وحقل region_id منفصل في CreateRegionRequest يؤثّر ذلك في Region
(الاستجابة) ورسائل protobuf المستخدَمة لإرسال طلبات البيانات من واجهة برمجة التطبيقات، مثل
CreateRegionRequest, GetRegionRequest, UpdateRegionRequest, DeleteRegionRequest
وListRegionsRequest.
|
| اسم المنطقة (الناتج) | region_id
|
name
|
أصبح حقل المعرّف الأساسي في الاستجابة الآن هو المورد الكامل name. يؤثر ذلك في Region.
|
| الاسم المعروض | display_name |
display_name |
يتغيّر النوع من StringValue إلى optional string.
يؤثر ذلك في Region.
|
| علامات الأهلية | ...eligible |
...eligible |
يتغيّر النوع من BoolValue إلى optional bool.
يؤثر ذلك في Region.
|
| قناع التعديل | update_mask |
update_mask |
مسارات الحقول: Region يؤثر ذلك في UpdateRegionRequest. |