Criar uma conta

Para criar uma conta de cliente, envie um objeto Customer pré-preenchido usando o método CreateCustomerClient em CustomerService.

Ao contrário da criação de entidades padrão (como a criação de campanhas usando chamadas mutate), você precisa especificar o ID de cliente da conta de administrador na solicitação, e não o ID do cliente que está sendo criado.

Campos de solicitação e cliente

Ao chamar CustomerService.CreateCustomerClient, configure CreateCustomerClientRequest e o objeto Customer aninhado, conforme mostrado na tabela a seguir:

Campo ou cabeçalho Requisito Mutabilidade e descrição
customer_id Obrigatório O ID de cliente de 10 dígitos (sem hifens) da conta de administrador pai direta em que a nova conta de cliente é criada.
login-customer-id (cabeçalho) Condicional Obrigatório nos cabeçalhos de solicitação se o usuário autenticado acessar a conta de administrador pai (customer_id) por uma conta de administrador ancestral mais alta na hierarquia.
customer_client.descriptive_name Obrigatório Mutável:nome de exibição da nova conta (por exemplo, "Acct Created with CustomerService"). Pode ser atualizado mais tarde com CustomerService.MutateCustomer.
customer_client.currency_code Obrigatório Imutável após a criação: código de moeda de faturamento ISO 4217 de três caracteres (por exemplo, USD ou EUR). Consulte os códigos de moeda aceitos.
customer_client.time_zone Obrigatório Imutável após a criação: ID do fuso horário da conta (por exemplo, America/New_York). Consulte os fusos horários aceitos.
email_address e access_role Opcional (somente lista de permissões) Convida um usuário (ADMIN, STANDARD, READ_ONLY ou EMAIL_ONLY) para a conta criada durante a criação. As contas que não estão na lista de permissões precisam convidar usuários após a criação usando CustomerUserAccessInvitationService.
validate_only Opcional Quando true, valida os parâmetros de solicitação e a qualificação do administrador sem criar a conta.

Exemplo de código

O exemplo a seguir demonstra como criar uma conta de cliente em uma conta de administrador:

Java

private void runExample(GoogleAdsClient googleAdsClient, Long managerId) {
  // Formats the current date/time to use as a timestamp in the new customer description.
  String dateTime = ZonedDateTime.now().format(DateTimeFormatter.RFC_1123_DATE_TIME);

  // Initializes a Customer object to be created.
  Customer customer =
      Customer.newBuilder()
          .setDescriptiveName("Account created with CustomerService on '" + dateTime + "'")
          .setCurrencyCode("USD")
          .setTimeZone("America/New_York")
          // Optional: Sets additional attributes of the customer.
          .setTrackingUrlTemplate("{lpurl}?device={device}")
          .setFinalUrlSuffix("keyword={keyword}&matchtype={matchtype}&adgroupid={adgroupid}")
          .build();

  // Sends the request to create the customer.
  try (CustomerServiceClient client =
      googleAdsClient.getLatestVersion().createCustomerServiceClient()) {
    CreateCustomerClientResponse response =
        client.createCustomerClient(managerId.toString(), customer);
    System.out.printf(
        "Created a customer with resource name '%s' under the manager account with"
            + " customer ID '%d'.%n",
        response.getResourceName(), managerId);
  }
}

C#

public void Run(GoogleAdsClient client, long managerCustomerId)
{
    // Get the CustomerService.
    CustomerServiceClient customerService = client.GetService(Services.V26.CustomerService);

    Customer customer = new Customer()
    {
        DescriptiveName = $"Account created with CustomerService on '{DateTime.Now}'",

        // For a list of valid currency codes and time zones see this documentation:
        // https://developers.google.com/google-ads/api/reference/data/codes-formats#codes_formats.
        CurrencyCode = "USD",
        TimeZone = "America/New_York",

        // The below values are optional. For more information about URL
        // options see: https://support.google.com/google-ads/answer/6305348.
        TrackingUrlTemplate = "{lpurl}?device={device}",
        FinalUrlSuffix = "keyword={keyword}&matchtype={matchtype}&adgroupid={adgroupid}"
    };

    try
    {
        // Create the account.
        CreateCustomerClientResponse response = customerService.CreateCustomerClient(
            managerCustomerId.ToString(), customer);

        // Display the result.
        Console.WriteLine($"Created a customer with resource name " +
            $"'{response.ResourceName}' under the manager account with customer " +
            $"ID '{managerCustomerId}'");
    }
    catch (GoogleAdsException e)
    {
        Console.WriteLine("Failure:");
        Console.WriteLine($"Message: {e.Message}");
        Console.WriteLine($"Failure: {e.Failure}");
        Console.WriteLine($"Request ID: {e.RequestId}");
        throw;
    }
}

PHP

public static function runExample(GoogleAdsClient $googleAdsClient, int $managerCustomerId)
{
    $customer = new Customer([
        'descriptive_name' => 'Account created with CustomerService on ' . date('Ymd h:i:s'),
        // For a list of valid currency codes and time zones see this documentation:
        // https://developers.google.com/google-ads/api/reference/data/codes-formats.
        'currency_code' => 'USD',
        'time_zone' => 'America/New_York',
        // The below values are optional. For more information about URL
        // options see: https://support.google.com/google-ads/answer/6305348.
        'tracking_url_template' => '{lpurl}?device={device}',
        'final_url_suffix' => 'keyword={keyword}&matchtype={matchtype}&adgroupid={adgroupid}'
    ]);

    // Issues a mutate request to create an account
    $customerServiceClient = $googleAdsClient->getCustomerServiceClient();
    $response = $customerServiceClient->createCustomerClient(
        CreateCustomerClientRequest::build($managerCustomerId, $customer)
    );

    printf(
        'Created a customer with resource name "%s" under the manager account with '
        . 'customer ID %d.%s',
        $response->getResourceName(),
        $managerCustomerId,
        PHP_EOL
    );
}

Python

def main(client: GoogleAdsClient, manager_customer_id: str) -> None:
    """The main method that creates all necessary entities for the example.

    Args:
        client: an initialized GoogleAdsClient instance.
        manager_customer_id: a manager client customer ID.
    """
    customer_service: CustomerServiceClient = client.get_service(
        "CustomerService"
    )
    customer: Customer = client.get_type("Customer")
    now: str = datetime.today().strftime("%Y%m%d %H:%M:%S")
    customer.descriptive_name = f"Account created with CustomerService on {now}"
    # For a list of valid currency codes and time zones see this documentation:
    # https://developers.google.com/google-ads/api/reference/data/codes-formats
    customer.currency_code = "USD"
    customer.time_zone = "America/New_York"
    # The below values are optional. For more information about URL
    # options see: https://support.google.com/google-ads/answer/6305348
    customer.tracking_url_template = "{lpurl}?device={device}"
    customer.final_url_suffix = (
        "keyword={keyword}&matchtype={matchtype}&adgroupid={adgroupid}"
    )

    response: CreateCustomerClientResponse = (
        customer_service.create_customer_client(
            customer_id=manager_customer_id, customer_client=customer
        )
    )
    print(
        f'Customer created with resource name "{response.resource_name}" '
        f'under manager account with ID "{manager_customer_id}".'
    )

Ruby

def create_customer(manager_customer_id)
  # GoogleAdsClient will read a config file from
  # ENV['HOME']/google_ads_config.rb when called without parameters
  client = Google::Ads::GoogleAds::GoogleAdsClient.new

  customer = client.resource.customer do |c|
    c.descriptive_name = "Account created with CustomerService on #{(Time.new.to_f * 1000).to_i}"

    # For a list of valid currency codes and time zones, see this documentation:
    # https://developers.google.com/google-ads/api/reference/data/codes-formats
    c.currency_code = "USD"
    c.time_zone = "America/New_York"

    # The below values are optional. For more information about URL options, see:
    # https://support.google.com/google-ads/answer/6305348
    c.tracking_url_template = "{lpurl}?device={device}"
    c.final_url_suffix = "keyword={keyword}&matchtype={matchtype}&adgroupid={adgroupid}"
  end

  response = client.service.customer.create_customer_client(
    customer_id: manager_customer_id,
    customer_client: customer
  )

  puts "Created a customer with resource name #{response.resource_name} under" +
      " the manager account with customer ID #{manager_customer_id}."
end

Perl

sub create_customer {
  my ($api_client, $manager_customer_id) = @_;

  # Initialize a customer to be created.
  my $customer = Google::Ads::GoogleAds::V26::Resources::Customer->new({
      descriptiveName => "Account created with CustomerService on #" . uniqid(),

      # For a list of valid currency codes and time zones, see this documentation:
      # https://developers.google.com/google-ads/api/reference/data/codes-formats
      currencyCode => "USD",
      timeZone     => "America/New_York",

      # The below values are optional. For more information about URL options, see:
      # https://support.google.com/google-ads/answer/6305348
      trackingUrlTemplate => "{lpurl}?device={device}",
      finalUrlSuffix      =>
        "keyword={keyword}&matchtype={matchtype}&adgroupid={adgroupid}"
  });

  # Create the customer client.
  my $create_customer_client_response =
    $api_client->CustomerService()->create_customer_client({
      customerId     => $manager_customer_id,
      customerClient => $customer
    });

  printf
    "Created a customer with resource name '%s' under the manager account " .
    "with customer ID %d.\n", $create_customer_client_response->{resourceName},
    $manager_customer_id;

  return 1;
}

curl

# Creates a customer client.
#
# Variables:
#   API_VERSION,
#   MANAGER_CUSTOMER_ID,
#   OAUTH2_ACCESS_TOKEN:
#     See https://developers.google.com/google-ads/api/rest/auth#request_headers
#     for details.
#
curl -f --request POST \
"https://googleads.googleapis.com/v${API_VERSION}/customers/${MANAGER_CUSTOMER_ID}:createCustomerClient" \
--header "Content-Type: application/json" \
--header "login-customer-id: ${MANAGER_CUSTOMER_ID}" \
--header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \
--data @- <<EOF
{
  "customerClient": {
    "descriptiveName": "Account created with CustomerService #${RANDOM}",
    "currencyCode": "USD",
    "timeZone": "America/New_York"
  }
}
EOF

Resposta e próximas etapas

Quando bem-sucedido, CreateCustomerClient retorna uma CreateCustomerClientResponse que contém o resource_name (customers/{new_customer_id}) da conta recém- criada (além de um invitation_link se email_address e access_role foram incluídos por uma conta de administrador na lista de permissões). Em seguida, você pode usar esse nome de recurso ou ID de cliente para verificar a conta na sua hierarquia, conceder acesso do usuário, configurar o faturamento ou preencher campanhas.

Verificar a conta criada na hierarquia de administradores

Consulte o recurso customer_client na conta de administrador (customer_id) usando GoogleAdsService.SearchStream para inspecionar a subconta recém-criada:

SELECT
  customer_client.id,
  customer_client.resource_name,
  customer_client.client_customer,
  customer_client.descriptive_name,
  customer_client.currency_code,
  customer_client.time_zone,
  customer_client.manager,
  customer_client.level,
  customer_client.status
FROM customer_client
WHERE customer_client.level = 1
  AND customer_client.id = {new_customer_id}

Convidar usuários para a nova conta

Se a conta de administrador não estiver na lista de permissões para definir email_address e access_role diretamente em CreateCustomerClientRequest, envie um convite de acesso ao new_customer_id recém-criado usando MutateCustomerUserAccessInvitation em CustomerUserAccessInvitationService. Ao autenticar pela conta de administrador pai, inclua login-customer-id: {manager_customer_id} nos cabeçalhos da solicitação HTTP:

POST https://googleads.googleapis.com/v26/customers/{new_customer_id}/customerUserAccessInvitations:mutate
{
  "operation": {
    "create": {
      "emailAddress": "user@example.com",
      "accessRole": "ADMIN"
    }
  }
}

Tratamento de erros

As chamadas para CreateCustomerClient podem retornar os seguintes erros:

  • CustomerError: indica restrições de criação no nível da conta, como CREATION_DENIED_INELIGIBLE_MCC (a conta de administrador não está qualificada para criar novas contas) ou CREATION_DENIED_FOR_POLICY_VIOLATION (a criação de clientes é negada devido a uma violação da política).
  • ManagerLinkError: indica restrições de hierarquia ou limite de contas, como TOO_MANY_ACCOUNTS, TOO_MANY_ACCOUNTS_AT_MANAGER ou MAX_DEPTH_EXCEEDED.
  • AccessInvitationError: retornado se um email_address opcional (junto com access_role, disponível apenas para contas na lista de permissões) for fornecido em CreateCustomerClientRequest para convidar um usuário para a nova conta e o convite falhar (por exemplo, INVALID_EMAIL_ADDRESS, GOOGLE_CONSUMER_ACCOUNT_NOT_ALLOWED, ou EMAIL_DOMAIN_POLICY_VIOLATED). As contas que não estão na lista de permissões precisam convidar usuários após a criação da conta usando CustomerUserAccessInvitationService.
  • CurrencyCodeError.UNSUPPORTED ou TimeZoneError.INVALID_TIME_ZONE: retornado quando o currency_code ou time_zone especificado no objeto Customer é inválido ou não aceito.
Anterior
Vista geral
Avançar
Associe a contas de gestor