תוויות

תוויות מאפשרות לכם לסווג את הקמפיינים, קבוצות המודעות, המודעות ומילות המפתח, ולהשתמש בקטגוריות האלה כדי לפשט את תהליך העבודה במגוון דרכים.

במדריך הזה מפורטות הפעולות שצריך לבצע כדי:

• יצירת תוויות באופן פרוגרמטי באמצעות LabelService
• הקצאת תוויות לקמפיינים באמצעות CampaignLabelService בקשות.
• אחזור וסינון של תוצאות הדוח לפי תווית באמצעות GoogleAdsService שאילתות.

המדריך הזה מתמקד בקמפיינים, אבל אפשר להשתמש באותה גישה קבוצות, מודעות ומילות מפתח. שימו לב שה-API מספק גם CustomerLabelService, שמאפשר כדי להקצות תוויות לחשבונות צאצא.

תרחישים לדוגמה

תרחישים אופייניים לשימוש תוויות:

• בחשבון שלך יש קמפיינים שהפעלת רק בתקופות מסוימות בשנה, ורוצים לכלול בקלות את הקמפיינים האלה בדוחות, או להחריג אותם מהם.
• הוספתם קבוצה חדשה של מילות מפתח לקבוצת המודעות שלכם, ואתם רוצים להשוות את הנתונים הסטטיסטיים שלהן למילות מפתח אחרות בקבוצת המודעות שלך.
• המשתמשים בחשבון Google Ads מנהלים כל קבוצת משנה של קמפיינים, ואתם רוצים דרך לזיהוי קבוצת הקמפיינים של כל משתמש.
• האפליקציה שלך צריכה לסמן את הסטטוס של אובייקטים מסוימים.

יצירת תוויות

יוצרים תוויות באמצעות האובייקט TextLabel:

1. יוצרים מכונה של TextLabel.
2. הגדרת צבע רקע בשביל TextLabel.
3. יש להזין טקסט עבור TextLabel באמצעות שדה התיאור.
4. אורזים את TextLabel בLabelOperation ושולחים אותו אל LabelService.MutateLabels.

חשוב לשים לב לתוויות החדשות מזהים לשאילתות במועד מאוחר יותר. המזהים מוטמעים השדה resource_name הפריט MutateLabelResults הוחזר ב MutateLabelsResponse.

אפשר גם להשתמש בבקשת LabelService.GetLabel או GoogleAdsService Search או SearchStream לאחזר את המזהים.

הקצאת תוויות

אפשר להקצות תוויות לקמפיינים, ללקוחות, לקבוצות של מודעות, לקריטריונים או למודעות. כדי להקצות תוויות צריך להשתמש בפעולה Mutate בשירות המתאים.

לדוגמה, כדי להקצות תווית לקמפיין, צריך להעביר לפחות תווית אחת CampaignLabelOperation עד CampaignLabelService.MutateCampaignLabels כל CampaignLabelOperation כולל מופע CampaignLabel, שכולל שדות:

• label: מזהה של תווית
• campaign: מזהה של קמפיין

יוצרים מופע של CampaignLabel לכל צמד של תווית-קמפיין. לעטוף אותו CampaignLabelOperation עם הפעולה create ושולחים אותו אל CampaignService.MutateCampaignLabels.

הוספת תוויות של קמפיין

הנה דוגמה לקוד שמראה איך להוסיף תווית קמפיין לרשימה של קמפיינים:

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
      

אחזור אובייקטים באמצעות התוויות שלהם

אחרי שמקצים תוויות לקמפיינים, אפשר להשתמש בתווית כדי לאחזר אובייקטים לפי מזהה.

העברה של שאילתת GAQL מתאימה GoogleAdsService Search או SearchStream בקשה. לדוגמה, השאילתה הבאה מחזירה את המזהה, השם והתוויות של כל קמפיין המשויך לאחד משלושת מזהי התוויות:

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

הערה: אפשר לסנן רק לפי מזהה תווית, ולא לפי שם תווית. כדי למצוא את מזהה התווית משם של תווית, אפשר להשתמש בשאילתה הזו:

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

אחזור תוויות שהוחלו על לקוח

כשאתם מקבלים את היררכיית החשבונות במסגרת חשבון ניהול Google, אפשר לאחזר רשימת התוויות שהוחלו על חשבון צאצא של לקוח על ידי שליחת בקשה השדה applied_labels מתוך אובייקט CustomerClient. השדה הזה מאחזר רק את התוויות שבבעלות הלקוח שביצע את הקריאה ל-API.

שימוש בתוויות בדוחות

דיווח על תוויות

במקור המידע של הדוח תווית מוצגים פרטים על התוויות מוגדר בחשבון. הפרטים כוללים את השם, המזהה, שם המשאב, הסטטוס צבע רקע ותיאור, וכן לפי הלקוח משאב שמייצג את בעלי התווית.

דוחות עם מדדים

הדוח קבוצת מודעות וקמפיין תצוגות מכילות את השדה labels. שירות הדיווח מחזיר את התווית שמות המשאבים בפורמט customers/{customer_id}/labels/{label_id}. עבור לדוגמה, שם המשאב customers/123456789/labels/012345 מתייחס תווית עם המזהה 012345 בחשבון עם המזהה 123456789.

דוחות ללא מדדים

אפשר להשתמש בכל אחד מהמשאבים הבאים ליצירת דוחות כדי למצוא קשרים בין משאבים ותוויות:

• תווית המודעה בקבוצת המודעות
• תווית של קריטריון של קבוצת מודעות
• תווית קבוצת המודעות
• תווית הקמפיין
• תווית הלקוח

אפשר לסנן את תוצאות הדוח שלמעלה על ידי השוואה בין השדה label.id באמצעות כל אופרטור של השוואה מספרית או באמצעות הערכים BETWEEN, IS NULL, IS NOT NULL, האופרטורים IN או NOT IN.

לדוגמה, כך תציגו את כל הקמפיינים שיש להם מזהה תווית ספציפי:

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