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

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 สำหรับ 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 ที่กำลังอัปเดต