遷移使用者和存取權管理

在 Content API for Shopping 中,您可以使用 Account 資源中的欄位,管理使用者及其存取權。Merchant API 會將其替換為名為 User 的專屬資源和對應方法 (建立、刪除、取得、列出、路徑)。詳情請參閱「控管帳戶存取權」。

主要差異

與 Content API for Shopping 相比,Merchant API 在使用者管理方面具有下列優勢:

  • 專屬資源:可更精細、直接地控管 Merchant Center 帳戶的存取權限和使用者操作。
  • RESTful 資源名稱:在 Merchant API 中,請使用完整資源名稱 (例如 accounts/12345/users/example@example.com) 識別 User 資源。
  • me 別名:您可以使用別名 me 取代資源名稱中的電子郵件地址,來參照已驗證的使用者,例如 accounts/12345/users/me。
  • 整合存取權:Merchant API 會將 Content API 的布林值存取權欄位 (例如 admin、reportingManager) 整合為單一可重複的 access_rights 欄位。
  • 使用者邀請和驗證:Merchant API 導入明確的使用者狀態 (PENDING 或 VERIFIED)。建立新使用者時,他們會處於 PENDING 狀態,直到接受邀請為止。這項功能可讓您透過 API 查看使用者狀態,這是 Content API for Shopping 未提供的功能。新增 ## 要求

Merchant API 使用下列要求網址管理使用者:

  • GET /accounts/v1/accounts/{account}/users/{email}
  • GET /accounts/v1/accounts/{account}/users
  • POST /accounts/v1/accounts/{account}/users
  • PATCH /accounts/v1/accounts/{account}/users/{email}
  • DELETE /accounts/v1/accounts/{account}/users/{email}

下表比較 Content API for Shopping 和 Merchant API 的要求網址。

要求說明 Content API for Shopping Merchant API
取得帳戶的使用者 GET {api_version}/{merchantId}/accounts/{accountId} GET {api_version}/accounts/{account}/users
新增使用者 PATCH {api_version}/{merchantId}/accounts/{accountId} POST {api_version}/accounts/{account}/users
更新使用者 PATCH {api_version}/{merchantId}/accounts/{accountId} PATCH {api_version}/accounts/{account}/users/{email}
刪除使用者 PATCH {api_version}/{merchantId}/accounts/{accountId} DELETE {api_version}/accounts/{account}/users/{email}

ID

下表比較 Content API for Shopping 和 Merchant API 要求中使用的 ID。

ID 說明 Content API for Shopping Merchant API
帳戶 ID accountId accounts/{account}的account
使用者 ID AccountUser 物件中的 email_address accounts/{account}/users/{email}的email

方法

下表比較 Content API for Shopping 和 Merchant API 的方法。

Content API for Shopping Merchant API 適用範圍和注意事項
accounts.update users.create 為帳戶建立新使用者。
accounts.get users.get 擷取單一使用者。
accounts.get users.list 列出帳戶的所有使用者。
accounts.update users.patch 更新使用者的存取權。
accounts.update users.delete 從帳戶中刪除使用者。

詳細欄位變更

請按照下列方式更新欄位:

Content API for Shopping Merchant API 說明
users (重複 AccountUser) users (重複 User) User 資源現在是頂層資源,有自己的服務。
AccountUser.email_address CreateUserRequest.user_id和User.name的一部分 使用者的電子郵件地址現在是資源名稱的一部分。建立時,請在 user_id 欄位中指定。
AccountUser.admin access_rights: "ADMIN" Merchant API 會將布林值 admin 欄位替換為 access_rights 列舉中的 ADMIN 值。
AccountUser.order_manager、AccountUser.payments_manager、AccountUser.payments_analyst access_rights: "STANDARD" Merchant API 會將這些角色替換為STANDARD存取權。
AccountUser.reporting_manager access_rights: "PERFORMANCE_REPORTING" reporting_manager 角色現已改為PERFORMANCE_REPORTING存取權。
AccountUser.read_only access_rights: "READ_ONLY" read_only 角色現已改為READ_ONLY存取權。
無法使用 User.name 包含使用者的完整資源名稱,例如 accounts/{account}/users/{email}。
無法使用 User.state 指出使用者邀請的狀態,可以是 PENDING 或 VERIFIED。