在 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
會共用
從 API 擷取的 initial_campaign
,也就是資源名稱。
產生的欄位遮罩會向 API 指出
「network_settings.target_search_network
」欄位需要變更。