به روز رسانی با استفاده از فیلد ماسک

در Google Ads API، به روز رسانی ها با استفاده از یک فیلد ماسک انجام می شود. فیلد ماسک تمام فیلدهایی را که می‌خواهید با به‌روزرسانی تغییر دهید فهرست می‌کند و هر فیلد مشخص شده که در فیلد ماسک نیست نادیده گرفته می‌شود، حتی اگر به سرور ارسال شود.

کمک کننده ماسک میدانی

روش پیشنهادی برای تولید ماسک‌های فیلد استفاده از تابع helper field_mask موجود در بسته google.api_core است. دو شیء protobuf را می پذیرد و یک شیء ماسک فیلد را با یک فیلد list برمی گرداند که شامل تمام فیلدهایی است که بین دو شیء متفاوت است.

اگر None به‌عنوان پارامتر اول ارسال شود، فهرست فیلد ماسک فقط شامل تمام فیلدهای روی دومین شی protobuf است که روی مقدار پیش‌فرض تنظیم نشده‌اند.

پس از ساخته شدن، شیء فیلد ماسک باید بر روی شی عملیاتی که به سرور ارسال می شود کپی شود:

در اینجا یک مثال برای به روز رسانی یک کمپین آورده شده است:

from google.api_core import protobuf_helpers
from google.ads.googleads.client import GoogleAdsClient

# Retrieve a GoogleAdsClient instance.
client = GoogleAdsClient.load_from_storage()
# Create a new campaign operation.
campaign_operation = client.get_type('CampaignOperation')
# Retrieve a new campaign object from its update field.
campaign = campaign_operation.update
# Mutate the campaign.
campaign.network_settings.target_search_network.value = False

# Create a field mask using the updated campaign.
# The field_mask helper is only compatible with raw protobuf message
# instances, which we can access using the ._pb attribute.
field_mask = protobuf_helpers.field_mask(None, campaign._pb)

# Copy the field_mask onto the operation's update_mask field.
client.copy_from(campaign_operation.update_mask, field_mask)

ابتدا یک شی CampaignOperation خالی ایجاد می کنیم. سپس، یک شیء خالی Campaign را از آن بازیابی می کنیم. سپس آن شی کمپین را به‌روزرسانی می‌کنیم و یک فیلد ماسک جدید ایجاد می‌کنیم و آن را با None مقایسه می‌کنیم، که یک لیست ماسک فیلد ایجاد می‌کند که فقط حاوی فیلد network_settings.target_search_network است که تغییر کرده است.

در اینجا نمونه ای از به روز رسانی یک کمپین موجود است. در اینجا فرض می کنیم که اسکریپت یک پارامتر resource_name ارائه شده است که یک نام منبع معتبر برای یک کمپین و یک customer_id معتبر است:

import proto

from google.api_core import protobuf_helpers
from google.ads.googleads.client import GoogleAdsClient

# Retrieve a GoogleAdsClient instance.
client = GoogleAdsClient.load_from_storage()
# Retrieve an instance of the GoogleAdsService.
googleads_service = client.get_service('GoogleAdsService')

# Search query to retrieve campaign.
query = f"""
    SELECT
      campaign.network_settings.target_search_network,
      campaign.resource_name
    FROM campaign
    WHERE campaign.resource_name = {resource_name}"""

# Submit a query to retrieve a campaign instance.
response = googleads_service.search_stream(customer_id=customer_id, query=query)

# Iterate over results to retrieve the campaign.
for batch in response:
    for row in batch.results:
        initial_campaign = row.campaign

# Create a new campaign operation.
campaign_operation = client.get_type('CampaignOperation')
# Set the copied campaign object to a variable for easy reference.
updated_campaign = campaign_operation.update
# Copy the retrieved campaign into the new campaign.
# Here we use the proto.Message.copy_from method because of its simple
# compatibility with the protobuf message instances, which are wrapped
# by the proto-plus library.
proto.Message.copy_from(updated_campaign, initial_campaign)
# Mutate the new campaign.
updated_campaign.network_settings.target_search_network = False

# Create a field mask using the updated campaign.
field_mask = protobuf_helpers.field_mask(
    initial_campaign._pb, updated_campaign._pb
)

# Copy the field mask onto the operation's update_mask field.
# Note that the client's copy_from  method is designed to work with both native
# messages and messages wrapped by proto-plus, so it works here for the
# update_mask, even though it's an instance of the native message class
# google.protobuf.field_mask_pb2.FieldMask.
client.copy_from(campaign_operation.update_mask, field_mask)

با استفاده از این استراتژی، updated_campaign همه فیلدهای مشابهی که از API initial_campaign شده است، یعنی نام منبع را به اشتراک خواهد گذاشت. فیلد ماسک ایجاد شده به API می گوید که فقط فیلد network_settings.target_search_network باید تغییر کند.