É possível usar a API Merchant Accounts para controlar quem tem acesso à sua conta de comerciante e qual nível de acesso eles têm.
Um
User
é alguém que tem acesso à sua conta de comerciante. É possível usar a API Merchant
Accounts para conferir, adicionar e remover usuários da sua conta.
Adicionar um usuário à conta
Para adicionar um usuário, chame o método
accounts.users.create
e especifique o nível de acesso
no campo access_rights do User.
O exemplo de solicitação a seguir mostra como adicionar um novo usuário com permissões STANDARD e
PERFORMANCE_REPORTING:
POST https://merchantapi.googleapis.com/accounts/v1beta/accounts/{ACCOUNT_ID}/users?userId={USER_EMAILID}
{
"accessRights": [
"STANDARD",
"PERFORMANCE_REPORTING"
],
"name": "{NAME}"
}
Substitua:
- {ACCOUNT_ID}: o identificador exclusivo da sua conta do Merchant Center.
- {USER_EMAILID}: o endereço de e-mail do usuário que você quer adicionar.
- {NAME}: o nome do recurso do usuário no formato
accounts/{ACCOUNT_ID}/user/{EMAIL_ADDRESS}.
Depois que a solicitação for bem-sucedida, a seguinte resposta será retornada:
{
"name": "accounts/{ACCOUNT_ID}/users/{USER_EMAILID}",
"state": "PENDING",
"accessRights": [
"STANDARD",
"PERFORMANCE_REPORTING"
]
}
Essa solicitação envia um convite para a Conta do Google associada ao novo usuário, que precisa ser aceito para que o usuário seja considerado um membro da sua conta.
O exemplo a seguir demonstra como usar o método
CreateUserRequest
para adicionar um usuário à sua conta.
Java
public static void createUser(Config config, String email) throws Exception {
// Obtains OAuth token based on the user's configuration.
GoogleCredentials credential = new Authenticator().authenticate();
// Creates service settings using the credentials retrieved above.
UserServiceSettings userServiceSettings =
UserServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(credential))
.build();
// Creates parent to identify where to insert the user.
String parent = getParent(config.getAccountId().toString());
// Calls the API and catches and prints any network failures/errors.
try (UserServiceClient userServiceClient = UserServiceClient.create(userServiceSettings)) {
CreateUserRequest request =
CreateUserRequest.newBuilder()
.setParent(parent)
// This field is the email address of the user.
.setUserId(email)
.setUser(
User.newBuilder()
.addAccessRights(AccessRight.ADMIN)
.addAccessRights(AccessRight.PERFORMANCE_REPORTING)
.build())
.build();
System.out.println("Sending Create User request");
User response = userServiceClient.createUser(request);
System.out.println("Inserted User Name below");
// The last part of the user name will be the email address of the user.
// Format: `accounts/{account}/user/{user}`
System.out.println(response.getName());
} catch (Exception e) {
System.out.println(e);
}
}
Conferir os usuários com acesso à sua conta
Para conferir todos os usuários com acesso à sua conta, use o método
accounts.users.list.
O exemplo a seguir demonstra como usar o método
ListUsersRequest
para listar todos os usuários de uma determinada conta.
Java
public static void listUsers(Config config) throws Exception {
// Obtains OAuth token based on the user's configuration.
GoogleCredentials credential = new Authenticator().authenticate();
// Creates service settings using the credentials retrieved above.
UserServiceSettings userServiceSettings =
UserServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(credential))
.build();
// Creates parent to identify the account from which to list all users.
String parent = getParent(config.getAccountId().toString());
// Calls the API and catches and prints any network failures/errors.
try (UserServiceClient userServiceClient = UserServiceClient.create(userServiceSettings)) {
// The parent has the format: accounts/{account}
ListUsersRequest request = ListUsersRequest.newBuilder().setParent(parent).build();
System.out.println("Sending list users request:");
ListUsersPagedResponse response = userServiceClient.listUsers(request);
int count = 0;
// Iterates over all rows in all pages and prints the user
// in each row.
// `response.iterateAll()` automatically uses the `nextPageToken` and recalls the
// request to fetch all pages of data.
for (User element : response.iterateAll()) {
System.out.println(element);
count++;
}
System.out.print("The following count of elements were returned: ");
System.out.println(count);
} catch (Exception e) {
System.out.println(e);
}
}
Extrair um único usuário para uma determinada conta
O exemplo a seguir demonstra como usar o método
GetUserRequest
para recuperar um usuário de uma determinada conta.
Java
public static void getUser(Config config, String email) throws Exception {
// Obtains OAuth token based on the user's configuration.
GoogleCredentials credential = new Authenticator().authenticate();
// Creates service settings using the credentials retrieved above.
UserServiceSettings userServiceSettings =
UserServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(credential))
.build();
// Creates user name to identify user.
String name =
UserName.newBuilder()
.setAccount(config.getAccountId().toString())
.setEmail(email)
.build()
.toString();
// Calls the API and catches and prints any network failures/errors.
try (UserServiceClient userServiceClient = UserServiceClient.create(userServiceSettings)) {
// The name has the format: accounts/{account}/users/{email}
GetUserRequest request = GetUserRequest.newBuilder().setName(name).build();
System.out.println("Sending Get user request:");
User response = userServiceClient.getUser(request);
System.out.println("Retrieved User below");
System.out.println(response);
} catch (Exception e) {
System.out.println(e);
}
}
Remover um usuário de uma conta específica
Para remover um usuário da conta, faça uma solicitação usando o
método
accounts.users.delete.
O exemplo a seguir demonstra como usar o método
DeleteUserRequest
para remover um usuário de uma determinada conta.
Java
public static void deleteUser(Config config, String email) throws Exception {
// Obtains OAuth token based on the user's configuration.
GoogleCredentials credential = new Authenticator().authenticate();
// Creates service settings using the credentials retrieved above.
UserServiceSettings userServiceSettings =
UserServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(credential))
.build();
// Creates user name to identify the user.
String name =
UserName.newBuilder()
.setAccount(config.getAccountId().toString())
.setEmail(email)
.build()
.toString();
// Calls the API and catches and prints any network failures/errors.
try (UserServiceClient userServiceClient = UserServiceClient.create(userServiceSettings)) {
DeleteUserRequest request = DeleteUserRequest.newBuilder().setName(name).build();
System.out.println("Sending Delete User request");
userServiceClient.deleteUser(request); // no response returned on success
System.out.println("Delete successful.");
} catch (Exception e) {
System.out.println(e);
}
}
Mudar o nível de acesso de um usuário
Para mudar o nível de acesso de um usuário, chame o método
accounts.users.patch
com o novo nível de acesso.
O exemplo a seguir demonstra como usar o método
UpdateUserSample
para atualizar um usuário e torná-lo administrador de uma determinada conta.
Java
public static void updateUser(Config config, String email, AccessRight accessRight)
throws Exception {
GoogleCredentials credential = new Authenticator().authenticate();
UserServiceSettings userServiceSettings =
UserServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(credential))
.build();
// Creates user name to identify user.
String name =
UserName.newBuilder()
.setAccount(config.getAccountId().toString())
.setEmail(email)
.build()
.toString();
// Create a user with the updated fields.
User user = User.newBuilder().setName(name).addAccessRights(accessRight).build();
FieldMask fieldMask = FieldMask.newBuilder().addPaths("access_rights").build();
try (UserServiceClient userServiceClient = UserServiceClient.create(userServiceSettings)) {
UpdateUserRequest request =
UpdateUserRequest.newBuilder().setUser(user).setUpdateMask(fieldMask).build();
System.out.println("Sending Update User request");
User response = userServiceClient.updateUser(request);
System.out.println("Updated User Name below");
System.out.println(response.getName());
} catch (Exception e) {
System.out.println(e);
}
}
Comparação entre o acesso de superadministrador, administrador e padrão
Os usuários com acesso de superadministrador ao Gerenciador de empresa não podem ser removidos do Merchant Center. Para mais informações sobre o acesso de superadministrador, consulte Gerenciar sua empresa como superadministrador.
Alguns métodos, como os que gravam dados da conta, exigem acesso de administrador. Para saber o nível de acesso necessário para cada método, consulte a documentação de referência.
Se nenhum nível de acesso for especificado, você poderá usar o método com acesso padrão.
A seguir
- Saiba como criar e gerenciar subcontas.
- Para entender como funcionam as relações entre contas de comerciantes, consulte Relações entre contas.