Migrar o gerenciamento de usuários e acesso
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Na API Content for Shopping, você gerenciava os usuários e os direitos de acesso deles com um campo no recurso Account. A API Merchant substitui isso pelo recurso dedicado chamado User e pelos métodos correspondentes (create, delete, get, list, path). Para mais informações, consulte Controlar o acesso à sua conta.
principais diferenças
Em comparação com a API Content for Shopping, a API Merchant oferece as seguintes vantagens para o gerenciamento de usuários:
- Recurso dedicado: oferece uma maneira mais granular e direta de controlar quem pode acessar sua conta do Merchant Center e o que essas pessoas podem fazer.
- Nomes de recursos RESTful: na API Merchant, identifique os recursos
User por um nome de recurso completo, por exemplo, accounts/12345/users/example@example.com.
- Alias
me: você pode usar o alias me em vez de um endereço de e-mail no
nome do recurso para se referir ao usuário autenticado, por exemplo,
accounts/12345/users/me.
- Direitos de acesso consolidados: a API Merchant consolida campos de acesso booleano da API Content (por exemplo,
admin, reportingManager) em um único campo access_rights repetível.
- Convite e verificação de usuários: a API Merchant apresenta um estado explícito do usuário (
PENDING ou VERIFIED). Ao criar um usuário, ele fica no estado PENDING até aceitar o convite. Isso
fornece visibilidade da API ao status do usuário, que não estava disponível na
API Content for Shopping.
Adicionar
## Solicitações
A API Merchant usa os seguintes URLs de solicitação para gerenciar usuários:
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}
A tabela a seguir compara os URLs de solicitação entre a API Content for
Shopping e a API Merchant.
| Descrição da solicitação |
API Content for Shopping |
API Merchant |
| Receber usuários de uma conta |
GET {api_version}/{merchantId}/accounts/{accountId} |
GET {api_version}/accounts/{account}/users |
| Criar um usuário |
PATCH {api_version}/{merchantId}/accounts/{accountId} |
POST {api_version}/accounts/{account}/users |
| Atualizar um usuário |
PATCH {api_version}/{merchantId}/accounts/{accountId} |
PATCH {api_version}/accounts/{account}/users/{email} |
| Excluir um usuário |
PATCH {api_version}/{merchantId}/accounts/{accountId} |
DELETE {api_version}/accounts/{account}/users/{email} |
Identificadores
A tabela a seguir compara os identificadores usados em solicitações entre a API Content for Shopping e a API Merchant.
| Descrição do identificador |
API Content for Shopping |
API Merchant |
| Identificador da conta |
accountId |
account em accounts/{account} |
| Identificador do usuário |
email_address no objeto AccountUser |
email em accounts/{account}/users/{email} |
Métodos
A tabela a seguir compara os métodos entre a API Content for Shopping e a API Merchant.
| API Content for Shopping |
API Merchant |
Disponibilidade e observações |
accounts.update |
users.create |
Cria um novo usuário para uma conta. |
accounts.get |
users.get |
Recupera um único usuário. |
accounts.get |
users.list |
Lista todos os usuários de uma conta. |
accounts.update |
users.update |
Atualiza os direitos de acesso de um usuário. |
accounts.update |
users.delete |
Exclui um usuário de uma conta. |
Mudanças detalhadas nos campos
Atualize seu uso de campos da seguinte maneira:
| API Content for Shopping |
API Merchant |
Descrição |
users (AccountUser repetido) |
users (User repetido) |
O recurso User agora é um recurso de nível superior com serviço próprio. |
AccountUser.email_address |
CreateUserRequest.user_id e parte de User.name |
O endereço de e-mail do usuário agora faz parte do nome do recurso. Especifique no campo user_id durante a criação. |
AccountUser.admin |
access_rights: "ADMIN" |
A API Merchant substitui o campo booleano admin pelo valor ADMIN na enumeração access_rights. |
AccountUser.order_manager, AccountUser.payments_manager, AccountUser.payments_analyst |
access_rights: "STANDARD" |
A API Merchant substitui essas funções pelo direito de acesso STANDARD. |
AccountUser.reporting_manager |
access_rights: "PERFORMANCE_REPORTING" |
O papel reporting_manager agora é o direito de acesso PERFORMANCE_REPORTING. |
AccountUser.read_only |
access_rights: "READ_ONLY" |
O papel read_only agora é o direito de acesso READ_ONLY. |
| Indisponível |
User.name |
Contém o nome completo do recurso do usuário, por exemplo, accounts/{account}/users/{email}. |
| Indisponível |
User.state |
Indica o status do convite do usuário, PENDING ou VERIFIED. |
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-08-08 UTC.
[null,null,["Última atualização 2025-08-08 UTC."],[],[],null,["# Migrate user and access management\n\nIn Content API for Shopping, you managed users and their access rights with a\nfield in the `Account` resource. Merchant API replaces this with the dedicated\nresource named\n[`User`](/merchant/api/reference/rest/accounts_v1/accounts.users) and\ncorresponding methods (create, delete, get, list, path). For more information,\nsee [Control access to your\naccount](/merchant/api/guides/accounts/control-access).\n\nKey differences\n---------------\n\nCompared to Content API for Shopping, Merchant API offers the following\nadvantages for user management:\n\n- **Dedicated resource**: This provides a more granular and direct way to control who can access your Merchant Center account and what they can do.\n- **RESTful resource names** : In Merchant API, identify `User` resources by a full resource name, for example, `accounts/12345/users/example@example.com`.\n- **`me` alias** : You can use the alias `me` in place of an email address in the resource name to refer to the authenticated user, for example, `accounts/12345/users/me`.\n- **Consolidated access rights** : Merchant API consolidates boolean access fields from Content API (for example, `admin`, `reportingManager`) into a single, repeatable`access_rights` field.\n- **User invitation and verification** : Merchant API introduces an explicit user state (`PENDING` or `VERIFIED`). When you create a new user, they are in a `PENDING` state until they accept the invitation. This provides API visibility into the user's status, which was not available in the Content API for Shopping. Add ## Requests\n\nMerchant API uses the following request URLs to manage users:\n\n- `GET /accounts/v1/accounts/{account}/users/{email}`\n- `GET /accounts/v1/accounts/{account}/users`\n- `POST /accounts/v1/accounts/{account}/users`\n- `PATCH /accounts/v1/accounts/{account}/users/{email}`\n- `DELETE /accounts/v1/accounts/{account}/users/{email}`\n\nThe following table compares the request URLs between the Content API for\nShopping and Merchant API.\n\n| Request description | Content API for Shopping | Merchant API |\n|--------------------------|---------------------------------------------------------|---------------------------------------------------------|\n| Get users for an account | `GET {api_version}/{merchantId}/accounts/{accountId}` | `GET {api_version}/accounts/{account}/users` |\n| Create a user | `PATCH {api_version}/{merchantId}/accounts/{accountId}` | `POST {api_version}/accounts/{account}/users` |\n| Update a user | `PATCH {api_version}/{merchantId}/accounts/{accountId}` | `PATCH {api_version}/accounts/{account}/users/{email}` |\n| Delete a user | `PATCH {api_version}/{merchantId}/accounts/{accountId}` | `DELETE {api_version}/accounts/{account}/users/{email}` |\n\nIdentifiers\n-----------\n\nThe following table compares the identifiers used in requests between the\nContent API for Shopping and Merchant API.\n\n| Identifier description | Content API for Shopping | Merchant API |\n|------------------------|-------------------------------------------------|-----------------------------------------------|\n| Account identifier | `accountId` | `account` in `accounts/{account}` |\n| User identifier | `email_address` within the `AccountUser` object | `email` in `accounts/{account}/users/{email}` |\n\nMethods\n-------\n\nThe following table compares the methods between the Content API for Shopping\nand Merchant API.\n\n| Content API for Shopping | Merchant API | Availability \\& notes |\n|--------------------------|----------------------------------------------------------------------------------|------------------------------------|\n| `accounts.update` | [`users.create`](/merchant/api/reference/rest/accounts_v1/accounts.users/create) | Creates a new user for an account. |\n| `accounts.get` | [`users.get`](/merchant/api/reference/rest/accounts_v1/accounts.users/get) | Retrieves a single user. |\n| `accounts.get` | [`users.list`](/merchant/api/reference/rest/accounts_v1/accounts.users/list) | Lists all users for an account. |\n| `accounts.update` | [`users.update`](/merchant/api/reference/rest/accounts_v1/accounts.users/update) | Updates a user's access rights. |\n| `accounts.update` | [`users.delete`](/merchant/api/reference/rest/accounts_v1/accounts.users/delete) | Deletes a user from an account. |\n\nDetailed field changes\n----------------------\n\nUpdate your use of fields as follows:\n\n| Content API for Shopping | Merchant API | Description |\n|---------------------------------------------------------------------------------------------|-----------------------------------------------------|---------------------------------------------------------------------------------------------------------------|\n| `users` (repeated `AccountUser`) | `users` (repeated `User`) | The `User` resource is now a top-level resource with its own service. |\n| `AccountUser.email_address` | `CreateUserRequest.user_id` and part of `User.name` | The user's email address is now part of the resource name. Specify it in the `user_id` field during creation. |\n| `AccountUser.admin` | `access_rights: \"ADMIN\"` | Merchant API replaces the boolean `admin` field by the `ADMIN` value in the `access_rights` enum. |\n| `AccountUser.order_manager`, `AccountUser.payments_manager`, `AccountUser.payments_analyst` | `access_rights: \"STANDARD\"` | Merchant API replaces these roles to `STANDARD` access right. |\n| `AccountUser.reporting_manager` | `access_rights: \"PERFORMANCE_REPORTING\"` | The `reporting_manager` role is now the `PERFORMANCE_REPORTING` access right. |\n| `AccountUser.read_only` | `access_rights: \"READ_ONLY\"` | The `read_only` role is now the `READ_ONLY` access right. |\n| Not available | `User.name` | Contains the full resource name of the user, for example, `accounts/{account}/users/{email}`. |\n| Not available | `User.state` | Indicates the status of the user's invitation, either `PENDING` or `VERIFIED`. |"]]
