使用欄位遮罩更新

在 Google Ads API 中，更新作業是透過欄位遮罩完成。欄位遮罩會列出您打算透過更新變更的所有欄位，即使傳送至伺服器，系統也會忽略欄位遮罩中未列出的任何指定欄位。

欄位遮罩輔助工具

建議使用 google.api_core 套件中隨附的 field_mask 輔助函式產生欄位遮罩。這個函式會接受兩個 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 欄位。