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