Labels

Mit Labels können Sie Ihre Kampagnen, Anzeigengruppen, Anzeigen und Keywords kategorisieren und diese Kategorien auf verschiedene Weise 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 aber dieselbe Vorgehensweise auch für Anzeigengruppen, Anzeigen und Keywords verwenden. Diese API bietet auch CustomerLabelService, mit dem Verwaltungskonten untergeordneten Konten Labels zuweisen können.

Anwendungsfälle

Typische Szenarien für die Verwendung von Labels:

  • Ihr Konto enthält Kampagnen, die Sie nur zu bestimmten Zeiten im Jahr aktivieren. Sie möchten diese Kampagnen in Berichte einbeziehen oder daraus ausschließen.
  • Sie haben Ihrer Anzeigengruppe eine neue Gruppe von Keywords hinzugefügt und möchten die Statistiken dieser Keywords mit denen anderer Keywords in Ihrer Anzeigengruppe vergleichen.
  • Nutzer Ihres Google Ads-Kontos verwalten jeweils eine Teilmenge von Kampagnen und Sie möchten die Kampagnen für jeden Nutzer identifizieren können.
  • Ihre App muss den Status bestimmter Objekte kennzeichnen.

Labels erstellen

Erstellen Sie Labels mit dem TextLabel Objekt:

  1. Erstellen Sie eine TextLabel-Instanz.
  2. Legen Sie eine Hintergrundfarbe für dieses TextLabel fest.
  3. Geben Sie im Feld „Beschreibung“ Text für dieses TextLabel ein.
  4. Umschließen Sie das TextLabel mit einem LabelOperation-Objekt und senden Sie es an LabelService.MutateLabels.

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

Sie können die IDs mit einer GoogleAdsService Search oder SearchStream Anfrage 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 beispielsweise einer Kampagne Labels zuweisen möchten, übergeben Sie ein 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. Umschließen Sie sie mit einem CampaignLabelOperation-Objekt mit der Operation create und senden Sie sie an CampaignService.MutateCampaignLabels.

Mehreren Kampagnen ein Label hinzufügen

Hier ein Codebeispiel, in dem gezeigt wird, 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());
    }
  }
}
      

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

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: 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)
      

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

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

curl

Kunden Labels zuweisen

Das Zuweisen von Labels zu einem Kunden ist eine häufige Aufgabe für Verwaltungskonten, um ihre Kundenkonten zu kategorisieren. Dies erfolgt mit CustomerLabelService.

Jedes CustomerLabelOperation enthält eine CustomerLabel-Instanz. Beachten Sie beim Erstellen einer neuen Beziehung Folgendes:

  • label: Dieses Feld ist erforderlich und muss der Ressourcenname eines Labels sein, das dem Verwaltungskonto gehört, z. B. customers/{MANAGER_ID}/labels/{LABEL_ID}.
  • customer: Dieses Feld ist nur für die Ausgabe bestimmt und sollte nicht in der Anfrage festgelegt werden. Der Kunde, der mit einem Label versehen wird, wird durch die customer_id im Pfad MutateCustomerLabelsRequest bestimmt.

Objekte anhand ihrer Labels abrufen

Nachdem Sie Ihren Kampagnen Labels zugewiesen haben, können Sie die Label Felder verwenden, um Objekte anhand ihrer ID abzurufen.

Ü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 Label-ID, nicht nach Label-Name filtern. So rufen Sie die Label-ID anhand eines Label-Namens ab:

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 unter 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 Objekt CustomerClient an. Dieses Feld ruft nur die Labels ab, die dem Kunden gehören, der den API-Aufruf ausführt.

Labels in Berichten verwenden

Mit Labels können Sie die Nützlichkeit Ihrer Berichte verbessern.

Berichte zu Labels

Die Berichtsressource „Label“ enthält Details zu den Labels , die in einem Konto definiert sind. Zu den Details gehören der Name, die ID, der Ressourcenname, der Status, die Hintergrundfarbe und die Beschreibung sowie die Kunden ressource, die den Inhaber des Labels darstellt.

Berichte mit Messwerten

Die Berichtsansichten „Anzeigengruppe“ und „Kampagne“ enthalten das labels Feld. Der Berichtsdienst gibt die Ressourcennamen der Labels 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

Mit jeder der folgenden Berichtsressourcen können Sie Beziehungen zwischen Ressourcen und Labels finden:

Sie können diese Berichtergebnisse 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.

In diesem Beispiel können Sie 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