ย้ายข้อมูลการจัดการภูมิภาค

คู่มือนี้อธิบายวิธีย้ายข้อมูลการผสานรวมจาก RegionsService ใน Content API for Shopping ไปยัง RegionsService ภายใน Accounts Sub-API

บริการ Regions ช่วยให้คุณกำหนดพื้นที่ทางภูมิศาสตร์ที่กำหนดเองสำหรับกรณีการใช้งาน เช่น การกำหนดราคาและการลบล้างการจัดส่งระดับภูมิภาค คุณสามารถใช้ภูมิภาคกับบริการต่างๆ เช่น RegionalInventory และ ShippingSettings

ความแตกต่างที่สำคัญ

  • โครงสร้าง API: ตอนนี้บริการ Regions เป็นส่วนหนึ่งของ Accounts Sub-API ใน Merchant API (เช่น merchantapi.googleapis.com/accounts/v1/...)
  • ชื่อทรัพยากร: Merchant API ใช้ชื่อทรัพยากร (accounts/{account}/regions/{region}) แทนพารามิเตอร์ merchant_id และ region_id แยกกันในเส้นทาง URL สำหรับการดำเนินการ Get, Update และ Delete
  • การปฏิบัติตามข้อกำหนด AIP: เมธอด Merchant API เป็นไปตามรูปแบบข้อเสนอแนะมาตรฐานในการปรับปรุง API (เช่น การใช้ parent สำหรับ List/Create, name สำหรับ Get/Delete และการใช้งาน update_mask มาตรฐาน)
  • ประเภท Wrapper: ตอนนี้ฟิลด์ที่เคยใช้ 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 Sub-API และ 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 (int64) name (สตริง): accounts/{account}/regions/{region} Merchant API ใช้ฟิลด์ name เดียวเป็นตัวระบุทรัพยากร
display_name google.protobuf.StringValue optional string นำประเภท Wrapper ออกแล้ว
radius_area ไม่พร้อมให้บริการ (ไม่มี) RadiusArea ประเภทใหม่นี้กำหนดภูมิภาคตามรัศมี ซึ่งรวมถึง region_code, lat_lng, radius, radius_units. โดยค่าเริ่มต้น การมองเห็นจะถูกจำกัด
regional_inventory_eligible google.protobuf.BoolValue (เอาต์พุตเท่านั้น) optional bool (เอาต์พุตเท่านั้น) นำประเภท Wrapper ออกแล้ว
shipping_eligible google.protobuf.BoolValue (เอาต์พุตเท่านั้น) optional bool (เอาต์พุตเท่านั้น) นำประเภท Wrapper ออกแล้ว

เมธอด

เปลี่ยนการใช้เมธอดดังนี้

รายการ 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 (การตอบกลับ) และข้อความ Protobuf ที่ใช้ในการส่งคำขอ API เช่น CreateRegionRequest, GetRegionRequest, UpdateRegionRequest, DeleteRegionRequest และ ListRegionsRequest
รหัสภูมิภาค region_id region (ส่วนหนึ่งของ name), region_id ผสานรวมกับ name สำหรับส่วนใหญ่ ฟิลด์ region_id แยกกันใน CreateRegionRequest ซึ่งจะส่งผลต่อ Region (การตอบกลับ) และข้อความ 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 shipping settings management