Labels

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

In diesem Leitfaden werden die folgenden Aufgaben behandelt:

Der Schwerpunkt dieses Leitfadens liegt auf Kampagnen. Gruppen, Anzeigen und Keywords. Die API bietet auch CustomerLabelService mit Verwaltungskonten, um untergeordneten Konten Labels zuzuweisen.

Anwendungsfälle

Typische Szenarien für die Verwendung labels beinhalten Folgendes:

  • Ihr Konto enthält Kampagnen, die Sie nur zu bestimmten Jahreszeiten aktivieren. Diese Kampagnen lassen sich in Berichte ein- oder ausschließen.
  • Sie haben Ihrer Anzeigengruppe neue Keywords hinzugefügt und möchten sie vergleichen. ihre Statistiken anderen Keywords in der Anzeigengruppe zuordnen.
  • Die Nutzer Ihres Google Ads-Kontos verwalten einen Teil der Kampagnen und Sie möchten, die Kampagnen für jeden Nutzer zu identifizieren.
  • 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. Verpacken Sie TextLabel mit einem LabelOperation und senden Sie es an LabelService.MutateLabels

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

Sie können auch eine LabelService.GetLabel-Anfrage verwenden oder GoogleAdsService Search oder SearchStream-Anfrage zum Abrufen der IDs.

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 einer Kampagne beispielsweise Labels zuweisen möchten, übergeben Sie ein oder mehrere CampaignLabelOperation bis CampaignLabelService.MutateCampaignLabels Jede CampaignLabelOperation enthält ein CampaignLabel-Instanz, die Folgendes enthält: Felder:

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

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

Mehreren Kampagnen ein Label hinzufügen

Dieses Codebeispiel zeigt, wie Sie ein Kampagnenlabel zu einer Liste mit Kampagnen:

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

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

Objekte anhand ihrer Labels abrufen

Nachdem Sie Ihren Kampagnen Labels zugewiesen haben, können Sie das Label Felder, um Objekte nach ID abzurufen.

Übergeben Sie eine entsprechende GAQL-Abfrage an eine GoogleAdsService Search oder SearchStream Die folgende Abfrage gibt beispielsweise die ID, den Namen und die Labels für jede Kampagne, die einer der folgenden 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 der Label-ID filtern, nicht nach dem Labelnamen. Label-ID abrufen mithilfe eines Labelnamens erstellt haben, können Sie folgende Abfrage verwenden:

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

Labels abrufen, die auf einen Kunden angewendet wurden

Beim Abrufen der Hierarchie der Konten unter einem Verwaltungskonto Konto erhalten, können Sie Liste der Labels, die auf ein untergeordnetes Kundenkonto angewendet werden, indem Sie das applied_labels aus der Objekt CustomerClient. Dieses Feld ruft nur die Labels, die dem Kunden gehören, der den API-Aufruf durchführt.

Labels in Berichten verwenden

Labelberichte

In der Berichtsressource Label werden Details zu den Labels zurückgegeben. in einem Konto definiert ist. Zu den Details gehören Name, ID, Ressourcenname, Status Hintergrundfarbe und Beschreibung sowie der Feld Customer Ressource, die den Inhaber des Labels darstellt.

Berichte mit Messwerten

Bericht zu Anzeigengruppen und Kampagnen Ansichten enthalten das Feld labels. Der Berichtsdienst gibt das Label zurück, Ressourcennamen im Format customers/{customer_id}/labels/{label_id}. Für Beispiel: Der Ressourcenname customers/123456789/labels/012345 bezieht sich auf den 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:

Sie können die obigen Berichtsergebnisse filtern, indem Sie das Feld label.id vergleichen. Verwenden Sie dazu Beliebiger numerischer Vergleichsoperator oder BETWEEN, IS NULL, IS NOT NULL, IN oder NOT IN.

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