Этикетки

Метки позволяют классифицировать ваши кампании, группы объявлений, объявления и ключевые слова, и использовать эти категории для упрощения рабочего процесса различными способами.

В данном руководстве описаны шаги, необходимые для выполнения следующих действий:

  • Создавайте метки программно с помощью LabelService .
  • Присваивайте метки своим кампаниям с помощью запросов CampaignLabelService .
  • Получение и фильтрация результатов отчета по меткам с помощью запросов GoogleAdsService .

В этом руководстве основное внимание уделяется кампаниям, но вы можете использовать тот же подход для групп объявлений, объявлений и ключевых слов. Этот API также предоставляет CustomerLabelService , который позволяет учетным записям администраторов назначать метки дочерним учетным записям.

Варианты использования

Типичные сценарии использования меток включают следующие:

  • В вашем аккаунте есть кампании, которые вы активируете только в определенные периоды года, и вы хотите включить или исключить эти кампании из отчетов.
  • Вы добавили новый набор ключевых слов в свою группу объявлений и хотите сравнить их статистику с другими ключевыми словами в вашей группе объявлений.
  • Каждый пользователь вашего аккаунта Google Ads управляет подмножеством кампаний, и вам нужен способ определить набор кампаний для каждого пользователя.
  • Вашему приложению необходимо отмечать статус определенных объектов.

Создать метки

Создавайте метки с помощью объекта TextLabel :

  1. Создайте экземпляр TextLabel .
  2. Задайте цвет фона для этого TextLabel .
  3. Введите текст для этой TextLabel используя поле описания.
  4. Оберните TextLabel в объект LabelOperation и отправьте его в LabelService.MutateLabels .

Запишите идентификаторы новых меток для последующих запросов. Идентификаторы встроены в поле resource_name в объекте MutateLabelResults , возвращаемом в объекте MutateLabelsResponse .

Для получения идентификаторов можно использовать запрос GoogleAdsService Search или SearchStream .

Присвоить метки

Вы можете присваивать метки своим кампаниям, клиентам, группам объявлений, критериям или объявлениям. Для присвоения меток используйте операцию Mutate в соответствующем сервисе.

Например, чтобы присвоить метки кампании, передайте один или несколько CampaignLabelOperation в CampaignLabelService.MutateCampaignLabels . Каждый CampaignLabelOperation включает экземпляр CampaignLabel , содержащий следующие поля:

  • label : идентификатор метки
  • campaign : идентификатор кампании

Создайте экземпляр CampaignLabel для каждой пары "метка-кампания". Оберните его в объект CampaignLabelOperation с операцией create и отправьте его в CampaignService.MutateCampaignLabels .

Добавить метки кампании

Вот пример кода, демонстрирующий, как добавить метку кампании к списку кампаний:

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.V23.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: GoogleAdsClient,
    customer_id: str,
    label_id: str,
    campaign_ids: List[str],
) -> None:
    """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: CampaignLabelServiceClient = client.get_service(
        "CampaignLabelService"
    )
    campaign_service: CampaignServiceClient = client.get_service(
        "CampaignService"
    )
    label_service: LabelServiceClient = client.get_service("LabelService")

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

    operations: List[Any] = []

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

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

    response: MutateCampaignLabelsResponse = (
        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

Руби 

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::V23::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::V23::Resources::CampaignLabel->new({
        campaign => Google::Ads::GoogleAds::V23::Utils::ResourceNames::campaign(
          $customer_id, $campaign_id
        ),
        label => $label_resource_name
      });

    # Create a campaign label operation.
    my $campaign_label_operation =
      Google::Ads::GoogleAds::V23::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

локон

Извлекайте объекты, используя их метки.

После присвоения меток вашим кампаниям вы можете использовать поля меток для получения объектов по идентификатору.

Передайте соответствующий GAQL- запрос в запрос GoogleAdsService Search или SearchStream . Например, следующий запрос возвращает ID, имя и метки для каждой кампании, связанной с любым из трех идентификаторов меток:

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

Фильтрация возможна только по идентификатору метки (ID), а не по названию метки (Name). Чтобы получить идентификатор метки из названия метки, используйте следующий запрос:

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

Получить этикетки, наклеенные на клиента.

При получении иерархии учетных записей под учетной записью менеджера вы можете получить список меток, примененных к дочерней учетной записи клиента, запросив поле applied_labels из объекта CustomerClient . Это поле извлекает только метки, принадлежащие клиенту, выполняющему вызов API.

Используйте метки в отчетах

Используйте метки, чтобы повысить полезность ваших отчетов.

Сообщения о маркировке

Ресурс отчета «Метки» возвращает подробную информацию о метках, определенных в учетной записи. В сведения входят имя, идентификатор, имя ресурса, статус, цвет фона и описание, а также ресурс «Клиент» , представляющий владельца метки.

Отчеты с метриками

В отчетах по группам объявлений и кампаниям содержится поле labels . Служба отчетов возвращает имена ресурсов меток в формате customers/{customer_id}/labels/{label_id} . Например, имя ресурса customers/123456789/labels/012345 относится к метке с ID 012345 в учетной записи с ID 123456789 .

Отчеты без метрик

Для поиска взаимосвязей между ресурсами и метками можно использовать любой из следующих ресурсов для создания отчетов:

Вы можете отфильтровать результаты этого отчета, сравнив поле label.id с помощью любого числового оператора сравнения или операторов BETWEEN , IS NULL , IS NOT NULL , IN или NOT IN .

В этом примере вы можете получить все кампании с определенным идентификатором метки:

SELECT
  campaign.id,
  campaign.name,
  label.id,
  label.name
FROM campaign_label
WHERE label.id = LABEL_ID
ORDER BY campaign.id
Назад
Нулевые показатели
Далее
Потоковое