Dans Content API for Shopping, vous gériez les utilisateurs et leurs droits d'accès à l'aide d'un champ de la ressource Account. L'API Merchant remplace cette ressource par la ressource dédiée nommée User et les méthodes correspondantes (create, delete, get, list, path). Pour en savoir plus, consultez Contrôler l'accès à votre compte.
Différences majeures
Par rapport à Content API for Shopping, Merchant API offre les avantages suivants pour la gestion des utilisateurs :
- Ressource dédiée : cette option permet de contrôler de manière plus précise et directe qui peut accéder à votre compte Merchant Center et ce qu'il peut faire.
- Noms de ressources RESTful : dans l'API Merchant, identifiez les ressources
Userpar un nom de ressource complet, par exempleaccounts/12345/users/example@example.com. - Alias
me: vous pouvez utiliser l'aliasmeà la place d'une adresse e-mail dans le nom de la ressource pour faire référence à l'utilisateur authentifié, par exempleaccounts/12345/users/me. - Droits d'accès consolidés : l'API Merchant consolide les champs d'accès booléens de Content API (par exemple,
admin,reportingManager) dans un seul champaccess_rightsrépétable. - Invitation et validation des utilisateurs : l'API Merchant introduit un état utilisateur explicite (
PENDINGouVERIFIED). Lorsque vous créez un utilisateur, il est à l'étatPENDINGjusqu'à ce qu'il accepte l'invitation. Cela permet à l'API de voir l'état de l'utilisateur, ce qui n'était pas possible dans Content API for Shopping. Ajouter des ## requêtes
L'API Merchant utilise les URL de requête suivantes pour gérer les utilisateurs :
GET /accounts/v1/accounts/{account}/users/{email}GET /accounts/v1/accounts/{account}/usersPOST /accounts/v1/accounts/{account}/usersPATCH /accounts/v1/accounts/{account}/users/{email}DELETE /accounts/v1/accounts/{account}/users/{email}
Le tableau suivant compare les URL de requête entre Content API for Shopping et l'API Merchant.
| Description de la requête | Content API for Shopping | API Merchant |
|---|---|---|
| Obtenir les utilisateurs d'un compte | GET {api_version}/{merchantId}/accounts/{accountId} |
GET {api_version}/accounts/{account}/users |
| Créer un compte utilisateur | PATCH {api_version}/{merchantId}/accounts/{accountId} |
POST {api_version}/accounts/{account}/users |
| Mettre à jour un utilisateur | PATCH {api_version}/{merchantId}/accounts/{accountId} |
PATCH {api_version}/accounts/{account}/users/{email} |
| Supprimer un compte utilisateur | PATCH {api_version}/{merchantId}/accounts/{accountId} |
DELETE {api_version}/accounts/{account}/users/{email} |
Identifiants
Le tableau suivant compare les identifiants utilisés dans les requêtes entre Content API for Shopping et l'API Merchant.
| Description de l'identifiant | Content API for Shopping | API Merchant |
|---|---|---|
| Identifiant de compte | accountId |
account à accounts/{account} |
| Identifiant utilisateur | email_address dans l'objet AccountUser |
email à accounts/{account}/users/{email} |
Méthodes
Le tableau suivant compare les méthodes de Content API for Shopping et de la Merchant API.
| Content API for Shopping | API Merchant | Disponibilité et remarques |
|---|---|---|
accounts.update |
users.create |
Crée un nouvel utilisateur pour un compte. |
accounts.get |
users.get |
Récupère un seul utilisateur. |
accounts.get |
users.list |
Répertorie tous les utilisateurs d'un compte. |
accounts.update |
users.patch |
Met à jour les droits d'accès d'un utilisateur. |
accounts.update |
users.delete |
Supprime un utilisateur d'un compte. |
Modifications détaillées des champs
Modifiez votre utilisation des champs comme suit :
| Content API for Shopping | API Merchant | Description |
|---|---|---|
users (répété AccountUser) |
users (répété User) |
La ressource User est désormais une ressource de premier niveau avec son propre service. |
AccountUser.email_address |
CreateUserRequest.user_id et une partie de User.name |
L'adresse e-mail de l'utilisateur fait désormais partie du nom de la ressource. Spécifiez-le dans le champ user_id lors de la création. |
AccountUser.admin |
access_rights: "ADMIN" |
L'API Merchant remplace le champ booléen admin par la valeur ADMIN dans l'énumération access_rights. |
AccountUser.order_manager, AccountUser.payments_manager, AccountUser.payments_analyst |
access_rights: "STANDARD" |
L'API Merchant remplace ces rôles par le droit d'accès STANDARD. |
AccountUser.reporting_manager |
access_rights: "PERFORMANCE_REPORTING" |
Le rôle reporting_manager est désormais le droit d'accès PERFORMANCE_REPORTING. |
AccountUser.read_only |
access_rights: "READ_ONLY" |
Le rôle read_only est désormais le droit d'accès READ_ONLY. |
| Non disponible | User.name |
Contient le nom complet de la ressource de l'utilisateur, par exemple accounts/{account}/users/{email}. |
| Non disponible | User.state |
Indique l'état de l'invitation de l'utilisateur, soit PENDING, soit VERIFIED. |