עדכונים באמצעות מסכות שדה

ב-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 שאוחזר מה-API, כלומר שם המשאב. מסכת השדות שנוצרה תודיע ל-API שצריך לשנות רק את השדה network_settings.target_search_network.