برچسب‌ها

برچسب‌ها به شما امکان می‌دهند پویش‌ها، گروه‌های آگهی، آگهی‌ها، و کلیدواژه‌هایتان را دسته‌بندی کنید و از آن دسته‌ها برای ساده کردن گردش کارتان به روش‌های مختلف استفاده کنید.

این راهنما مراحل لازم برای انجام کارهای زیر را پوشش می‌دهد:

  • برچسب‌ها را به‌صورت برنامه‌نویسی‌شده بااستفاده از LabelService ایجاد کنید.
  • بااستفاده از درخواست‌های CampaignLabelService، برچسب‌ها را به پویش‌هایتان اختصاص دهید.
  • بازیابی و فیلتر کردن نتایج گزارش براساس برچسب بااستفاده از پُرسمان‌های GoogleAdsService.

این راهنما بر پویش‌ها تمرکز دارد، اما می‌توانید از همین رویکرد برای گروه‌های آگهی، آگهی‌ها، و کلیدواژه‌ها استفاده کنید. این میانای برنامه‌سازی کاربردی همچنین CustomerLabelService را ارائه می‌دهد که به حساب‌های مدیر امکان می‌دهد برچسب‌ها را به حساب‌های فرزند اختصاص دهند.

موارد استفاده

سناریوهای معمول برای استفاده از برچسب‌ها شامل موارد زیر است:

  • حسابتان کمپین‌هایی دارد که فقط در زمان‌های خاصی از سال فعال می‌کنید، و می‌خواهید آن کمپین‌ها را در گزارش‌ها لحاظ کنید یا از آن‌ها کنار بگذارید.
  • مجموعه جدیدی از کلیدواژه‌ها را به گروه آگهی‌تان اضافه کرده‌اید و می‌خواهید آمار آن‌ها را با کلیدواژه‌های دیگر در گروه آگهی‌تان مقایسه کنید.
  • کاربران حساب Google Ads شما هرکدام زیرمجموعه‌ای از کمپین‌ها را مدیریت می‌کنند و شما می‌خواهید راهی برای شناسایی مجموعه کمپین‌ها برای هر کاربر داشته باشید.
  • برنامه‌تان باید وضعیت اشیای خاصی را علامت‌گذاری کند.

ایجاد برچسب

برچسب‌ها را بااستفاده از شیء Label با فیلد text_label آن ایجاد کنید:

  1. نمونه TextLabel حاوی رنگ پس‌زمینه و شرح ایجاد کنید.
  2. نمونه Label ایجاد کنید و TextLabel را به فیلد text_label آن اختصاص دهید.
  3. Label را در LabelOperation (create) بپیچید و آن را به LabelService.MutateLabels ارسال کنید.

شناسه برچسب ایجادشده را برای پُرسمان‌های بعدی یادداشت کنید. شناسه در فیلد resource_name در MutateLabelResult که در MutateLabelsResponse برگردانده شده است جاسازی شده است.

همچنین می‌توانید از درخواست GoogleAdsService Search یا SearchStream برای بازیابی شناسه‌های برچسب و نام منابع استفاده کنید.

اختصاص دادن برچسب‌ها

می‌توانید بااستفاده از عملیات Mutate در سرویس مربوطه، به پویش‌ها، مشتریان، گروه‌های آگهی، معیارها، یا آگهی‌هایتان برچسب اختصاص دهید.

برای مثال، برای اختصاص دادن برچسب به پویش، یک یا چند شیء CampaignLabelOperation را به CampaignLabelService.MutateCampaignLabels منتقل کنید. هر CampaignLabelOperation شامل یک نمونه CampaignLabel است که به نام‌های کامل منابع در این فیلدها نیاز دارد:

  • ‫label: نام منبع برچسب (برای مثال، customers/{customer_id}/labels/{label_id}).
  • campaign: نام منبع پویش (برای مثال، customers/{customer_id}/campaigns/{campaign_id}).

برای هر جفت برچسب-پویش، یک نمونه CampaignLabel ایجاد کنید. آن را در CampaignLabelOperation با عملیات create بپیچید و به CampaignLabelService.MutateCampaignLabels ارسال کنید.

افزودن برچسب‌های پویش

در اینجا نمونه کدی آورده شده است که نحوه افزودن برچسب پویش به فهرستی از پویش‌ها را نشان می‌دهد:

جاوا

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.V26.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

پرل

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

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

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

اختصاص دادن برچسب به مشتریان

اختصاص برچسب به مشتری وظیفه رایجی برای حساب‌های مدیر است تا حساب‌های کارخواه خود را دسته‌بندی کنند. این کار بااستفاده از CustomerLabelService انجام می‌شود. برچسب‌های ایجادشده توسط حساب مدیر تحت مالکیت آن حساب مدیر است و فقط زمانی قابل‌مشاهده است که به‌عنوان حساب مدیر مالک اصالت‌سنجی شده باشد.

هر CustomerLabelOperation شامل یک نمونه CustomerLabel است. هنگام ایجاد رابطه مشتری-برچسب، موارد زیر را به‌خاطر داشته باشید:

  • label: این فیلد الزامی است و باید نام منبع برچسبی باشد که متعلق به حساب مدیر است، مانند customers/{MANAGER_ID}/labels/{LABEL_ID}.
  • ‫customer: این فیلد فقط خروجی است و نباید در درخواست تنظیم شود. مشتری‌ای که برچسب‌گذاری می‌شود توسط customer_id در مسیر MutateCustomerLabelsRequest تعیین می‌شود.

بازیابی اشیا بااستفاده از برچسب‌های آن‌ها

پس‌از اختصاص دادن برچسب به پویش‌هایتان، می‌توانید از فیلدهای برچسب برای بازیابی اشیاء براساس شناسه استفاده کنید.

یک پُرسمان 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"

بازیابی برچسب‌های اعمال‌شده به مشتری

هنگام دریافت سلسله‌مراتب حساب‌ها تحت یک حساب مدیر، می‌توانید فهرست برچسب‌های اعمال‌شده به یک حساب مشتری فرزند را با درخواست فیلد applied_labels از شیء CustomerClient بازیابی کنید. این فیلد فقط برچسب‌های متعلق به مشتری را که تماس با میانای برنامه‌سازی کاربردی برقرار می‌کند بازیابی می‌کند.

استفاده از برچسب‌ها در گزارش‌ها

از برچسب‌ها برای بهبود سودمندی گزارش‌هایتان استفاده کنید.

گزارش‌دهی برچسب‌ها

منبع گزارش برچسب جزئیات مربوط به برچسب‌های تعریف‌شده در حساب را برمی‌گرداند. جزئیات شامل نام، شناسه، نام منبع، وضعیت، رنگ پس‌زمینه، و شرح، و همچنین منبع مشتری است که مالک برچسب را نشان می‌دهد.

گزارش‌های دارای سنجه

نماهای گزارش گروه آگهی و پویش شامل فیلد 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
قبلی
سنجه‌های صفر
بعدی
پخش جریانی