Этикетки

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

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

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

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

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

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

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

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

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

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

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

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

Назначить метки

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

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

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

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

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

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

Ява

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());
    }
  }
}
      

С#

public void Run(GoogleAdsClient client, long customerId, long[] campaignIds, long labelId)
{
    // Get the CampaignLabelServiceClient.
    CampaignLabelServiceClient campaignLabelService =
        client.GetService(Services.V20.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;
    }
}
      

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
        );
    }
}
      

Питон

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)
      

Руби

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
      

Перл

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

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

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

Извлечение объектов с использованием их меток

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

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

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

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

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

Получить метки, примененные к клиенту

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

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

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

Отчетность по этикеткам

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

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

В отчётах « Группа объявлений» и «Кампания» есть поле labels . Служба отчётности возвращает названия ресурсов меток в формате customers/{customer_id}/labels/{label_id} . Например, название ресурса customers/123456789/labels/012345 относится к метке с идентификатором 012345 в аккаунте с идентификатором 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