Eseguire la migrazione della gestione degli utenti e dell'accesso

Nella Content API for Shopping, gestivi gli utenti e i relativi diritti di accesso con un campo nella risorsa Account. L'API Merchant sostituisce questo campo con la risorsa dedicata denominata User e i metodi corrispondenti (create, delete, get, list, path). Per ulteriori informazioni, consulta Controllare l'accesso al tuo account.

Differenze principali

Rispetto alla Content API for Shopping, l'API Merchant offre i seguenti vantaggi per la gestione degli utenti:

  • Risorsa dedicata: fornisce un modo più granulare e diretto per controllare chi può accedere al tuo account Merchant Center e cosa può fare.
  • Nomi delle risorse RESTful: nell'API Merchant, identifica le risorse User con un nome completo della risorsa, ad esempio accounts/12345/users/example@example.com.
  • me alias: puoi utilizzare l'alias me al posto di un indirizzo email in nome della risorsa per fare riferimento all'utente autenticato, ad esempio accounts/12345/users/me.
  • Diritti di accesso consolidati: l'API Merchant consolida i campi di accesso booleani della Content API (ad esempio, admin, reportingManager) in un unico campo access_rights ripetibile.
  • Invito e verifica dell'utente: l'API Merchant introduce uno stato utente esplicito (PENDING o VERIFIED). Quando crei un nuovo utente, questo si trova nello stato PENDING finché non accetta l'invito. In questo modo, l'API può visualizzare lo stato dell'utente, cosa che non era possibile nella Content API for Shopping. Aggiungi ## Richieste

L'API Merchant utilizza i seguenti URL di richiesta per gestire gli utenti:

  • 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}

La seguente tabella mette a confronto gli URL di richiesta tra la Content API for Shopping e l'API Merchant.

Descrizione della richiesta Content API for Shopping API Merchant
Recupera gli utenti di un account GET {api_version}/{merchantId}/accounts/{accountId} GET {api_version}/accounts/{account}/users
Crea un utente PATCH {api_version}/{merchantId}/accounts/{accountId} POST {api_version}/accounts/{account}/users
Aggiorna un utente PATCH {api_version}/{merchantId}/accounts/{accountId} PATCH {api_version}/accounts/{account}/users/{email}
Elimina un utente PATCH {api_version}/{merchantId}/accounts/{accountId} DELETE {api_version}/accounts/{account}/users/{email}

Identificatori

La seguente tabella mette a confronto gli identificatori utilizzati nelle richieste tra la Content API for Shopping e l'API Merchant.

Descrizione dell'identificatore Content API for Shopping API Merchant
Identificatore di account accountId account in accounts/{account}
Identificatore utente email_address all'interno dell'oggetto AccountUser email in accounts/{account}/users/{email}

Metodi

La seguente tabella mette a confronto i metodi tra la Content API for Shopping e l'API Merchant.

Content API for Shopping API Merchant Disponibilità e note
accounts.update users.create Crea un nuovo utente per un account.
accounts.get users.get Recupera un singolo utente.
accounts.get users.list Elenca tutti gli utenti di un account.
accounts.update users.update Aggiorna i diritti di accesso di un utente.
accounts.update users.delete Elimina un utente da un account.

Modifiche dettagliate dei campi

Aggiorna l'utilizzo dei campi come segue:

Content API for Shopping API Merchant Descrizione
users (ripetuto AccountUser) users (ripetuto User) La risorsa User è ora una risorsa di primo livello con un proprio servizio.
AccountUser.email_address CreateUserRequest.user_id e parte di User.name L'indirizzo email dell'utente fa ora parte del nome della risorsa. Specificalo nel campo user_id durante la creazione.
AccountUser.admin access_rights: "ADMIN" L'API Merchant sostituisce il campo booleano admin con il valore ADMIN nell'enumerazione access_rights.
AccountUser.order_manager, AccountUser.payments_manager, AccountUser.payments_analyst access_rights: "STANDARD" L'API Merchant sostituisce questi ruoli con il diritto di accesso STANDARD.
AccountUser.reporting_manager access_rights: "PERFORMANCE_REPORTING" Il ruolo reporting_manager è ora il diritto di accesso PERFORMANCE_REPORTING.
AccountUser.read_only access_rights: "READ_ONLY" Il ruolo read_only è ora il diritto di accesso READ_ONLY.
Non disponibile User.name Contiene il nome completo della risorsa dell'utente, ad esempio accounts/{account}/users/{email}.
Non disponibile User.state Indica lo stato dell'invito dell'utente, PENDING o VERIFIED.
Indietro
Migrate accountstatuses to Aggregate Product Statuses
Avanti
Migrate homepage management