Puedes usar la API de Merchant para crear cuentas de Merchant Center, que se pueden
vincular a una cuenta avanzada
con accountAggregation, accountManagement o comparisonShopping. El método
accounts.createAndConfigure
te permite crear una cuenta y, de manera opcional, configurarla con usuarios y
vincularla a otras cuentas a través de servicios.
En esta guía, se explica cómo usar la API de Merchant para crear cuentas
con servicios como accountManagement,
comparisonShopping o accountAggregation. Cuando usas
accounts.createAndConfigure, debes vincular la cuenta nueva a un proveedor especificando
al menos uno de los valores accountAggregation, accountManagement o
comparisonShopping en el campo service.
Puedes especificar accountAggregation y comparisonShopping en la misma
solicitud, pero accountManagement no se puede combinar con
accountAggregation ni con comparisonShopping.
Si especificas accountManagement, también debes agregar al menos un usuario a
la cuenta nueva con el campo user o users.
Requisitos previos
Antes de crear cuentas con la API de Merchant, asegúrate de cumplir con los siguientes requisitos según los servicios que uses:
- Acceso de administrador: Debes tener acceso de administrador a la cuenta del proveedor cuando vincules una cuenta nueva con
accountManagement,comparisonShoppingoaccountAggregation. - Cuenta avanzada: Si usas
accountAggregation, tu cuenta de proveedor debe ser una cuenta avanzada configurada para la agregación de cuentas. Si eres proveedor de servicios y necesitas configurar una cuenta avanzada, comunícate con el equipo de asistencia para obtener ayuda con la configuración.
Crear una cuenta (con la administración de cuentas o la comparación de productos)
Para crear una cuenta nueva, llama a
accounts.createAndConfigure.
Este es el enfoque recomendado para los socios que ayudan a los comercios a administrar sus cuentas, ya que permite que los comercios conserven el control y la propiedad totales de sus cuentas, a la vez que otorgan permisos específicos a los socios.
En el cuerpo de la solicitud, haz lo siguiente:
- Proporciona los detalles de la cuenta que deseas crear en el campo
account. - En el campo
accountName, no uses signos de puntuación, mayúsculas, guiones bajos, texto escrito todo en mayúsculas, emojis ni símbolos no alfanuméricos, como/o_, innecesarios o repetidos. Evita los sufijos comerciales (como "Inc." o "GmbH"), el texto promocional, la información personal o el lenguaje inapropiado. Usa un nombre corto, claro y profesional. Para obtener más información, consulta cómo agregar el nombre de la empresa. - Si usas
accountManagement, especifica al menos un usuario en el campouserque tendrá acceso a la cuenta. - En el campo
service, especifica los servicios que deseas proporcionar a esta cuenta, por ejemplo,accountManagement, y establece elprovideren el nombre del recurso de tu cuenta (por ejemplo,providers/{YOUR_ACCOUNT_ID}). Para obtener una lista de los servicios disponibles, comoproductsManagementocampaignsManagement, consulta Administra las relaciones de la cuenta.
A continuación, se muestra un ejemplo de solicitud para crear una cuenta llamada "merchantStore"
y vincularla a la cuenta {YOUR_ACCOUNT_ID} para
la administración de cuentas y productos:
POST https://merchantapi.googleapis.com/accounts/v1/accounts:createAndConfigure
{
"account": {
"accountName": "merchantStore",
"adultContent": false,
"timeZone": {
"id": "America/New_York"
},
"languageCode": "en-US"
},
"user": [
{
"userId": "test@example.com",
"user": {
"accessRights": ["ADMIN"]
}
}
],
"service": [
{
"accountManagement": {},
"provider": "providers/{YOUR_ACCOUNT_ID}"
},
{
"productsManagement": {},
"provider": "providers/{YOUR_ACCOUNT_ID}"
}
]
}
Una llamada exitosa crea la cuenta nueva y la vincula a tu cuenta para los
servicios especificados. Si especificas los servicios accountManagement, accountAggregation
o comparisonShopping durante la creación, se aprueban automáticamente
y el estado del vínculo es ESTABLISHED. Otros vínculos de servicio pueden estar en
estado PENDING hasta que los acepte la cuenta creada. El cuerpo de la respuesta
contiene el recurso Account
recién creado.
En el siguiente ejemplo, se muestra cómo usar
accounts.createAndConfigure
para crear y configurar una cuenta:
Java
import com.google.api.gax.core.FixedCredentialsProvider;
import com.google.auth.oauth2.GoogleCredentials;
import com.google.shopping.merchant.accounts.v1.AccessRight;
import com.google.shopping.merchant.accounts.v1.Account;
import com.google.shopping.merchant.accounts.v1.AccountManagement;
import com.google.shopping.merchant.accounts.v1.AccountsServiceClient;
import com.google.shopping.merchant.accounts.v1.AccountsServiceSettings;
import com.google.shopping.merchant.accounts.v1.CreateAndConfigureAccountRequest;
import com.google.shopping.merchant.accounts.v1.CreateAndConfigureAccountRequest.AddAccountService;
import com.google.shopping.merchant.accounts.v1.CreateAndConfigureAccountRequest.AddUser;
import com.google.shopping.merchant.accounts.v1.ProductsManagement;
import com.google.shopping.merchant.accounts.v1.User;
import com.google.type.TimeZone;
import java.util.List;
import shopping.merchant.samples.utils.Authenticator;
/**
* This class demonstrates how to create a new Merchant Center account and configure it with various
* services.
*/
public class CreateAndConfigureAccountSample {
public static void createAndConfigureAccount(
long providerId, String newAccountName, String userEmail) throws Exception {
// Obtains OAuth token based on the user's configuration.
GoogleCredentials credential = new Authenticator().authenticate();
// Creates service settings using the credentials retrieved above.
AccountsServiceSettings accountsServiceSettings =
AccountsServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(credential))
.build();
// Calls the API and catches and prints any network failures/errors.
try (AccountsServiceClient accountsServiceClient =
AccountsServiceClient.create(accountsServiceSettings)) {
// The account to be created.
Account account =
Account.newBuilder()
.setAccountName(newAccountName)
.setTimeZone(TimeZone.newBuilder().setId("Europe/Zurich").build())
.setLanguageCode("en-US")
.build();
// The services to be added to the new account.
// This sample shows how to configure a new account with account management and
// product management.
// For more information about the different services, see:
// https://developers.google.com/merchant/api/guides/accounts/services
AddAccountService accountManagementService =
AddAccountService.newBuilder()
.setProvider("accounts/" + providerId)
.setExternalAccountId("external_account_id")
.setAccountManagement(AccountManagement.newBuilder().build())
.build();
// This part is optional. You can also omit this and link the account later.
AddAccountService productsManagementService =
AddAccountService.newBuilder()
.setProvider("accounts/" + providerId)
.setExternalAccountId("external_account_id")
.setProductsManagement(ProductsManagement.newBuilder().build())
.build();
// For sub-account creation, use the AccountAggregation service. For an example on how to do
// this, see the `CreateSubAccount` sample.
// The user to be added to the new account.
// This part is optional.
AddUser user =
AddUser.newBuilder()
.setUserId(userEmail)
.setUser(User.newBuilder().addAccessRights(AccessRight.STANDARD).build())
.build();
CreateAndConfigureAccountRequest request =
CreateAndConfigureAccountRequest.newBuilder()
.setAccount(account)
.addAllService(List.of(accountManagementService, productsManagementService))
.addUser(user)
.build();
System.out.println("Sending Create and Configure Account request:");
Account response = accountsServiceClient.createAndConfigureAccount(request);
System.out.println("Created Account below");
System.out.println(response);
} catch (Exception e) {
System.out.println(e);
}
}
public static void main(String[] args) throws Exception {
// This is the provider ID of the e-commerce platform.
long providerId = 123L;
// This is the name of the new account to be created.
String newAccountName = "MyNewShop";
// This is the email of a user to be added to the new account.
String userEmail = "test-user@gmail.com";
createAndConfigureAccount(providerId, newAccountName, userEmail);
}
}
Después de crear una cuenta de este tipo, debes incorporarla completando pasos como aceptar las Condiciones del Servicio , configurar la información de la empresa y verificar el sitio web.
Suprime la verificación por correo electrónico durante la creación de la cuenta
Cuando creas una cuenta con accounts.createAndConfigure, puedes suprimir de forma opcional los mensajes de verificación para los usuarios nuevos que se agreguen con el campo user. Para ello, establece verificationMailSettings.verificationMailMode en SUPPRESS_VERIFICATION_MAIL en la solicitud de ese usuario. Esto es útil si
pretendes verificar a los usuarios en nombre del comercio inmediatamente después de la creación
con el método
users.verifySelf. De forma predeterminada, verificationMailMode es SEND_VERIFICATION_MAIL, y se envían mensajes de verificación a los usuarios nuevos que se agregan durante la creación de la cuenta.
POST https://merchantapi.googleapis.com/accounts/v1/accounts:createAndConfigure
{
"account": {
"accountName": "merchantStore",
"adultContent": false,
"timeZone": {
"id": "America/New_York"
},
"languageCode": "en-US"
},
"user": [
{
"userId": "test@example.com",
"user": {
"accessRights": ["ADMIN"]
},
"verificationMailSettings": {
"verificationMailMode": "SUPPRESS_VERIFICATION_MAIL"
}
}
],
"service": [
{
"accountManagement": {},
"provider": "providers/{YOUR_ACCOUNT_ID}"
}
]
}
Si configuras verificationMailMode como SUPPRESS_VERIFICATION_MAIL, debes
llamar a users.verifySelf para cada usuario que se agregue durante la creación para completar
la verificación. Esta llamada debe autenticarse como el usuario que se está verificando
(el usuario especificado en userId), por ejemplo, con un token de OAuth del
usuario.
Especifica un alias durante la creación de la cuenta
Puedes especificar un alias para una cuenta en el contexto de un proveedor en
CreateAndConfigureAccountRequest con el campo setAlias. El alias se puede
usar para identificar la cuenta en tu sistema. Si eres un proveedor de servicios, puedes
usar el alias para recuperar la cuenta con
GET /accounts/v1/accounts/{provider}~{alias}. El alias debe ser único para un
proveedor determinado, y debes especificar un servicio con el mismo proveedor en el
campo service de la solicitud. Para obtener más información sobre los requisitos de los alias,
consulta Administra las relaciones de cuentas.
POST https://merchantapi.googleapis.com/accounts/v1/accounts:createAndConfigure
{
"account": {
"accountName": "merchantStore",
"adultContent": false,
"timeZone": {
"id": "America/New_York"
},
"languageCode": "en-US"
},
"service": [
{
"accountManagement": {},
"provider": "providers/{YOUR_ACCOUNT_ID}"
}
],
"setAlias": [
{
"provider": "providers/{YOUR_ACCOUNT_ID}",
"accountIdAlias": "my-merchant-alias"
}
]
}
Flujo de integración recomendado
Si eres un socio que crea una cuenta en nombre de un comercio, te recomendamos que sigas este flujo:
- Crear cuenta: Llama a
accounts.createAndConfigurecon tus credenciales de socio para crear una cuenta nueva.- Configura
servicepara incluiraccountManagementque se vincule a tu ID de proveedor. - Agrega al comercio como usuario con el campo
usery estableceverificationMailSettings.verificationMailModeenSUPPRESS_VERIFICATION_MAIL.
- Configura
- Verifica al usuario: Con las credenciales del comercio (por ejemplo, con un token de OAuth), llama a
users.verifySelfpara cambiar el estado del usuario dePENDINGaVERIFIED. - Establece el país de la empresa: Con las credenciales de comerciante, establece el país de la empresa actualizando
address.regionCodeconaccounts.updateBusinessInfo. Este paso es obligatorio antes de aceptar las Condiciones del Servicio . - Acepta las Condiciones del Servicio : Con las credenciales del comercio, acepta las Condiciones del Servicio .
Este flujo permite que un comercio se incorpore sin problemas en tu plataforma sin recibir correos electrónicos de invitación de Google.
Crea una cuenta de cliente (con la agregación de cuentas)
Las cuentas de cliente son cuentas de Merchant Center distintas vinculadas a tu
cuenta avanzada con el servicio accountAggregation, lo que permite
una administración centralizada y, al mismo tiempo, mantener parámetros de configuración, sitios web y feeds de datos
independientes. Puedes usar la API secundaria de cuentas de comerciante para crear cuentas de cliente
nuevas.
Para crear cuentas de cliente, primero debes tener una configuración de la cuenta avanzada. Debes ser administrador de la cuenta para convertir tu cuenta de Merchant Center en una cuenta avanzada, y tu cuenta no debe tener ningún problema pendiente.
Para crear una cuenta de cliente nueva, llama a accounts.createAndConfigure.
En el cuerpo de la solicitud, haz lo siguiente:
- Proporciona los detalles de la cuenta que deseas crear en el campo
account. - En el campo
accountName, no uses signos de puntuación, mayúsculas, guiones bajos ni símbolos no alfanuméricos (como "/" o "_") innecesarios o repetidos. Evita los sufijos comerciales (como "Inc." o "GmbH"), el texto promocional, la información personal o el lenguaje inapropiado. Usa un nombre corto, claro y profesional. Para obtener más información, consulta cómo agregar el nombre de la empresa. - De manera opcional, especifica los usuarios autorizados nuevos en el campo
user. El acceso de los usuarios a la cuenta también se hereda de la cuenta avanzada superior. - En el campo
service, especificaaccountAggregationy estableceprovideren el nombre del recurso de tu cuenta avanzada (por ejemplo,providers/{ADVANCED_ACCOUNT_ID}). Esto establece tu cuenta avanzada como el agregador de la cuenta nueva.
A continuación, se muestra un ejemplo de solicitud para crear una cuenta de cliente llamada "merchantStore"
vinculada a la cuenta avanzada
{ADVANCED_ACCOUNT_ID}:
POST https://merchantapi.googleapis.com/accounts/v1/accounts:createAndConfigure
{
"account": {
"accountName": "merchantStore",
"adultContent": false,
"timeZone": {
"id": "America/New_York"
},
"languageCode": "en-US"
},
"service": [
{
"accountAggregation": {},
"provider": "providers/{ADVANCED_ACCOUNT_ID}"
}
]
}
Si la llamada se realiza correctamente, se crea la nueva cuenta de cliente y se vincula a la cuenta avanzada
que especificaste. El cuerpo de la respuesta contendrá el recurso
Account recién creado.
En los siguientes ejemplos, se muestra cómo usar
accounts.createAndConfigure para crear
una cuenta de cliente nueva.
Java
import com.google.api.gax.core.FixedCredentialsProvider;
import com.google.auth.oauth2.GoogleCredentials;
import com.google.shopping.merchant.accounts.v1.Account;
import com.google.shopping.merchant.accounts.v1.AccountAggregation;
import com.google.shopping.merchant.accounts.v1.AccountsServiceClient;
import com.google.shopping.merchant.accounts.v1.AccountsServiceSettings;
import com.google.shopping.merchant.accounts.v1.CreateAndConfigureAccountRequest;
import com.google.shopping.merchant.accounts.v1.CreateAndConfigureAccountRequest.AddAccountService;
import com.google.type.TimeZone;
import shopping.merchant.samples.utils.Authenticator;
import shopping.merchant.samples.utils.Config;
/** This class demonstrates how to create a sub-account under an advanced account. */
public class CreateSubAccountSample {
private static String getParent(String accountId) {
return String.format("accounts/%s", accountId);
}
public static Account createSubAccount(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.
AccountsServiceSettings accountsServiceSettings =
AccountsServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(credential))
.build();
// Creates parent/provider to identify the advanced account into which to insert the subaccount.
String parent = getParent(config.getAccountId().toString());
// Calls the API and catches and prints any network failures/errors.
try (AccountsServiceClient accountsServiceClient =
AccountsServiceClient.create(accountsServiceSettings)) {
CreateAndConfigureAccountRequest request =
CreateAndConfigureAccountRequest.newBuilder()
.setAccount(
Account.newBuilder()
.setAccountName("Demo Business")
.setAdultContent(false)
.setTimeZone(TimeZone.newBuilder().setId("America/New_York").build())
.setLanguageCode("en-US")
.build())
.addService(
AddAccountService.newBuilder()
.setProvider(parent)
.setAccountAggregation(AccountAggregation.getDefaultInstance())
.build())
.build();
System.out.println("Sending Create SubAccount request");
Account response = accountsServiceClient.createAndConfigureAccount(request);
System.out.println("Inserted Account Name below");
// Format: `accounts/{account}`
System.out.println(response.getName());
return response;
}
}
public static void main(String[] args) throws Exception {
Config config = Config.load();
createSubAccount(config);
}
}
PHP
use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Accounts\V1\Account;
use Google\Shopping\Merchant\Accounts\V1\AccountAggregation;
use Google\Shopping\Merchant\Accounts\V1\Client\AccountsServiceClient;
use Google\Shopping\Merchant\Accounts\V1\CreateAndConfigureAccountRequest;
use Google\Shopping\Merchant\Accounts\V1\CreateAndConfigureAccountRequest\AddAccountService;
use Google\Type\TimeZone;
/**
* This class demonstrates how to create a sub-account under an MCA account.
*/
class CreateSubAccount
{
private static function getParent(string $accountId): string
{
return sprintf("accounts/%s", $accountId);
}
public static function createSubAccount(array $config): void
{
// Gets the OAuth credentials to make the request.
$credentials = Authentication::useServiceAccountOrTokenFile();
// Creates options config containing credentials for the client to use.
$options = ['credentials' => $credentials];
// Creates a client.
$accountsServiceClient = new AccountsServiceClient($options);
// Creates parent/provider to identify the MCA account into which to insert the subaccount.
$parent = self::getParent($config['accountId']);
// Calls the API and catches and prints any network failures/errors.
try {
$request = new CreateAndConfigureAccountRequest([
'account' => (new Account([
'account_name' => 'Demo Business',
'adult_content' => false,
'time_zone' => (new TimeZone(['id' => 'America/New_York'])),
'language_code' => 'en-US',
])),
'service' => [
(new AddAccountService([
'provider' => $parent,
'account_aggregation' => new AccountAggregation,
])),
],
]);
print "Sending Create SubAccount request\n";
$response = $accountsServiceClient->createAndConfigureAccount($request);
print "Inserted Account Name below\n";
// Format: `accounts/{account}
print $response->getName() . PHP_EOL;
} catch (ApiException $e) {
print $e->getMessage();
}
}
public function callSample(): void
{
$config = Config::generateConfig();
self::createSubAccount($config);
}
}
$sample = new CreateSubAccount();
$sample->callSample();
Python
from examples.authentication import configuration
from examples.authentication import generate_user_credentials
from google.shopping.merchant_accounts_v1 import Account
from google.shopping.merchant_accounts_v1 import AccountAggregation
from google.shopping.merchant_accounts_v1 import AccountsServiceClient
from google.shopping.merchant_accounts_v1 import CreateAndConfigureAccountRequest
def get_parent(account_id):
return f"accounts/{account_id}"
def create_sub_account(account_id: str) -> Account:
"""Creates a sub-account under an advanced account."""
# Get OAuth credentials.
credentials = generate_user_credentials.main()
# Create a client.
client = AccountsServiceClient(credentials=credentials)
# Get the parent advanced account ID.
parent = get_parent(account_id)
# Create the request.
request = CreateAndConfigureAccountRequest(
account=Account(
account_name="Demo Business",
adult_content=False,
time_zone={"id": "America/New_York"},
language_code="en-US",
),
service=[
CreateAndConfigureAccountRequest.AddAccountService(
provider=parent,
account_aggregation=AccountAggregation(),
)
],
)
# Make the request and print the response.
try:
print("Sending Create SubAccount request")
response = client.create_and_configure_account(request=request)
print("Inserted Account Name below")
print(response.name)
return response
except RuntimeError as e:
print(e)
raise
if __name__ == "__main__":
_account_id = configuration.Configuration().read_merchant_info()
create_sub_account(_account_id)
cURL
curl -X POST \
"https://merchantapi.googleapis.com/accounts/v1/accounts:createAndConfigure" \
-H "Authorization: Bearer {YOUR_ACCESS_TOKEN}" \
-H "Content-Type: application/json" \
-d '{
"account": {
"accountName": "Demo Business",
"adultContent": false,
"timeZone": {
"id": "America/New_York"
},
"languageCode": "en-US"
},
"service": [
{
"accountAggregation": {},
"provider": "providers/{ADVANCED_ACCOUNT_ID}"
}
]
}'
Recupera cuentas de cliente
Para enumerar todas las cuentas de cliente de una cuenta avanzada determinada, usa el método
accounts.listSubaccounts. Proporciona el ID de tu cuenta avanzada en el campo provider de la URL de la solicitud.
A continuación, se muestra una solicitud de ejemplo:
GET https://merchantapi.googleapis.com/accounts/v1/accounts/{ADVANCED_ACCOUNT_ID}:listSubaccounts
A continuación, se muestra una respuesta de ejemplo de una llamada correcta:
{
"accounts": [
{
"name": "accounts/<var class=\"readonly\">{SUB_ACCOUNT_ID_1}</var>",
"accountId": "<var class=\"readonly\">{SUB_ACCOUNT_ID_1}</var>",
"accountName": "<var class=\"readonly\">{SUB_ACCOUNT_NAME_1}</var>",
"timeZone": {
"id": "America/Los_Angeles"
},
"languageCode": "en-US"
},
{
"name": "accounts/<var class=\"readonly\">{SUB_ACCOUNT_ID_2}</var>",
"accountId": "<var class=\"readonly\">{SUB_ACCOUNT_ID_2}</var>",
"accountName": "<var class=\"readonly\">{SUB_ACCOUNT_NAME_2}</var>",
"timeZone": {
"id": "America/Los_Angeles"
},
"languageCode": "en-US"
}
]
}
En los siguientes ejemplos, se muestra cómo enumerar todas las cuentas de cliente de tu cuenta avanzada.
Java
import com.google.api.gax.core.FixedCredentialsProvider;
import com.google.auth.oauth2.GoogleCredentials;
import com.google.shopping.merchant.accounts.v1.Account;
import com.google.shopping.merchant.accounts.v1.AccountsServiceClient;
import com.google.shopping.merchant.accounts.v1.AccountsServiceClient.ListSubAccountsPagedResponse;
import com.google.shopping.merchant.accounts.v1.AccountsServiceSettings;
import com.google.shopping.merchant.accounts.v1.ListSubAccountsRequest;
import shopping.merchant.samples.utils.Authenticator;
import shopping.merchant.samples.utils.Config;
/** This class demonstrates how to list all the subaccounts of an advanced account. */
public class ListSubAccountsSample {
private static String getParent(String accountId) {
return String.format("accounts/%s", accountId);
}
public static ListSubAccountsPagedResponse listSubAccounts(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.
AccountsServiceSettings accountsServiceSettings =
AccountsServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(credential))
.build();
// Creates parent/provider to identify the advanced account from which to list all sub-accounts.
String parent = getParent(config.getAccountId().toString());
// Calls the API and catches and prints any network failures/errors.
try (AccountsServiceClient accountsServiceClient =
AccountsServiceClient.create(accountsServiceSettings)) {
// The parent has the format: accounts/{account}
ListSubAccountsRequest request =
ListSubAccountsRequest.newBuilder().setProvider(parent).build();
System.out.println("Sending list subaccounts request:");
ListSubAccountsPagedResponse response = accountsServiceClient.listSubAccounts(request);
int count = 0;
// Iterates over all rows in all pages and prints the datasource in each row.
// Automatically uses the `nextPageToken` if returned to fetch all pages of data.
for (Account account : response.iterateAll()) {
System.out.println(account);
count++;
}
System.out.print("The following count of accounts were returned: ");
System.out.println(count);
return response;
}
}
public static void main(String[] args) throws Exception {
Config config = Config.load();
listSubAccounts(config);
}
}
PHP
use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Accounts\V1\Client\AccountsServiceClient;
use Google\Shopping\Merchant\Accounts\V1\ListSubAccountsRequest;
/**
* This class demonstrates how to list all the subaccounts of an advanced account.
*/
class ListSubAccounts
{
private static function getParent(string $accountId): string
{
return sprintf("accounts/%s", $accountId);
}
public static function listSubAccounts(array $config): void
{
// Gets the OAuth credentials to make the request.
$credentials = Authentication::useServiceAccountOrTokenFile();
// Creates options config containing credentials for the client to use.
$options = ['credentials' => $credentials];
// Creates a client.
$accountsServiceClient = new AccountsServiceClient($options);
// Creates parent/provider to identify the advanced account from which
//to list all accounts.
$parent = self::getParent($config['accountId']);
// Calls the API and catches and prints any network failures/errors.
try {
// The parent has the format: accounts/{account}
$request = new ListSubAccountsRequest(['provider' => $parent]);
print "Sending list subaccounts request:\n";
$response = $accountsServiceClient->listSubAccounts($request);
$count = 0;
// Iterates over all rows in all pages and prints the datasource in each row.
// Automatically uses the `nextPageToken` if returned to fetch all pages of data.
foreach ($response->iterateAllElements() as $account) {
print_r($account);
$count++;
}
print "The following count of accounts were returned: ";
print $count . PHP_EOL;
} catch (ApiException $e) {
print "An error has occured: \n";
print $e->getMessage();
}
}
public function callSample(): void
{
$config = Config::generateConfig();
self::listSubAccounts($config);
}
}
$sample = new ListSubAccounts();
$sample->callSample();
Python
from examples.authentication import configuration
from examples.authentication import generate_user_credentials
from google.shopping.merchant_accounts_v1 import AccountsServiceClient
from google.shopping.merchant_accounts_v1 import ListSubAccountsRequest
def get_parent(account_id):
return f"accounts/{account_id}"
def list_sub_accounts(account_id: str):
"""Lists all the subaccounts of an advanced account."""
# Get OAuth credentials.
credentials = generate_user_credentials.main()
# Create a client.
client = AccountsServiceClient(credentials=credentials)
# Get the parent advanced account ID.
parent = get_parent(account_id)
# Create the request.
request = ListSubAccountsRequest(provider=parent)
# Make the request and print the response.
try:
print("Sending list subaccounts request:")
response = client.list_sub_accounts(request=request)
count = 0
for account in response:
print(account)
count += 1
print(f"The following count of accounts were returned: {count}")
return response
except RuntimeError as e:
print("An error has occured: ")
print(e)
raise
if __name__ == "__main__":
_account_id = configuration.Configuration().read_merchant_info()
list_sub_accounts(_account_id)
cURL
curl -X GET \
"https://merchantapi.googleapis.com/accounts/v1/accounts/{ADVANCED_ACCOUNT_ID}:listSubaccounts" \
-H "Authorization: Bearer {YOUR_ACCESS_TOKEN}" \
Cómo borrar una cuenta de cliente
Si ya no necesitas administrar una cuenta de cliente, puedes borrarla con el método accounts.delete.
Para ejecutar este método, se requiere acceso de administrador a la cuenta que se borrará.
A continuación, se muestra una solicitud de ejemplo:
DELETE https://merchantapi.googleapis.com/accounts/v1/accounts/{SUB_ACCOUNT_ID}
Si se ejecuta correctamente, el cuerpo de la respuesta es un objeto JSON vacío, lo que indica que se borró la cuenta.
En los siguientes ejemplos, se muestra cómo borrar una cuenta de cliente.
Java
import com.google.api.gax.core.FixedCredentialsProvider;
import com.google.auth.oauth2.GoogleCredentials;
import com.google.shopping.merchant.accounts.v1.AccountName;
import com.google.shopping.merchant.accounts.v1.AccountsServiceClient;
import com.google.shopping.merchant.accounts.v1.AccountsServiceSettings;
import com.google.shopping.merchant.accounts.v1.DeleteAccountRequest;
import shopping.merchant.samples.utils.Authenticator;
import shopping.merchant.samples.utils.Config;
/** This class demonstrates how to delete a given Merchant Center account. */
public class DeleteAccountSample {
// This method can delete a standalone, advanced account or sub-account. If you delete an advanced
// account,
// all sub-accounts will also be deleted.
// Admin user access is required to execute this method.
public static void deleteAccount(Config config, String accountId) throws Exception {
// Obtains OAuth token based on the user's configuration.
GoogleCredentials credential = new Authenticator().authenticate();
// Creates service settings using the credentials retrieved above.
AccountsServiceSettings accountsServiceSettings =
AccountsServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(credential))
.build();
// Creates account name to identify the account.
String name =
AccountName.newBuilder()
.setAccount(accountId)
.build()
.toString();
// Calls the API.
try (AccountsServiceClient accountsServiceClient =
AccountsServiceClient.create(accountsServiceSettings)) {
DeleteAccountRequest request =
DeleteAccountRequest.newBuilder()
.setName(name)
// Optional. If set to true, the account will be deleted even if it has offers or
// provides services to other accounts. Defaults to 'false'.
.setForce(true)
.build();
System.out.println("Sending Delete Account request");
accountsServiceClient.deleteAccount(request); // No response returned on success.
System.out.println("Delete successful.");
}
}
public static void deleteAccount(Config config) throws Exception {
deleteAccount(config, config.getAccountId().toString());
}
public static void main(String[] args) throws Exception {
Config config = Config.load();
deleteAccount(config);
}
}
PHP
use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Accounts\V1\Client\AccountsServiceClient;
use Google\Shopping\Merchant\Accounts\V1\DeleteAccountRequest;
/**
* This class demonstrates how to delete a given Merchant Center account.
*/
class DeleteAccount
{
private static function getParent(string $accountId): string
{
return sprintf("accounts/%s", $accountId);
}
// This method can delete a standalone, advanced account or sub-account.
// If you delete an advanced account, all sub-accounts will also be deleted.
// Admin user access is required to execute this method.
public static function deleteAccount(array $config): void
{
// Gets the OAuth credentials to make the request.
$credentials = Authentication::useServiceAccountOrTokenFile();
// Creates options config containing credentials for the client to use.
$options = ['credentials' => $credentials];
// Creates a client.
$accountsServiceClient = new AccountsServiceClient($options);
// Gets the account ID from the config file.
$accountId = $config['accountId'];
// Creates account name to identify the account.
$name = self::getParent($accountId);
// Calls the API and catches and prints any network failures/errors.
try {
$request = new DeleteAccountRequest([
'name' => $name,
// Optional. If set to true, the account will be deleted even if it has offers or
// provides services to other accounts. Defaults to 'false'.
'force' => true,
]);
print "Sending Delete Account request\n";
$accountsServiceClient->deleteAccount($request); // No response returned on success.
print "Delete successful.\n";
} catch (ApiException $e) {
print $e->getMessage();
}
}
public function callSample(): void
{
$config = Config::generateConfig();
self::deleteAccount($config);
}
}
$sample = new DeleteAccount();
$sample->callSample();
Python
from examples.authentication import configuration
from examples.authentication import generate_user_credentials
from google.shopping.merchant_accounts_v1 import AccountsServiceClient
from google.shopping.merchant_accounts_v1 import DeleteAccountRequest
def get_parent(account_id):
return f"accounts/{account_id}"
def delete_account(account_id: str):
"""Deletes a given Merchant Center account."""
# Get OAuth credentials.
credentials = generate_user_credentials.main()
# Create a client.
client = AccountsServiceClient(credentials=credentials)
# Create the account name.
name = get_parent(account_id)
# Create the request.
request = DeleteAccountRequest(name=name, force=True)
# Make the request and print the response.
try:
print("Sending Delete Account request")
client.delete_account(request=request)
print("Delete successful.")
except RuntimeError as e:
print(e)
raise
if __name__ == "__main__":
_account_id = configuration.Configuration().read_merchant_info()
delete_account(_account_id)
cURL
curl -X DELETE \
"https://merchantapi.googleapis.com/accounts/v1/accounts/{SUB_ACCOUNT_ID}?force=true" \
-H "Authorization: Bearer {YOUR_ACCESS_TOKEN}" \
Acepta las Condiciones del Servicio
Las cuentas de cliente heredan las Condiciones del Servicio de Merchant Center (ToS) que firmó la cuenta avanzada principal.
Actualiza la información de la empresa
Puedes usar la API de cuentas de comerciante para editar la información de la empresa de tus cuentas de cliente.
- Para ver la información de la empresa de una cuenta, llama a
accounts.getBusinessInfo. - Para editar la información de la empresa de una cuenta, llama a
accounts.updateBusinessInfo.