ย้ายข้อมูลการตั้งค่าหน้าแรก

Merchant API มีทรัพยากร Homepage เฉพาะ แหล่งข้อมูลนี้มีวิธีการใหม่ในการจัดการการอ้างสิทธิ์หน้าแรก ซึ่งมีความสามารถที่เหนือกว่า Content API for Shopping แบบคลาสสิก

การเข้าถึงฟีเจอร์สำหรับร้านค้าออนไลน์เป็นกระบวนการ 2 ขั้นตอน ได้แก่ การยืนยัน ความเป็นเจ้าของก่อน แล้วจึงอ้างสิทธิ์เว็บไซต์สำหรับบัญชี หากต้องการทำขั้นตอนสุดท้ายให้เสร็จสมบูรณ์ ให้ใช้ accounts.homepage.claim

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

Merchant API ทำการเปลี่ยนแปลงที่เกี่ยวข้องกับหน้าแรกหลายอย่างเมื่อเทียบกับ Content API for Shopping ดังนี้

  • ทรัพยากรเฉพาะ: Merchant API มีทรัพยากร Homepage ที่แยกต่างหาก (accounts.homepage) สำหรับการดำเนินการที่เกี่ยวข้องกับหน้าแรกทั้งหมด (ใน Content API for Shopping คุณใช้ accounts.claimwebsite เพื่อดำเนินการอ้างสิทธิ์ URL หน้าแรก (website_url) เป็นส่วนหนึ่งของแหล่งข้อมูล Account และสถานะการอ้างสิทธิ์ (website_claimed) เป็นส่วนหนึ่งของแหล่งข้อมูล AccountStatus)
  • เมธอดแบบละเอียด: Merchant API มีเมธอดเฉพาะสำหรับดำเนินการต่อไปนี้
    • ดึงข้อมูลรายละเอียดหน้าแรก: accounts.homepage.getHomepage
    • อัปเดต URI ของหน้าแรก: accounts.homepage.updateHomepage
    • อ้างสิทธิ์หน้าแรก: accounts.homepage.claim
    • ปฏิเสธการเป็นเจ้าของหน้าแรก: accounts.homepage.unclaim Content API for Shopping ใช้ accounts.claimwebsite สำหรับการดำเนินการอ้างสิทธิ์ accounts.update เพื่อตั้งค่า URL (และปฏิเสธการเป็นเจ้าของอย่างมีประสิทธิภาพโดยการตั้งค่า URL ที่ว่างเปล่า) และ accounts.get/accountstatuses.get เพื่อดึงข้อมูล URL และ สถานะการอ้างสิทธิ์ตามลำดับ
  • ข้อมูลแบบรวมศูนย์: แหล่งข้อมูล Merchant API Homepage มีทั้งuri (URL ของหน้าแรก) และclaimedสถานะโดยตรง เมธอดทั้งหมด ที่ดำเนินการกับทรัพยากร Homepage จะแสดงผลทรัพยากรนี้ ซึ่งให้ ความคิดเห็นทันทีเกี่ยวกับสถานะปัจจุบัน ใน Content API for Shopping accounts.claimwebsite ไม่ได้แสดงสถานะที่อัปเดตแล้ว จึงต้องมีการเรียกแยกต่างหาก
  • การปฏิเสธอย่างชัดแจ้ง: ใน Content API for Shopping โดยปกติแล้วการปฏิเสธจะทำได้โดยการอัปเดต Account.website_url เป็นสตริงว่าง Merchant API มี homepage.unclaim เมธอดเฉพาะ
  • การอ้างสิทธิ์ทับซ้อน: API ทั้ง 2 รายการรองรับพารามิเตอร์ overwrite ในระหว่างกระบวนการอ้างสิทธิ์เพื่อรับช่วงการอ้างสิทธิ์จากบัญชีอื่น หากยืนยันการเป็นเจ้าของได้

คำขอ

Merchant API ใช้ปลายทาง RESTful ที่แตกต่างกันเพื่อจัดการแง่มุมต่างๆ ของ หน้าแรก

รายละเอียดสำหรับคำขอ Content API for Shopping สำหรับ Shopping Merchant API
ดูรายละเอียดหน้าแรก accounts.get (อ่าน Account.website_url), accountstatuses.get (อ่าน AccountStatus.website_claimed) GET /accounts/v1/accounts/{account}/homepage
อัปเดต URI ของหน้าแรก accounts.update (การตั้งค่า Account.website_url) PATCH /accounts/v1/accounts/{account}/homepage
อ้างสิทธิ์หรือยืนยันหน้าแรกอีกครั้ง POST /content/v2.1/{merchantId}/accounts/{accountId}/claimwebsite (ดำเนินการเมื่อ Account.website_url ตั้งค่าโดยใช้ accounts.update) POST /accounts/v1/accounts/{account}/homepage:claim
ข้อจำกัดความรับผิดของหน้าแรก accounts.update (ตั้งค่า Account.website_url เป็นสตริงว่าง) POST /accounts/v1/accounts/{account}/homepage:unclaim

รหัสระบุ

เราได้ปรับปรุงการระบุทรัพยากรใน Merchant API

คำอธิบายตัวระบุ Content API for Shopping Merchant API
ตัวระบุบัญชีสำหรับการเข้าถึงทรัพยากร merchantId (บัญชีขั้นสูง) และ accountId (บัญชีย่อย) ในเส้นทาง account (ส่วนหนึ่งของฟิลด์ name เช่น accounts/{account_id}/homepage)
ตัวระบุทรัพยากรของหน้าแรก ไม่เกี่ยวข้อง (โดยนัยกับทรัพยากร Account) name: accounts/{account_id}/homepage (ระบุทรัพยากรย่อย Homepage)

เมธอด

ตอนนี้accounts.claimwebsiteเมธอดจาก Content API for Shopping ซึ่งมุ่งเน้นที่การดำเนินการอ้างสิทธิ์ได้รวมอยู่ในฟังก์ชันการทำงานที่กว้างขึ้นภายในแหล่งข้อมูล Homepage ของ Merchant API แล้ว

เมธอด Content API for Shopping เมธอดของ Merchant API ความพร้อมใช้งานและหมายเหตุ
accounts.claimwebsite accounts.homepage.claim เริ่มหรือยืนยันการอ้างสิทธิ์เว็บไซต์อีกครั้งโดยตรง ดำเนินการกับ uri ที่ตั้งค่าไว้ก่อนหน้านี้โดยใช้ homepage.update มีพารามิเตอร์ overwrite แสดงผลทรัพยากร Homepage พร้อมสถานะ uri และ claimed ปัจจุบัน
accounts.get (อ่าน Account.website_url), accountstatuses.get (อ่าน AccountStatus.website_claimed) accounts.homepage.getHomepage วิธีเฉพาะใหม่ในการดึงข้อมูลuriหน้าแรกปัจจุบันและclaimedสถานะของหน้าแรกในการเรียกใช้ครั้งเดียว
accounts.update (ตั้งค่า Account.website_url) accounts.homepage.updateHomepage วิธีเฉพาะใหม่ในการตั้งค่าหรือเปลี่ยนหน้าแรก uri
accounts.update (การตั้งค่า Account.website_url เป็นสตริงที่ว่างเปล่าเพื่อเป็นวิธีแก้ปัญหาในการยกเลิกการอ้างสิทธิ์) accounts.homepage.unclaim วิธีใหม่เฉพาะในการยกเลิกการอ้างสิทธิ์หน้าแรกอย่างชัดเจน

การเปลี่ยนแปลงฟิลด์โดยละเอียด

เราได้เปลี่ยนแปลงวิธีจัดโครงสร้างและเข้าถึงข้อมูลหน้าแรกอย่างมาก เพื่อมุ่งไปสู่Homepageที่ชัดเจนใน Merchant API

Content API for Shopping Merchant API คำอธิบาย
merchantId (พารามิเตอร์เส้นทางสำหรับ accounts.claimwebsite) name (พารามิเตอร์เส้นทางสําหรับเมธอด Homepage รูปแบบ: accounts/{account}/homepage) account ในสตริง name ใน Merchant API จะสอดคล้องกับ accountId จาก Content API for Shopping
accountId (พารามิเตอร์เส้นทางสำหรับ accounts.claimwebsite) name (พารามิเตอร์เส้นทางสําหรับเมธอด Homepage รูปแบบ: accounts/{account}/homepage) ตัวระบุสำหรับบัญชีที่เฉพาะเจาะจงซึ่งมีการจัดการหน้าแรก
overwrite (บูลีนในContentAccountsClaimwebsiteRequestเนื้อหาและAccountsCustomBatchRequestEntry) ClaimHomepageRequest.overwrite (บูลีนในเนื้อหาคำขอ homepage.claim) ไม่บังคับ หาก true พยายามอ้างสิทธิ์เว็บไซต์ ระบบอาจนำการอ้างสิทธิ์ที่มีอยู่แล้วออกจากบัญชีอื่น หากบัญชีที่ขอสามารถยืนยันความเป็นเจ้าของได้
Account.website_url (ฟิลด์ในทรัพยากร Account ตั้งค่าโดยใช้ accounts.update อ่านโดยใช้ accounts.get) Homepage.uri (ฟิลด์ในทรัพยากร Homepage) URI (URL) ของหน้าแรกของร้านค้า ใน Merchant API ฟิลด์นี้เป็นฟิลด์ที่ชัดเจนภายในทรัพยากร Homepage โดยจะตั้งค่าโดยใช้ accounts.homepage.updateHomepage และแสดงผลโดยเมธอด Homepage ทั้งหมด
AccountStatus.website_claimed (ฟิลด์ในทรัพยากร AccountStatus อ่านโดยใช้ accountstatuses.get) Homepage.claimed (ฟิลด์บูลีน output_only ในทรัพยากร Homepage) ระบุว่ามีการอ้างสิทธิ์และยืนยัน uri แล้วหรือไม่ สถานะนี้จะพร้อมใช้งานโดยตรงในทรัพยากร Homepage ที่เมธอด Merchant API ที่เชื่อมโยงทั้งหมดส่งคืน
ไม่มี UpdateHomepageRequest.update_mask accounts.homepage.updateHomepage พารามิเตอร์เนื้อความของคำขอ) ฟิลด์มาสก์ที่ไม่บังคับสำหรับ homepage.update เพื่อระบุฟิลด์ (เช่น uri) ของทรัพยากร Homepage กำลังได้รับการอัปเดต
ก่อนหน้า
Migrate user and access management
ถัดไป
Migrate region management