مدیریت منطقه مهاجرت

این راهنما نحوه انتقال یکپارچه‌سازی شما از RegionsService در API محتوا برای خرید به RegionsService در زیر-API حساب‌ها را توضیح می‌دهد.

سرویس مناطق به شما امکان می‌دهد مناطق جغرافیایی سفارشی را برای مواردی مانند قیمت‌گذاری منطقه‌ای و لغو حمل و نقل تعریف کنید. می‌توانید از مناطقی با سرویس‌هایی مانند RegionalInventory و ShippingSettings استفاده کنید.

تفاوت‌های کلیدی

  • ساختار API: سرویس مناطق اکنون بخشی از زیر-API Accounts در API فروشنده است (برای مثال، merchantapi.googleapis.com/accounts/v1/... ).
  • نام منابع: رابط برنامه‌نویسی کاربردی فروشنده (Merchant API) به جای پارامترهای جداگانه merchant_id و region_id در مسیر URL برای عملیات‌های Get، Update و Delete، از نام منابع ( accounts/{account}/regions/{region} ) استفاده می‌کند.
  • انطباق با AIP: روش‌های API پذیرنده از الگوهای استاندارد پیشنهاد بهبود 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 - در دسترس هستند.
  • مدیریت خطا: کدهای خطا و پیام‌ها بازخورد دقیق‌تری ارائه می‌دهند.

درخواست‌ها

در اینجا نحوه تغییر الگوهای درخواست آمده است:

مورد API محتوا برای خرید رابط برنامه‌نویسی کاربردی (API) فروشنده توضیحات
نقطه پایانی https://shoppingcontent.googleapis.com https://merchantapi.googleapis.com دامنه پایه تغییر می‌کند.
دریافت مسیر /content/v2.1/{merchant_id}/regions/{region_id} /accounts/v1/{name=accounts/*/regions/*} رابط برنامه‌نویسی کاربردی فروشنده از زیر-رابط کاربری accounts و یک name منبع استفاده می‌کند.
مسیر لیست /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 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 منبع استفاده می‌کند.

شناسه‌ها

نحوه‌ی استفاده از شناسه‌ها را به صورت زیر تغییر دهید:

مورد API محتوا برای خرید رابط برنامه‌نویسی کاربردی (API) فروشنده توضیحات
حساب کاربری merchant_id (عدد صحیح) account (عدد صحیح، بخشی از name یا رشته parent ) شناسه حساب کاربری تعبیه شده در رشته نام منبع، برای مثال، accounts/{account} را پیدا کنید.
منطقه region_id (رشته) {region} (رشته، بخشی از رشته name ) شناسه منطقه (region ID) تعبیه شده در رشته نام منبع، برای مثال، accounts/{account}/regions/{region} را پیدا کنید.
نام منبع صرفاً برای درخواست‌ها استفاده نمی‌شود. name : accounts/{account}/regions/{region} شناسه استاندارد برای درخواست‌های Get/Update/Delete.
نام والدین صرفاً برای درخواست‌ها استفاده نمی‌شود. parent : accounts/{account} شناسه استاندارد برای درخواست‌های List/Create.

منابع

ساختار منابع Region تغییرات جزئی دارد:

مورد API محتوا برای خرید رابط برنامه‌نویسی کاربردی (API) فروشنده توضیحات
شناسه منبع region_id (رشته)، merchant_id (int64) 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 (فقط خروجی) نوع بسته‌بندی حذف شد.

روش‌ها

نحوه‌ی استفاده از متدها را به صورت زیر تغییر دهید:

مورد API محتوا برای خرید رابط برنامه‌نویسی کاربردی (API) فروشنده توضیحات
دریافت منطقه GetRegion GetRegion این درخواست name استفاده می‌کند.
ایجاد منطقه CreateRegion CreateRegion این درخواست، parent از URL می‌گیرد، در حالی که بدنه درخواست شامل شیء region و region_id می‌شود.
منطقه را به روز کنید UpdateRegion UpdateRegion این درخواست از region (که باید شامل region.name باشد) و update_mask استفاده می‌کند.
حذف منطقه DeleteRegion DeleteRegion این درخواست name استفاده می‌کند.
فهرست مناطق ListRegions ListRegions این درخواست page_size parent استفاده می‌کند و رفتار page_token سازگار است.
ایجاد دسته‌ای ناموجود BatchCreateRegions این یک روش جدید است.
به‌روزرسانی دسته‌ای ناموجود BatchUpdateRegions این یک روش جدید است.
حذف دسته‌ای ناموجود BatchDeleteRegions این یک روش جدید است.

فیلدهای تغییر نام داده شده

مورد API محتوا برای خرید رابط برنامه‌نویسی کاربردی (API) فروشنده توضیحات
شناسه حساب merchant_id account (بخشی از name یا parent ) در رشته‌های name منبع ادغام می‌شود. این موضوع بر پیام‌های Region (response) و protobuf که برای ایجاد درخواست‌های API مانند CreateRegionRequest, GetRegionRequest, UpdateRegionRequest, DeleteRegionRequest و ListRegionsRequest استفاده می‌شوند، تأثیر می‌گذارد.
شناسه منطقه region_id region (بخشی از name )، region_id برای اکثر موارد، فیلد region_id جداگانه در CreateRegionRequest در name ادغام شده است. این موضوع بر پیام‌های Region (response) و protobuf که برای ایجاد درخواست‌های API مانند 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 تأثیر می‌گذارد.

بیشتر بدانید

قبلی
Migrate homepage management
بعدی
Migrate inventory management