إشعارات باستخدام أقنعة الحقول

في Google Ads API، يتم إجراء التعديلات باستخدام قناع حقل. يسرد قناع الحقل وجميع الحقول التي تنوي تغييرها بعد التحديث، وأي حقول محدّدة فسيتم تجاهلها، حتى لو تم إرسالها إلى الخادم.

مساعد قناع الحقل

الطريقة المقترَحة لإنشاء أقنعة حقل هي استخدام مساعد 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 فارغ. بعد ذلك، نضبط استرداد ملف شخصي فارغ للحملة منه. ثم نعدِّل كائن الحملة وننشئ قناع حقل جديد، ومقارنته بـ 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 جميع الحقول نفسها مثل initial_campaign التي تم استردادها من واجهة برمجة التطبيقات، وتحديدًا اسم المورد. ويُعلم قناع الحقل الذي يتم إنشاؤه واجهة برمجة التطبيقات بأنه يجب تغيير حقل network_settings.target_search_network.