Rótulos

Os rótulos permitem que você classifique suas campanhas, grupos de anúncios, anúncios e palavras-chave e use essas categorias para simplificar seu fluxo de trabalho de várias maneiras.

Este guia explica os passos necessários para:

Este guia se concentra em campanhas, mas você pode usar a mesma abordagem para grupos de anúncios, anúncios e palavras-chave. A API também fornece CustomerLabelService, que permite que as contas de administrador atribuam rótulos às contas filhas.

Casos de uso

Cenários típicos para o uso de rótulos incluem:

  • Sua conta tem campanhas ativadas somente durante determinadas épocas do ano, e você quer incluir ou excluir facilmente essas campanhas dos relatórios.
  • Você adicionou um novo conjunto de palavras-chave ao grupo de anúncios e quer comparar as estatísticas dele com outras palavras-chave do grupo.
  • Cada usuário da sua conta do Google Ads gerencia um subconjunto de campanhas, e você quer identificar o conjunto de campanhas de cada usuário.
  • Seu app precisa marcar o status de determinados objetos.

Crie marcadores

Crie rótulos com o objeto TextLabel:

  1. Crie uma instância TextLabel.
  2. Defina uma cor de plano de fundo para a TextLabel.
  3. Insira o texto para a TextLabel usando o campo de descrição.
  4. Una o TextLabel em um LabelOperation e envie-o para LabelService.MutateLabels.

Anote os IDs dos novos rótulos para consultas posteriores. Os IDs são incorporados no campo resource_name no MutateLabelResults retornado em MutateLabelsResponse.

Também é possível usar uma solicitação LabelService.GetLabel ou uma solicitação Search ou SearchStream de GoogleAdsService para recuperar os IDs.

Atribuir rótulos

É possível atribuir rótulos a campanhas, clientes, grupos de anúncios, critérios ou anúncios. Use a operação Mutate no serviço apropriado para atribuir rótulos.

Por exemplo, para atribuir rótulos a uma campanha, transmita um ou mais CampaignLabelOperation para CampaignLabelService.MutateCampaignLabels. Cada CampaignLabelOperation inclui uma instância CampaignLabel, que contém estes campos:

  • label: ID de um rótulo
  • campaign: ID de uma campanha

Crie uma instância CampaignLabel para cada par de rótulo e campanha. Encapsule-o em um CampaignLabelOperation com a operação create e envie-o para CampaignService.MutateCampaignLabels.

Adicionar rótulos de campanha

Veja um exemplo de código que mostra como adicionar um rótulo de campanha a uma lista de campanhas:

Java

private void runExample(
    GoogleAdsClient googleAdsClient, long customerId, List<Long> campaignIds, Long labelId) {
  // Gets the resource name of the label to be added across all given campaigns.
  String labelResourceName = ResourceNames.label(customerId, labelId);

  List<CampaignLabelOperation> operations = new ArrayList<>(campaignIds.size());
  // Creates a campaign label operation for each campaign.
  for (Long campaignId : campaignIds) {
    // Gets the resource name of the given campaign.
    String campaignResourceName = ResourceNames.campaign(customerId, campaignId);
    // Creates the campaign label.
    CampaignLabel campaignLabel =
        CampaignLabel.newBuilder()
            .setCampaign(campaignResourceName)
            .setLabel(labelResourceName)
            .build();

    operations.add(CampaignLabelOperation.newBuilder().setCreate(campaignLabel).build());
  }

  try (CampaignLabelServiceClient campaignLabelServiceClient =
      googleAdsClient.getLatestVersion().createCampaignLabelServiceClient()) {
    MutateCampaignLabelsResponse response =
        campaignLabelServiceClient.mutateCampaignLabels(Long.toString(customerId), operations);
    System.out.printf("Added %d campaign labels:%n", response.getResultsCount());
    for (MutateCampaignLabelResult result : response.getResultsList()) {
      System.out.println(result.getResourceName());
    }
  }
}
AddCampaignLabels.java

C#

public void Run(GoogleAdsClient client, long customerId, long[] campaignIds, long labelId)
{
    // Get the CampaignLabelServiceClient.
    CampaignLabelServiceClient campaignLabelService =
        client.GetService(Services.V17.CampaignLabelService);

    // Gets the resource name of the label to be added across all given campaigns.
    string labelResourceName = ResourceNames.Label(customerId, labelId);

    List<CampaignLabelOperation> operations = new List<CampaignLabelOperation>();
    // Creates a campaign label operation for each campaign.
    foreach (long campaignId in campaignIds)
    {
        // Gets the resource name of the given campaign.
        string campaignResourceName = ResourceNames.Campaign(customerId, campaignId);
        // Creates the campaign label.
        CampaignLabel campaignLabel = new CampaignLabel()
        {
            Campaign = campaignResourceName,
            Label = labelResourceName
        };

        operations.Add(new CampaignLabelOperation()
        {
            Create = campaignLabel
        });
    }

    // Send the operation in a mutate request.
    try
    {
        MutateCampaignLabelsResponse response =
            campaignLabelService.MutateCampaignLabels(customerId.ToString(), operations);
        Console.WriteLine($"Added {response.Results} campaign labels:");

        foreach (MutateCampaignLabelResult result in response.Results)
        {
            Console.WriteLine(result.ResourceName);
        }
    }
    catch (GoogleAdsException e)
    {
        Console.WriteLine("Failure:");
        Console.WriteLine($"Message: {e.Message}");
        Console.WriteLine($"Failure: {e.Failure}");
        Console.WriteLine($"Request ID: {e.RequestId}");
        throw;
    }
}
AddCampaignLabels.cs

PHP

public static function runExample(
    GoogleAdsClient $googleAdsClient,
    int $customerId,
    array $campaignIds,
    int $labelId
) {
    // Gets the resource name of the label to be added across all given campaigns.
    $labelResourceName = ResourceNames::forLabel($customerId, $labelId);

    // Creates a campaign label operation for each campaign.
    $operations = [];
    foreach ($campaignIds as $campaignId) {
        // Creates the campaign label.
        $campaignLabel = new CampaignLabel([
            'campaign' => ResourceNames::forCampaign($customerId, $campaignId),
            'label' => $labelResourceName
        ]);
        $campaignLabelOperation = new CampaignLabelOperation();
        $campaignLabelOperation->setCreate($campaignLabel);
        $operations[] = $campaignLabelOperation;
    }

    // Issues a mutate request to add the labels to the campaigns.
    $campaignLabelServiceClient = $googleAdsClient->getCampaignLabelServiceClient();
    $response = $campaignLabelServiceClient->mutateCampaignLabels(
        MutateCampaignLabelsRequest::build($customerId, $operations)
    );

    printf("Added %d campaign labels:%s", $response->getResults()->count(), PHP_EOL);

    foreach ($response->getResults() as $addedCampaignLabel) {
        /** @var CampaignLabel $addedCampaignLabel */
        printf(
            "New campaign label added with resource name: '%s'.%s",
            $addedCampaignLabel->getResourceName(),
            PHP_EOL
        );
    }
}
AddCampaignLabels.php

Python

def main(client, customer_id, label_id, campaign_ids):
    """This code example adds a campaign label to a list of campaigns.

    Args:
        client: An initialized GoogleAdsClient instance.
        customer_id: A client customer ID str.
        label_id: The ID of the label to attach to campaigns.
        campaign_ids: A list of campaign IDs to which the label will be added.
    """

    # Get an instance of CampaignLabelService client.
    campaign_label_service = client.get_service("CampaignLabelService")
    campaign_service = client.get_service("CampaignService")
    label_service = client.get_service("LabelService")

    # Build the resource name of the label to be added across the campaigns.
    label_resource_name = label_service.label_path(customer_id, label_id)

    operations = []

    for campaign_id in campaign_ids:
        campaign_resource_name = campaign_service.campaign_path(
            customer_id, campaign_id
        )
        campaign_label_operation = client.get_type("CampaignLabelOperation")

        campaign_label = campaign_label_operation.create
        campaign_label.campaign = campaign_resource_name
        campaign_label.label = label_resource_name
        operations.append(campaign_label_operation)

    response = campaign_label_service.mutate_campaign_labels(
        customer_id=customer_id, operations=operations
    )
    print(f"Added {len(response.results)} campaign labels:")
    for result in response.results:
        print(result.resource_name)
add_campaign_labels.py

Ruby

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

  label_resource_name = client.path.label(customer_id, label_id)

  labels = campaign_ids.map { |campaign_id|
    client.resource.campaign_label do |label|
      campaign_resource_name = client.path.campaign(customer_id, campaign_id)
      label.campaign = campaign_resource_name
      label.label = label_resource_name
    end
  }

  ops = labels.map { |label|
    client.operation.create_resource.campaign_label(label)
  }

  response = client.service.campaign_label.mutate_campaign_labels(
    customer_id: customer_id,
    operations: ops,
  )
  response.results.each do |result|
    puts("Created campaign label with id: #{result.resource_name}")
  end
end
add_campaign_labels.rb

Perl

sub add_campaign_labels {
  my ($api_client, $customer_id, $campaign_ids, $label_id) = @_;

  my $label_resource_name =
    Google::Ads::GoogleAds::V17::Utils::ResourceNames::label($customer_id,
    $label_id);

  my $campaign_label_operations = [];

  # Create a campaign label operation for each campaign.
  foreach my $campaign_id (@$campaign_ids) {
    # Create a campaign label.
    my $campaign_label =
      Google::Ads::GoogleAds::V17::Resources::CampaignLabel->new({
        campaign => Google::Ads::GoogleAds::V17::Utils::ResourceNames::campaign(
          $customer_id, $campaign_id
        ),
        label => $label_resource_name
      });

    # Create a campaign label operation.
    my $campaign_label_operation =
      Google::Ads::GoogleAds::V17::Services::CampaignLabelService::CampaignLabelOperation
      ->new({
        create => $campaign_label
      });

    push @$campaign_label_operations, $campaign_label_operation;
  }

  # Add the campaign labels to the campaigns.
  my $campaign_labels_response = $api_client->CampaignLabelService()->mutate({
    customerId => $customer_id,
    operations => $campaign_label_operations
  });

  my $campaign_label_results = $campaign_labels_response->{results};
  printf "Added %d campaign labels:\n", scalar @$campaign_label_results;

  foreach my $campaign_label_result (@$campaign_label_results) {
    printf "Created campaign label '%s'.\n",
      $campaign_label_result->{resourceName};
  }

  return 1;
}
add_campaign_labels.pl

Recuperar objetos usando rótulos

Depois de atribuir rótulos às campanhas, será possível usar os campos de rótulos para recuperar objetos por ID.

Transmita uma consulta do GAQL apropriada para uma solicitação GoogleAdsService Search ou SearchStream. Por exemplo, a consulta a seguir retorna o ID, o nome e os rótulos de cada campanha associada a qualquer um dos três IDs de rótulo:

SELECT
  campaign.id,
  campaign.name,
  label.id,
  label.name
FROM campaign_label
WHERE label.id IN (123456, 789012, 345678)

Só é possível filtrar pelo ID do rótulo, não pelo nome dele. Para descobrir o ID de um rótulo, use esta consulta:

SELECT
  label.id,
  label.name
FROM label
WHERE label.name = "LABEL_NAME"

Recuperar rótulos aplicados a um cliente

Ao acessar a hierarquia de contas em uma conta de administrador, é possível recuperar a lista de rótulos aplicados a uma conta filha de cliente solicitando o campo applied_labels do objeto CustomerClient. Esse campo recupera apenas os rótulos de propriedade do cliente que faz a chamada de API.

Usar rótulos em relatórios

Relatórios de rótulos

O recurso de relatório Rótulo retorna detalhes sobre os rótulos definidos em uma conta. Os detalhes incluem nome, ID, nome do recurso, status, cor do plano de fundo e descrição, bem como o recurso Customer que representa o proprietário do rótulo.

Relatórios com métricas

As visualizações de relatório Grupo de anúncios e Campanha contêm o campo labels. O serviço de relatórios retorna os nomes de recursos de rótulo no formato customers/{customer_id}/labels/{label_id}. Por exemplo, o nome do recurso customers/123456789/labels/012345 refere-se ao rótulo com ID 012345 na conta com ID 123456789.

Relatórios sem métricas

Cada um dos seguintes recursos de relatório pode ser usado para encontrar relações entre recursos e rótulos:

É possível filtrar os resultados do relatório acima comparando o campo label.id usando qualquer operador de comparação numérica ou os operadores BETWEEN, IS NULL, IS NOT NULL, IN ou NOT IN.

Por exemplo, é possível ver todas as campanhas com um ID de rótulo específico da seguinte maneira:

SELECT
  campaign.id,
  campaign.name,
  label.id,
  label.name
FROM campaign_label
WHERE label.id = LABEL_ID
ORDER BY campaign.id
Anterior
Nenhuma métrica
Próxima
Streaming