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.unclaimContent API for Shopping ใช้accounts.claimwebsiteสำหรับการดำเนินการอ้างสิทธิ์accounts.updateเพื่อตั้งค่า URL (และปฏิเสธการเป็นเจ้าของอย่างมีประสิทธิภาพโดยการตั้งค่า URL ว่าง) และaccounts.get/accountstatuses.getเพื่อดึงข้อมูล URL และ สถานะการอ้างสิทธิ์ตามลำดับ
- ดึงข้อมูลรายละเอียดหน้าแรก:
- ข้อมูลแบบรวมศูนย์: แหล่งข้อมูล
HomepageMerchant API มีทั้งuri(URL ของหน้าแรก) และสถานะclaimedโดยตรง เมธอดทั้งหมด ที่ทำงานกับทรัพยากรHomepageจะแสดงผลทรัพยากรนี้ ซึ่งให้ ความคิดเห็นทันทีเกี่ยวกับสถานะปัจจุบัน ใน Content API for Shoppingaccounts.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 (ฟิลด์บูลีนเอาต์พุตเท่านั้นในทรัพยากร Homepage) |
ระบุว่ามีการอ้างสิทธิ์และยืนยัน uri แล้วหรือไม่ สถานะนี้จะอยู่ในทรัพยากร Homepage ที่เมธอด Merchant API ที่เชื่อมโยงทั้งหมดส่งคืน |
| ไม่มี | UpdateHomepageRequest.update_mask accounts.homepage.updateHomepage พารามิเตอร์เนื้อหาคำขอ) |
ฟิลด์มาสก์ที่ไม่บังคับสำหรับ homepage.update เพื่อระบุฟิลด์ (เช่น uri) ของทรัพยากร Homepage กำลังได้รับการอัปเดต |