Labels

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

In diesem Leitfaden werden die folgenden Aufgaben behandelt:

In diesem Leitfaden geht es hauptsächlich um Kampagnen. Sie können denselben Ansatz aber auch für Anzeigengruppen, Anzeigen und Keywords verwenden. Die API bietet auch CustomerLabelService, mit dem Verwaltungskonten untergeordneten Konten Labels zuweisen können.

Anwendungsfälle

Typische Anwendungsfälle für Labels:

  • In Ihrem Konto gibt es Kampagnen, die Sie nur zu bestimmten Zeiten des Jahres aktivieren. Sie möchten diese Kampagnen ganz einfach in Berichte aufnehmen oder daraus ausschließen.
  • Sie haben Ihrer Anzeigengruppe neue Keywords hinzugefügt und möchten die Statistiken mit anderen Keywords in der Anzeigengruppe vergleichen.
  • Die Nutzer Ihres Google Ads-Kontos verwalten jeweils einen Teil der Kampagnen. Sie möchten die Kampagnen für jeden Nutzer identifizieren.
  • Ihre App muss den Status bestimmter Objekte kennzeichnen.

Labels erstellen

So erstellen Sie Labels mit dem TextLabel-Objekt:

  1. Erstellen Sie eine TextLabel-Instanz.
  2. Legen Sie eine Hintergrundfarbe für diese TextLabel fest.
  3. Geben Sie im Feld „Beschreibung“ Text für diese TextLabel ein.
  4. Hülle die TextLabel in eine LabelOperation und sende sie an LabelService.MutateLabels.

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

Sie können die IDs auch mit einer LabelService.GetLabel- oder einer GoogleAdsService-Anfrage vom Typ Search oder SearchStream abrufen.

Labels zuweisen

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

Wenn Sie einer Kampagne beispielsweise Labels zuweisen möchten, übergeben Sie eine oder mehrere CampaignLabelOperation an CampaignLabelService.MutateCampaignLabels. Jedes CampaignLabelOperation enthält eine CampaignLabel-Instanz mit den folgenden Feldern:

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

Erstellen Sie für jedes Label-Kampagnen-Paar eine CampaignLabel-Instanz. Hülle ihn in einen CampaignLabelOperation mit dem Vorgang create ein und sende ihn an CampaignService.MutateCampaignLabels.

Mehreren Kampagnen ein Label hinzufügen

Hier ein Codebeispiel, das zeigt, wie einer Liste von Kampagnen ein Kampagnenlabel hinzugefügt wird:

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

C#

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

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)
      

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
      

Perl

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

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

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

Objekte anhand ihrer Labels abrufen

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

Übergeben Sie eine geeignete 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, nicht nach dem Labelnamen filtern. Mit dieser Abfrage kannst du die Label-ID aus einem Labelnamen abrufen:

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

Auf einen Kunden angewendete Labels abrufen

Wenn Sie die Hierarchie der Konten unter einem Verwaltungskonto abrufen, können Sie die Liste der Labels abrufen, die auf ein untergeordnetes Kundenkonto angewendet werden. Dazu müssen Sie das Feld applied_labels vom Objekt CustomerClient anfordern. In diesem Feld werden nur die Labels abgerufen, deren Inhaber der Kunde ist, der den API-Aufruf ausfü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 Kundenressource, die den Inhaber des Labels darstellt.

Berichte mit Messwerten

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

Berichte ohne Messwerte

Mit den folgenden Berichtsressourcen können Sie Beziehungen zwischen Ressourcen und Labels ermitteln:

Sie können die oben genannten Berichtsergebnisse filtern, indem 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 rufen Sie beispielsweise alle Kampagnen mit einer bestimmten Label-ID ab:

SELECT
  campaign.id,
  campaign.name,
  label.id,
  label.name
FROM campaign_label
WHERE label.id = LABEL_ID
ORDER BY campaign.id