Di chuyển chế độ cài đặt trang chủ

Merchant API giới thiệu một tài nguyên chuyên dụng Homepage. Tài nguyên này cung cấp các phương thức mới để quản lý thông tin xác nhận quyền sở hữu trang chủ, mang đến những tính năng vượt trội so với Content API for Shopping cổ điển.

Việc truy cập vào các tính năng cho cửa hàng trực tuyến là một quy trình gồm 2 bước: đầu tiên là xác minh quyền sở hữu, sau đó xác nhận quyền sở hữu trang web cho tài khoản của bạn. Để hoàn tất bước cuối cùng, hãy sử dụng accounts.homepage.claim.

Những điểm khác biệt chính

Merchant API thực hiện một số thay đổi liên quan đến trang chủ so với Content API for Shopping:

  • Tài nguyên riêng: Merchant API cung cấp một tài nguyên Homepage riêng biệt (accounts.homepage) cho tất cả các thao tác liên quan đến trang chủ. Trong Content API for Shopping, bạn đã sử dụng accounts.claimwebsite để thực hiện hành động xác nhận quyền sở hữu, URL trang chủ (website_url) là một phần của tài nguyên Account và trạng thái xác nhận quyền sở hữu (website_claimed) là một phần của tài nguyên AccountStatus.
  • Phương thức chi tiết: Merchant API cung cấp các phương thức cụ thể để:
    • Truy xuất thông tin chi tiết về trang chủ: accounts.homepage.getHomepage
    • Cập nhật URI trang chủ: accounts.homepage.updateHomepage
    • Xác nhận quyền sở hữu trang chủ: accounts.homepage.claim
    • Huỷ xác nhận quyền sở hữu trang chủ: accounts.homepage.unclaim Content API for Shopping đã sử dụng accounts.claimwebsite cho hành động xác nhận quyền sở hữu, accounts.update để đặt URL (và huỷ xác nhận quyền sở hữu một cách hiệu quả bằng cách đặt một URL trống) và accounts.get/accountstatuses.get để truy xuất URL và trạng thái xác nhận quyền sở hữu tương ứng.
  • Thông tin tập trung: Tài nguyên Homepage của Merchant API chứa cả uri (URL trang chủ) và trạng thái claimed trực tiếp. Tất cả các phương thức hoạt động trên tài nguyên Homepage đều trả về tài nguyên này, cung cấp thông tin phản hồi ngay lập tức về trạng thái hiện tại. Trong Content API for Shopping, accounts.claimwebsite không trả về trạng thái đã cập nhật; bạn cần thực hiện các lệnh gọi riêng biệt.
  • Huỷ xác nhận quyền sở hữu rõ ràng: Trong Content API for Shopping, việc huỷ xác nhận quyền sở hữu thường được thực hiện bằng cách cập nhật Account.website_url thành một chuỗi trống. Merchant API cung cấp một phương thức homepage.unclaim riêng.
  • Ghi đè thông tin xác nhận quyền sở hữu: Cả hai API đều hỗ trợ tham số overwrite trong quá trình xác nhận quyền sở hữu để tiếp nhận thông tin xác nhận quyền sở hữu từ một tài khoản khác nếu có thể xác minh quyền sở hữu.

Yêu cầu

Merchant API sử dụng các điểm cuối RESTful riêng biệt để quản lý các khía cạnh khác nhau của trang chủ.

Nội dung mô tả yêu cầu Content API for Shopping Merchant API
Xem thông tin chi tiết về trang chủ accounts.get (để đọc Account.website_url), accountstatuses.get (để đọc AccountStatus.website_claimed) GET /accounts/v1/accounts/{account}/homepage
Cập nhật URI trang chủ accounts.update (đặt Account.website_url) PATCH /accounts/v1/accounts/{account}/homepage
Xác nhận quyền sở hữu hoặc xác minh lại trang chủ POST /content/v2.1/{merchantId}/accounts/{accountId}/claimwebsite (đã thực hiện trên Account.website_url được đặt bằng accounts.update) POST /accounts/v1/accounts/{account}/homepage:claim
Huỷ xác nhận quyền sở hữu trang chủ accounts.update (đặt Account.website_url thành một chuỗi trống) POST /accounts/v1/accounts/{account}/homepage:unclaim

Giá trị nhận dạng

Việc xác định tài nguyên đã được đơn giản hoá trong Merchant API.

Nội dung mô tả về giá trị nhận dạng Content API for Shopping Merchant API
Giá trị nhận dạng tài khoản để truy cập vào tài nguyên merchantId (tài khoản nâng cao) và accountId (tài khoản phụ) trong đường dẫn account (một phần của trường name, chẳng hạn như accounts/{account_id}/homepage)
Giá trị nhận dạng tài nguyên trang chủ Không áp dụng (ngầm định cho tài nguyên Account) name: accounts/{account_id}/homepage (xác định tài nguyên phụ Homepage)

Phương thức

Phương thức accounts.claimwebsite từ Content API for Shopping (tập trung vào hành động xác nhận quyền sở hữu) hiện là một phần của tập hợp chức năng rộng hơn trong tài nguyên Homepage của Merchant API.

Phương thức Content API for Shopping Phương thức Merchant API Phạm vi cung cấp và lưu ý
accounts.claimwebsite accounts.homepage.claim Trực tiếp bắt đầu hoặc xác minh lại thông tin xác nhận quyền sở hữu trang web. Thực hiện trên uri đã đặt trước đó bằng homepage.update. Bao gồm tham số overwrite. Trả về tài nguyên Homepage với trạng thái uri và claimed hiện tại.
accounts.get (để đọc Account.website_url), accountstatuses.get (để đọc AccountStatus.website_claimed) accounts.homepage.getHomepage Phương thức riêng mới để truy xuất uri trang chủ hiện tại và trạng thái claimed của trang chủ trong một lệnh gọi.
accounts.update (để đặt Account.website_url) accounts.homepage.updateHomepage Phương thức riêng mới để đặt hoặc thay đổi uri trang chủ.
accounts.update (đặt Account.website_url thành chuỗi trống để huỷ xác nhận) accounts.homepage.unclaim Phương thức riêng mới để huỷ xác nhận quyền sở hữu trang chủ một cách rõ ràng.

Thay đổi chi tiết về trường

Cách cấu trúc và truy cập thông tin trang chủ đã thay đổi đáng kể, chuyển sang tài nguyên Homepage rõ ràng trong Merchant API.

Content API for Shopping Merchant API Mô tả
merchantId (tham số đường dẫn cho accounts.claimwebsite) name (tham số đường dẫn cho các phương thức Homepage, định dạng: accounts/{account}/homepage) Phần account của chuỗi name trong Merchant API tương ứng với accountId từ Content API for Shopping.
accountId (tham số đường dẫn cho accounts.claimwebsite) name (tham số đường dẫn cho các phương thức Homepage, định dạng: accounts/{account}/homepage) Giá trị nhận dạng cho tài khoản cụ thể có trang chủ đang được quản lý.
overwrite (boolean trong nội dung ContentAccountsClaimwebsiteRequest và AccountsCustomBatchRequestEntry) ClaimHomepageRequest.overwrite (boolean trong nội dung yêu cầu homepage.claim) Không bắt buộc. Nếu là true, hãy thử xác nhận quyền sở hữu trang web, có thể xoá thông tin xác nhận quyền sở hữu hiện có khỏi một tài khoản khác nếu tài khoản yêu cầu có thể xác minh quyền sở hữu.
Account.website_url (trường trong tài nguyên Account, được đặt bằng accounts.update, được đọc bằng accounts.get) Homepage.uri (trường trong tài nguyên Homepage) URI (URL) của trang chủ cửa hàng. Trong Merchant API, đây là một trường rõ ràng trong tài nguyên Homepage. Trường này được đặt bằng accounts.homepage.updateHomepage và được trả về bởi tất cả các phương thức Homepage.
AccountStatus.website_claimed (trường trong tài nguyên AccountStatus, được đọc bằng accountstatuses.get) Homepage.claimed (trường boolean output_only trong tài nguyên Homepage) Cho biết liệu uri có được xác nhận quyền sở hữu và xác minh hay không. Trạng thái này có sẵn trực tiếp trong tài nguyên Homepage do tất cả các phương thức Merchant API được liên kết trả về.
Không áp dụng UpdateHomepageRequest.update_mask accounts.homepage.updateHomepage tham số nội dung yêu cầu) Một mặt nạ trường không bắt buộc cho homepage.update để chỉ định những trường (ví dụ: uri) của tài nguyên Homepage đang được cập nhật.
Trước
Migrate user and access management
Tiếp
Migrate region management