نقل بيانات إدارة المناطق

يوضّح هذا الدليل كيفية نقل عملية التكامل من 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.
  • التعامل مع الأخطاء: تقدّم رموز الخطأ ورسائله ملاحظات أكثر تحديدًا.

الطلبات

في ما يلي كيفية تغيير أنماط الطلبات:

العنصر 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.
حذف المنطقة DeleteRegion DeleteRegion يستخدم الطلب name.
عرض المناطق ListRegions ListRegions يستخدم الطلب parent. page_size وسلوك page_token متطابق.
إنشاء دُفعة لا ينطبق BatchCreateRegions هذه طريقة جديدة.
تعديل دُفعة لا ينطبق BatchUpdateRegions هذه طريقة جديدة.
حذف دُفعة لا ينطبق BatchDeleteRegions هذه طريقة جديدة.

الحقول التي تمت إعادة تسميتها

العنصر Content API for Shopping Merchant API الوصف
رقم تعريف الحساب merchant_id account (جزء من name أو parent) مدمَج في سلاسل name للمورد. يؤثّر ذلك في Region (الرد) ورسائل بروتوكول المخزن المؤقت المستخدَمة لتقديم طلبات واجهة برمجة التطبيقات ، مثل CreateRegionRequest, GetRegionRequest, UpdateRegionRequest, DeleteRegionRequest وListRegionsRequest.
رقم تعريف المنطقة region_id region (جزء من nameregion_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.

مزيد من المعلومات