Labels

Mit Labels können Sie Ihre Kampagnen, Anzeigengruppen, Anzeigen und Keywords in Kategorien einordnen und diese Kategorien verwenden, um Ihren Workflow auf verschiedene Arten zu vereinfachen.

In diesem Leitfaden werden die folgenden Aufgaben behandelt:

  • Erstellen Sie Labels programmatisch mithilfe von LabelService.
  • Weisen Sie Ihren Kampagnen Labels mithilfe von CampaignLabelService-Anfragen zu.
  • Verwenden Sie GoogleAdsService-Abfragen, um Berichtsergebnisse nach Label abzurufen und zu filtern.

Der Schwerpunkt dieses Leitfadens liegt auf Kampagnen. Sie können jedoch denselben Ansatz für Anzeigengruppen, Anzeigen und Keywords verwenden. Die API bietet auch CustomerLabelService, mit dem Verwaltungskonten untergeordneten Konten Labels zuweisen können.

Anwendungsfälle

Typische Szenarien für die Verwendung von Labels sind:

  • Ihr Konto enthält Kampagnen, die Sie nur zu bestimmten Jahreszeiten aktivieren und die Sie ganz einfach in Berichte einschließen oder daraus ausschließen möchten.
  • Sie haben Ihrer Anzeigengruppe neue Keywords hinzugefügt und möchten deren Statistiken mit anderen Keywords in der Anzeigengruppe vergleichen.
  • Alle Nutzer Ihres Google Ads-Kontos verwalten einen Teil der Kampagnen und Sie möchten die Kampagnengruppe für jeden Nutzer ermitteln können.
  • Ihre App muss den Status bestimmter Objekte markieren.

Labels erstellen

Erstellen Sie Labels mit dem Objekt TextLabel:

  1. Erstellen Sie eine TextLabel-Instanz.
  2. Legen Sie eine Hintergrundfarbe für dieses Gerät (TextLabel) fest.
  3. Geben Sie im Beschreibungsfeld Text für TextLabel ein.
  4. Schließen Sie TextLabel in eine LabelOperation ein und senden Sie sie an LabelService.MutateLabels.

Notieren Sie sich die IDs der neuen Labels für spätere Abfragen. Die IDs sind in das Feld resource_name im MutateLabelResults eingebettet, der in MutateLabelsResponse zurückgegeben wird.

Sie können auch eine LabelService.GetLabel-Anfrage oder eine GoogleAdsService-Search- oder SearchStream-Anfrage verwenden, um die IDs abzurufen.

Labels zuweisen

Sie können Ihren Kampagnen, Kunden, Anzeigengruppen, Kriterien oder Anzeigen Labels zuweisen. Verwenden Sie den Vorgang Mutate im entsprechenden Dienst, um Labels zuzuweisen.

Wenn Sie beispielsweise einer Kampagne Labels zuweisen möchten, übergeben Sie ein oder mehrere CampaignLabelOperation an CampaignLabelService.MutateCampaignLabels. Jede CampaignLabelOperation enthält eine CampaignLabel-Instanz, die die folgenden Felder enthält:

  • label: ID eines Labels
  • campaign: ID einer Kampagne

Erstellen Sie für jedes Label-Kampagnen-Paar eine CampaignLabel-Instanz. Schließen Sie sie mit dem create-Vorgang in eine CampaignLabelOperation ein und senden Sie sie an CampaignService.MutateCampaignLabels.

Mehreren Kampagnen ein Label hinzufügen

Das folgende Codebeispiel zeigt, wie Sie einer Liste von Kampagnen ein Kampagnenlabel hinzufügen:

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

Objekte anhand ihrer Labels abrufen

Nachdem Sie Ihren Kampagnen Labels zugewiesen haben, können Sie mithilfe der Labelfelder Objekte nach ID abrufen.

Übergeben Sie eine entsprechende GAQL-Abfrage an eine GoogleAdsService-Search- oder SearchStream-Anfrage. Die folgende Abfrage gibt beispielsweise die ID, den Namen und die Labels für jede Kampagne zurück, die mit einer der drei Label-IDs verknüpft ist:

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

Sie können nur nach der Label-ID filtern, nicht nach dem Labelnamen. Sie können diese Abfrage verwenden, um die Label-ID aus einem Labelnamen abzurufen:

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

Labels abrufen, die auf einen Kunden angewendet wurden

Wenn Sie die Hierarchie der Konten in einem Verwaltungskonto abrufen, können Sie die Liste der Labels abrufen, die auf ein untergeordnetes Kundenkonto angewendet wurden. Dazu fordern Sie das Feld applied_labels aus dem CustomerClient-Objekt an. Über dieses Feld werden nur die Labels abgerufen, die dem Kunden gehören, der den API-Aufruf durchführt.

Labels in Berichten verwenden

Labelberichte

Die Berichtsressource Label gibt Details zu den in einem Konto definierten Labels zurück. Zu den Details gehören Name, ID, Ressourcenname, Status, Hintergrundfarbe und Beschreibung sowie die Ressource Customer, die den Inhaber des Labels darstellt.

Berichte mit Messwerten

Die Berichtsansichten Anzeigengruppe und Kampagne enthalten das Feld labels. Der Berichtsdienst gibt die Labelressourcennamen im Format customers/{customer_id}/labels/{label_id} zurück. Beispielsweise bezieht sich der Ressourcenname customers/123456789/labels/012345 auf das Label mit der ID 012345 im Konto mit der ID 123456789.

Berichte ohne Messwerte

Jede der folgenden Berichtsressourcen kann verwendet werden, um Beziehungen zwischen Ressourcen und Labels zu ermitteln:

Zum Filtern der Berichtsergebnisse können Sie das Feld label.id mit einem beliebigen numerischen Vergleichsoperator oder den Operatoren BETWEEN, IS NULL, IS NOT NULL, IN oder NOT IN vergleichen.

So können Sie beispielsweise alle Kampagnen mit einer bestimmten Label-ID abrufen:

SELECT
  campaign.id,
  campaign.name,
  label.id,
  label.name
FROM campaign_label
WHERE label.id = LABEL_ID
ORDER BY campaign.id
Zurück
Null Messwerte
Weiter
Streaming