遷移首頁設定

Merchant API 導入了專屬的 Homepage 資源。這項資源提供管理首頁聲明的新方法，功能比傳統 Content API for Shopping 更強大。

如要使用網路商店功能，請先完成兩個步驟：驗證擁有權，然後為帳戶聲明網站擁有權。如要完成最後一個步驟，請使用 accounts.homepage.claim。

主要差異

與 Content API for Shopping 相比，Merchant API 對首頁進行了幾項變更：

  • 專屬資源：Merchant API 為所有首頁相關作業提供專屬的 Homepage 資源 (accounts.homepage)。(在 Content API for Shopping 中，您使用 accounts.claimwebsite 執行聲明動作，首頁網址 (website_url) 是 Account 資源的一部分，聲明狀態 (website_claimed) 是 AccountStatus 資源的一部分)。
  • 精細方法：Merchant API 提供特定方法，可：
  • 集中管理資訊：Merchant API Homepage 資源直接包含 uri (首頁網址) 和 claimed 狀態。對 Homepage 資源執行的所有方法都會傳回這項資源，立即提供目前狀態的意見回饋。在 Content API for Shopping 中，accounts.claimwebsite 不會傳回更新後的狀態，必須另外呼叫。
  • 明確聲明：在 Content API for Shopping 中，聲明通常是將 Account.website_url 更新為空字串。Merchant API 提供專屬的 homepage.unclaim 方法。
  • 覆寫聲明：如果可以驗證擁有權，這兩個 API 都支援在聲明程序中使用 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 (已對使用 accounts.update 設定的 Account.website_url 採取行動) POST /accounts/v1/accounts/{account}/homepage:claim
在首頁加入免責事項 accounts.update (將 Account.website_url 設為空白字串) POST /accounts/v1/accounts/{account}/homepage:unclaim

ID

Merchant API 已簡化資源識別程序。

ID 說明 Content API for Shopping Merchant API
資源存取權的帳戶 ID 路徑中的 merchantId (進階帳戶) 和 accountId (子帳戶) account (name 欄位的一部分，例如 accounts/{account_id}/homepage)
首頁資源 ID 不適用 (隱含於 Account 資源) name：accounts/{account_id}/homepage (識別 Homepage 子資源)

方法

Content API for Shopping 的 accounts.claimwebsite 方法原本著重於聲明擁有權，現在已成為 Merchant API Homepage 資源中更廣泛功能的一部分。

Content API for Shopping 方法 Merchant API 方法 適用範圍與附註
accounts.claimwebsite accounts.homepage.claim 直接啟動或重新驗證網站擁有權聲明。對先前使用 homepage.update 設定的 uri 執行動作。包含 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 新增專屬方法，可明確取消首頁擁有權。

詳細欄位變更

首頁資訊的結構和存取方式已大幅改變，改為使用 Merchant API 中的明確 Homepage 資源。

Content API for Shopping Merchant API 說明
merchantId (accounts.claimwebsite 的路徑參數) name (Homepage 方法的路徑參數，格式：accounts/{account}/homepage) Merchant API 中 name 字串的 account 部分，對應 Content API for Shopping 的 accountId。
accountId (accounts.claimwebsite 的路徑參數) name (Homepage 方法的路徑參數，格式：accounts/{account}/homepage) 首頁受管理的特定帳戶 ID。
overwrite (ContentAccountsClaimwebsiteRequest 主體和 AccountsCustomBatchRequestEntry 中的布林值) ClaimHomepageRequest.overwrite (homepage.claim 要求主體中的布林值) (選用步驟) 如果 true，則嘗試聲明網站擁有權。如果提出要求的帳戶可以驗證擁有權，則可能會移除其他帳戶現有的擁有權聲明。
Account.website_url (Account 資源中的欄位，使用 accounts.update 設定，使用 accounts.get 讀取) Homepage.uri (Homepage 資源中的欄位) 商店首頁的 URI (網址)。在 Merchant API 中，這是 Homepage 資源中的明確欄位。這項資訊是使用 accounts.homepage.updateHomepage 設定，並由所有 Homepage 方法傳回。
AccountStatus.website_claimed (AccountStatus 資源中的欄位，使用 accountstatuses.get 讀取) Homepage.claimed (Homepage 資源中的 output_only 布林值欄位) 指出uri是否已聲明擁有權並通過驗證。所有相關 Merchant API 方法傳回的 Homepage 資源，都會直接顯示這項狀態。
不適用 UpdateHomepageRequest.update_mask accounts.homepage.updateHomepage 要求主體參數) homepage.update 的選用欄位遮罩，用於指定要更新 Homepage 資源的哪些欄位 (例如 uri)。
上一頁
Migrate user and access management
下一頁
Migrate region management