遷移使用者和存取權管理

在 Content API for Shopping 中,您是透過 Account 資源中的欄位管理使用者和存取權。Merchant API 會以名為 User 的專屬資源和對應方法 (create、delete、get、list、path) 取代這項資源。詳情請參閱控管帳戶存取權

主要差異

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

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

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

  • GET /accounts/v1beta/accounts/{account}/users/{email}
  • GET /accounts/v1beta/accounts/{account}/users
  • POST /accounts/v1beta/accounts/{account}/users
  • PATCH /accounts/v1beta/accounts/{account}/users/{email}
  • DELETE /accounts/v1beta/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 email_addressAccountUser 物件 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.update 更新使用者的存取權。
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" 商家 API 會以 access_rights 列舉中的 ADMIN 值,取代布林值 admin 欄位。
AccountUser.order_managerAccountUser.payments_managerAccountUser.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 指出使用者的邀請狀態,可能是 PENDINGVERIFIED