การอัปเดตโดยใช้มาสก์ฟิลด์

ใน Google Ads API การอัปเดตจะทำโดยใช้มาสก์ฟิลด์ Field Mask จะแสดง ฟิลด์ทั้งหมดที่คุณต้องการเปลี่ยนแปลงด้วยการอัปเดต และระบบจะ ละเว้นฟิลด์ที่ระบุซึ่งไม่ได้อยู่ใน Field Mask แม้ว่าจะส่งไปยังเซิร์ฟเวอร์ก็ตาม

เครื่องมือช่วยสร้างฟิลด์มาสก์

วิธีที่แนะนำในการสร้างมาสก์ของฟิลด์คือการใช้ฟังก์ชันตัวช่วย field_mask ที่รวมอยู่ในแพ็กเกจ google.api_core โดยจะรับออบเจ็กต์ protobuf 2 รายการและแสดงผลออบเจ็กต์ FieldMask ที่มีฟิลด์ list ซึ่งมีฟิลด์ทั้งหมดที่แตกต่างกันระหว่างออบเจ็กต์ทั้ง 2 รายการ

หากส่ง None เป็นพารามิเตอร์แรก รายการมาสก์ฟิลด์จะมีเฉพาะฟิลด์ทั้งหมดในออบเจ็กต์ Protobuf ที่ 2 ซึ่งไม่ได้ตั้งค่าเป็นค่าเริ่มต้น

เมื่อสร้างแล้ว ควรก๊อปปี้ออบเจ็กต์ฟิลด์มาสก์ไปยังออบเจ็กต์การดำเนินการ ที่จะส่งไปยังเซิร์ฟเวอร์

ตัวอย่างการอัปเดตแคมเปญมีดังนี้

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