Миграция пользователей и управления доступом

В Content API for Shopping управление пользователями и их правами доступа осуществлялось с помощью поля в ресурсе Account . В Merchant API это поле заменяется выделенным ресурсом User и соответствующими методами (create, delete, get, list, path). Подробнее см. в разделе Управление доступом к вашей учетной записи .

Ключевые отличия

По сравнению с Content API for Shopping, Merchant API предлагает следующие преимущества для управления пользователями:

  • Выделенный ресурс : это обеспечивает более детальный и прямой способ контроля того, кто может получить доступ к вашей учетной записи Merchant Center и что они могут делать.
  • Имена ресурсов RESTful : в API продавца идентифицируйте User ресурсы по полному имени ресурса, например, accounts/12345/users/example@example.com .
  • me alias : Вы можете использовать псевдоним me вместо адреса электронной почты в имени ресурса для ссылки на аутентифицированного пользователя, например, accounts/12345/users/me .
  • Объединенные права доступа : API торговца объединяет логические поля доступа из API контента (например, admin , reportingManager ) в одно повторяемое поле access_rights .
  • Приглашение и верификация пользователя : API продавца вводит явное состояние пользователя ( PENDING или VERIFIED ). При создании нового пользователя он находится в состоянии PENDING до тех пор, пока не примет приглашение. Это обеспечивает API-просмотр статуса пользователя, который был недоступен в API контента для покупок. Добавить ## запросов

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}

В следующей таблице сравниваются URL-адреса запросов между Content API for Shopping и Merchant API.

Запросить описание API контента для покупок 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.

Описание идентификатора API контента для покупок API торговца
Идентификатор счета accountId account в accounts/{account}
Идентификатор пользователя email_address в объекте AccountUser email в accounts/{account}/users/{email}

Методы

В следующей таблице сравниваются методы Content API for Shopping и Merchant API.

API контента для покупок API торговца Доступность и примечания
accounts.update users.create Создает нового пользователя для учетной записи.
accounts.get users.get Извлекает одного пользователя.
accounts.get users.list Список всех пользователей учетной записи.
accounts.update users.update Обновляет права доступа пользователя.
accounts.update users.delete Удаляет пользователя из учетной записи.

Подробные изменения полей

Обновите использование полей следующим образом:

API контента для покупок API торговца Описание
users (повторяющийся AccountUser ) users (повторяющийся User ) Ресурс User теперь является ресурсом верхнего уровня со своим собственным сервисом.
AccountUser.email_address CreateUserRequest.user_id и часть User.name Адрес электронной почты пользователя теперь является частью имени ресурса. Укажите его в поле user_id при создании.
AccountUser.admin access_rights: "ADMIN" API торговца заменяет логическое поле admin значением ADMIN в перечислении access_rights .
AccountUser.order_manager , AccountUser.payments_manager , AccountUser.payments_analyst access_rights: "STANDARD" 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 .