ユーザーとアクセスの管理を移行する

Content API for Shopping では、Account リソースのフィールドを使用してユーザーとそのアクセス権を管理していました。Merchant API では、これが User という専用リソースと、対応するメソッド(create、delete、get、list、path)に置き換えられます。詳細については、アカウントへのアクセスを制御するをご覧ください。

主な違い

Content API for Shopping と比較して、Merchant API にはユーザー管理に関して次のようなメリットがあります。

  • 専用リソース: Merchant Center アカウントにアクセスできるユーザーとその権限を、よりきめ細かく直接的に制御できます。
  • RESTful リソース名: Merchant API では、User リソースを完全なリソース名(accounts/12345/users/example@example.com など)で識別します。
  • me エイリアス: リソース名のメールアドレスの代わりにエイリアス me を使用して、認証済みユーザー(例: accounts/12345/users/me)を参照できます。
  • アクセス権の統合: Merchant API は、Content API のブール値アクセス フィールド(admin、reportingManager など)を 1 つの繰り返し可能な access_rights フィールドに統合します。
  • ユーザーの招待と確認: Merchant API では、明示的なユーザー ステータス(PENDING または VERIFIED)が導入されています。新しいユーザーを作成すると、招待を承諾するまで PENDING ステータスになります。これにより、Content API for Shopping では利用できなかったユーザーのステータスを API で確認できます。## リクエストを追加する

Merchant API は、次のリクエスト URL を使用してユーザーを管理します。

  • 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 のリクエスト URL を比較したものです。

リクエストの説明 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}

識別子

次の表は、Content API for Shopping と Merchant API のリクエストで使用される識別子を比較したものです。

識別子の説明 Content API for Shopping Merchant API
アカウント ID accountId account(accounts/{account})
ユーザー識別子 AccountUser オブジェクト内の email_address email(accounts/{account}/users/{email})

メソッド

次の表は、Content API for Shopping と Merchant API のメソッドを比較したものです。

Content API for Shopping Merchant API 提供状況と注意事項
accounts.update users.create アカウントの新しいユーザーを作成します。
accounts.get users.get 1 人のユーザーを取得します。
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)を示します。