مهاجرت، سازگاری
مدیریت منطقه مهاجرت
این راهنما نحوه انتقال ادغام خود از RegionsService
در Content API برای خرید به RegionsService
در زیر API حسابها را توضیح میدهد.
سرویس مناطق به شما امکان می دهد مناطق جغرافیایی سفارشی را برای موارد استفاده مانند قیمت گذاری منطقه ای و لغو حمل و نقل تعریف کنید. میتوانید از مناطق با خدماتی مانند RegionalInventory
و ShippingSettings
استفاده کنید.
تفاوت های کلیدی
- ساختار API: سرویس Regions اکنون بخشی از API فرعی
Accounts
در Merchant API است (برای مثالmerchantapi.googleapis.com/accounts/v1/...
). - نامهای منابع: Merchant API از نامهای منابع (
accounts/{account}/regions/{region}
) به جای پارامترهایmerchant_id
وregion_id
جداگانه در مسیر URL برای عملیاتهای Get، Update و Delete استفاده میکند. - انطباق با AIP: روشهای API Merchant از الگوهای پیشنهادی بهبود API استاندارد پیروی میکنند (مانند استفاده از
parent
برای List/Create،name
برای دریافت/حذف، و استفاده استانداردupdate_mask
). - انواع Wrapper: فیلدهایی که قبلاً از
google.protobuf.StringValue
یاgoogle.protobuf.BoolValue
در Content API استفاده می کردند، اکنون از فیلدهایoptional
استاندارد در Merchant API استفاده می کنند. - ویژگی های جدید:
- Merchant API یک نوع
RadiusArea
را در منبعRegion
معرفی می کند تا مناطق را بر اساس شعاع اطراف یک نقطه (در ابتدا با قابلیت مشاهدهTRUST_TESTER
) تعریف کند. - روشهای دستهای -
BatchCreateRegions
،BatchUpdateRegions
،BatchDeleteRegions
- در دسترس هستند.
- Merchant API یک نوع
- مدیریت خطا: کدهای خطا و پیام ها بازخورد خاص تری را ارائه می دهند.
درخواست ها
در اینجا نحوه تغییر الگوهای درخواست آمده است:
مورد | Content API برای خرید | Merchant API | توضیحات |
---|---|---|---|
نقطه پایانی | https://shoppingcontent.googleapis.com | https://merchantapi.googleapis.com | دامنه پایه تغییر می کند. |
مسیر را دریافت کنید | /content/v2.1/{merchant_id}/regions/{region_id} | /accounts/v1/{name=accounts/*/regions/*} | Merchant API از API فرعی 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 | 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 منبع استفاده می کند. |
شناسه ها
استفاده از شناسه ها را به صورت زیر تغییر دهید:
مورد | Content API برای خرید | 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} | شناسه استاندارد برای لیست/ایجاد درخواست ها. |
منابع
ساختار منابع Region
تغییرات جزئی دارد:
مورد | Content API برای خرید | 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 (فقط خروجی) | نوع لفاف حذف شد. |
روش ها
استفاده از روش ها را به صورت زیر تغییر دهید:
مورد | Content API برای خرید | 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 سازگار است. |
ایجاد دسته ای | N/A | BatchCreateRegions | این یک روش جدید است. |
بروزرسانی دسته ای | N/A | BatchUpdateRegions | این یک روش جدید است. |
حذف دسته ای | N/A | BatchDeleteRegions | این یک روش جدید است. |
فیلدهای تغییر نام یافته
مورد | Content API برای خرید | Merchant API | توضیحات |
---|---|---|---|
شناسه حساب | merchant_id | account (بخشی از name یا parent ) | در رشته name منابع یکپارچه شده است. این بر پیامهای Region (پاسخ) و پروتوباف استفاده شده برای درخواستهای API، مانند CreateRegionRequest, GetRegionRequest, UpdateRegionRequest, DeleteRegionRequest و ListRegionsRequest تأثیر میگذارد. |
شناسه منطقه | region_id | region (بخشی از name )، region_id | در name اکثر فیلدهای جداگانه region_id در CreateRegionRequest ادغام شده است. این بر پیامهای Region (پاسخ) و پروتوباف استفاده شده برای درخواستهای 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 تأثیر می گذارد. |