遷移首頁設定

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 (Account.website_url採取行動，使用 accounts.update 設定) 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 資源中僅供輸出的布林值欄位) 指出 uri 是否已聲明擁有權並完成驗證。所有相關聯的 Merchant API 方法傳回的 Homepage 資源中，都會直接提供這項狀態。
不適用 UpdateHomepageRequest.update_mask accounts.homepage.updateHomepage 要求主體參數) 選用欄位遮罩，用於指定要更新的欄位 (例如 homepage.updateuri) 的 Homepage 資源正在更新。
上一頁
Migrate user and access management
下一頁
Migrate region management