在 Google Ads API 中,某些消息字段用于指明 Campaign 的出价策略选择。
这些模型可以是:
- 真正为空的消息:例如,
campaign.manual_cpm没有已定义的子字段。 - 包含可选字段的消息:例如,
campaign.manual_cpc具有可选的子字段enhanced_cpc_enabled。
请注意,Campaign 上的出价策略字段属于 bidding_strategy oneof 群组。设置新的出价策略(例如 manual_cpm 或 manual_cpc)会隐式清除相应 oneof 组中之前配置的所有出价策略。
如需更新 campaign.name 等基本字段,请直接设置:
campaign.name = "Test campaign value"
如需更新具有可设置子字段的嵌套消息(例如启用智能点击付费功能时),请按如下方式进行设置:campaign.manual_cpc
campaign.manual_cpc.enhanced_cpc_enabled = True
设置真正空白的消息
使用出价策略(例如 manual_cpm,这是一个空消息):
- 获取消息类型 (
ManualCpm) 的空实例。 - 使用
client.copy_from将此空实例分配给广告系列的字段。 - 手动将字段名称 (
manual_cpm) 添加到CampaignOperation的update_mask中。字段掩码帮助程序无法自动检测到已明确设置空消息。
from google.ads.googleads import util
from google.ads.googleads.client import GoogleAdsClient
from google.api_core.protobuf_helpers import field_mask
client = GoogleAdsClient.load_from_storage()
# Assume 'campaign' is an existing Campaign object you are updating.
# 1. Get an empty ManualCpm type.
empty_cpm = client.get_type("ManualCpm")
# 2. Copy it to the campaign's manual_cpm field.
client.copy_from(campaign.manual_cpm, empty_cpm)
# 3. Create the operation and manually add "manual_cpm" to the update_mask.
campaign_operation = client.get_type("CampaignOperation")
client.copy_from(campaign_operation.update, campaign)
client.copy_from(
campaign_operation.update_mask,
field_mask(None, util.convert_proto_plus_to_protobuf(campaign)),
)
campaign_operation.update_mask.paths.append("manual_cpm")
# The resulting proto sent to the API will include:
# manual_cpm {
# }
设置包含可选子字段的消息
如需使用 manual_cpc 作为出价策略,而不启用 enhanced_cpc_enabled,您可以尝试类似于 ManualCpm 的方法。不过,由于 ManualCpc 具有子字段,因此向 update_mask 添加 manual_cpc 会导致 FieldMaskError.FIELD_HAS_SUBFIELDS 错误。如果掩码中的消息包含子字段,则该 API 需要更具体的信息。
如需正确设置 campaign.manual_cpc,同时确保 enhanced_cpc_enabled 保持未设置状态,请执行以下操作:
- 实例化一个空的
ManualCpc对象,并使用client.copy_from将其复制到campaign.manual_cpc中。 - 手动将
ManualCpc的每个可变子字段的路径添加到CampaignOperation上的update_mask。在这种情况下,相关子字段为enhanced_cpc_enabled。
from google.ads.googleads import util
from google.ads.googleads.client import GoogleAdsClient
from google.api_core.protobuf_helpers import field_mask
client = GoogleAdsClient.load_from_storage()
# Assume 'campaign' is an existing Campaign object you are updating.
# 1. Copy an empty ManualCpc object into campaign.manual_cpc.
client.copy_from(campaign.manual_cpc, client.get_type("ManualCpc"))
# 2. Manually add the subfield path to the update_mask.
campaign_operation = client.get_type("CampaignOperation")
client.copy_from(campaign_operation.update, campaign)
client.copy_from(
campaign_operation.update_mask,
field_mask(None, util.convert_proto_plus_to_protobuf(campaign)),
)
# For ManualCpc, because it has subfields, you must specify the subfield
# path in the update_mask. This tells the API you are updating something
# within manual_cpc. By not setting enhanced_cpc_enabled on the campaign
# object, it defaults to false.
campaign_operation.update_mask.paths.append("manual_cpc.enhanced_cpc_enabled")
# The update_mask paths will include: ['manual_cpc.enhanced_cpc_enabled']
# This correctly signals to the API that ManualCpc is the chosen strategy,
# with enhanced_cpc_enabled in its default state.
使用这些模式发送请求时,您可以通过启用日志记录并检查请求来验证载荷。