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

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 และ สถานะการอ้างสิทธิ์ตามลำดับ
  • ข้อมูลแบบรวมศูนย์: ทรัพยากร Homepage ของ Merchant API มี ทั้ง 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 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 ที่กำลังอัปเดต