Labels

Mit Labels können Sie Ihre Kampagnen, Anzeigengruppen, Anzeigen und Keywords kategorisieren und diese Kategorien auf verschiedene Weise zur Vereinfachung Ihres Workflows nutzen.

In diesem Leitfaden werden die folgenden Aufgaben behandelt:

In diesem Leitfaden geht es um Kampagnen. Sie können aber dieselbe Vorgehensweise für Anzeigengruppen, Anzeigen und Keywords anwenden. Diese API bietet auch CustomerLabelService, mit dem Verwaltungskonten Labels untergeordneten Konten zuweisen können.

Anwendungsfälle

Typische Szenarien für die Verwendung von Labels:

  • In Ihrem Konto gibt es 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 der Anzeigengruppe vergleichen.
  • Die Nutzer Ihres Google Ads-Kontos verwalten jeweils eine Teilmenge von Kampagnen und Sie möchten die Kampagnen für jeden Nutzer identifizieren.
  • In Ihrer App muss der Status bestimmter Objekte angegeben werden.

Labels erstellen

Erstellen Sie Labels mit einem Label-Objekt, dessen Feld text_label festgelegt ist:

  1. Erstellen Sie eine TextLabel-Instanz mit einer Hintergrundfarbe und einer Beschreibung.
  2. Erstellen Sie eine Label-Instanz und weisen Sie das TextLabel-Objekt dem Feld text_label zu.
  3. Packen Sie die Label in ein LabelOperation (create) und senden Sie es an LabelService.MutateLabels.

Notieren Sie sich die ID des erstellten Labels für spätere Anfragen. Die ID ist im Feld resource_name des MutateLabelResult enthalten, das im MutateLabelsResponse zurückgegeben wird.

Sie können auch eine GoogleAdsService-Anfrage Search oder SearchStream verwenden, um Label-IDs und Ressourcennamen abzurufen.

Labels zuweisen

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

Wenn Sie beispielsweise einer Kampagne Labels zuweisen möchten, übergeben Sie ein oder mehrere CampaignLabelOperation-Objekte an CampaignLabelService.MutateCampaignLabels. Jede CampaignLabelOperation enthält eine CampaignLabel-Instanz, für die in den folgenden Feldern vollständige Ressourcennamen erforderlich sind:

  • label: Der Ressourcenname eines Labels, z. B. customers/{customer_id}/labels/{label_id}.
  • campaign: Ressourcenname einer Kampagne (z. B. customers/{customer_id}/campaigns/{campaign_id}).

Erstellen Sie eine CampaignLabel-Instanz für jedes Label-Kampagnen-Paar. Verpacken Sie es in einem CampaignLabelOperation mit dem Vorgang create und senden Sie es an CampaignLabelService.MutateCampaignLabels.

Mehreren Kampagnen ein Label hinzufügen

Hier sehen Sie ein Codebeispiel, in dem 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.V25.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::V25::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::V25::Resources::CampaignLabel->new({
        campaign => Google::Ads::GoogleAds::V25::Utils::ResourceNames::campaign(
          $customer_id, $campaign_id
        ),
        label => $label_resource_name
      });

    # Create a campaign label operation.
    my $campaign_label_operation =
      Google::Ads::GoogleAds::V25::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 Kunden ist eine gängige Aufgabe für Verwaltungskonten, um ihre Kundenkonten zu kategorisieren. Dazu wird CustomerLabelService verwendet. Labels, die von einem Verwaltungskonto erstellt wurden, gehören diesem Verwaltungskonto und sind nur sichtbar, wenn Sie sich als Inhaber des Verwaltungskontos authentifizieren.

Jede CustomerLabelOperation enthält eine CustomerLabel-Instanz. Beachten Sie beim Erstellen einer Beziehung zwischen Kunde und Label 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 vorgesehen und sollte nicht in der Anfrage festgelegt werden. Der Kunde, der gekennzeichnet wird, wird durch die customer_id im MutateCustomerLabelsRequest-Pfad bestimmt.

Objekte anhand ihrer Labels abrufen

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

Übergeben Sie eine geeignete GAQL-Abfrage an eine GoogleAdsService-Search- oder SearchStream-Anfrage. Mit der folgenden Abfrage werden beispielsweise die ID, der Name und die Labels für jede Kampagne zurückgegeben, die einer der drei Label-IDs zugeordnet 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 Labelname filtern. Mit dieser Abfrage können Sie die Label-ID anhand eines Label-Namens 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, indem Sie das Feld applied_labels aus dem Objekt CustomerClient anfordern. In diesem Feld werden nur die Labels abgerufen, die dem Kunden gehören, der den API-Aufruf ausführt.

Labels in Berichten verwenden

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

Berichterstellung zu Labels

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 Customer-Ressource, die den Inhaber des Labels darstellt.

Berichte mit Messwerten

Die Berichtsansichten Anzeigengruppe und Kampagne enthalten das Feld labels. Der Berichterstellungsdienst 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 jeder der folgenden Berichtsressourcen lassen sich Beziehungen zwischen Ressourcen und Labels ermitteln:

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

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