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

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

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

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

  • โครงสร้าง API: ตอนนี้บริการภูมิภาคเป็นส่วนหนึ่งของ Accounts 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 โดเมนฐานมีการเปลี่ยนแปลง
รับเส้นทาง /content/v2.1/{merchant_id}/regions/{region_id} /accounts/v1/{name=accounts/*/regions/*} Merchant API ใช้ accounts sub-API และทรัพยากร 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 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 นำประเภทเครื่องหุ้มออกแล้ว
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 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

ดูข้อมูลเพิ่มเติม