Leere Nachrichtenobjekte als Felder festlegen

In der Google Ads API werden einige Nachrichtenfelder verwendet, um eine Auswahl an Gebotsstrategien für eine Campaign anzugeben. Beispiele:

Die Felder für die Gebotsstrategie in Campaign gehören zu einer bidding_strategy oneof-Gruppe. Wenn Sie eine neue Gebotsstrategie wie manual_cpm oder manual_cpc festlegen, wird jede zuvor konfigurierte Gebotsstrategie in dieser oneof-Gruppe implizit gelöscht.

Wenn Sie ein primitives Feld wie campaign.name aktualisieren möchten, legen Sie es direkt fest:

campaign.name = "Test campaign value"

Wenn Sie eine verschachtelte Nachricht mit festlegbaren Unterfeldern wie campaign.manual_cpc aktualisieren möchten, wenn der auto-optimierte CPC aktiviert wird, legen Sie sie so fest:

campaign.manual_cpc.enhanced_cpc_enabled = True

Vollständig leere Nachrichten festlegen

So verwenden Sie eine Gebotsstrategie wie manual_cpm, die eine leere Nachricht ist:

  1. Rufen Sie eine leere Instanz des Nachrichtentyps (ManualCpm) ab.
  2. Weisen Sie diese leere Instanz mit client.copy_from dem Feld der Kampagne zu.
  3. Fügen Sie den Feldnamen (manual_cpm) manuell der update_mask in der CampaignOperation hinzu. Der Feldmaskenhelfer kann nicht automatisch erkennen, dass eine leere Nachricht explizit festgelegt wurde.
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 {
# }

Nachrichten mit optionalen Unterfeldern festlegen

Wenn Sie manual_cpc als Gebotsstrategie verwenden möchten, ohne enhanced_cpc_enabled zu aktivieren, können Sie einen ähnlichen Ansatz wie bei ManualCpm verwenden. Da ManualCpc jedoch Unterfelder hat, führt das Hinzufügen von manual_cpc zu update_mask zu einem FieldMaskError.FIELD_HAS_SUBFIELDS-Fehler. Die API erfordert mehr Spezifität, wenn eine Nachricht in der Maske Unterfelder hat.

So legen Sie campaign.manual_cpc korrekt fest und stellen gleichzeitig sicher, dass enhanced_cpc_enabled nicht festgelegt bleibt:

  1. Instanziieren Sie ein leeres ManualCpc-Objekt und kopieren Sie es mit client.copy_from in campaign.manual_cpc.
  2. Fügen Sie den Pfad zu jedem änderbaren Unterfeld von ManualCpc manuell der update_mask in der CampaignOperation hinzu. In diesem Fall ist das relevante Unterfeld 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.

Wenn Sie Anfragen mit diesen Mustern senden, können Sie die Nutzlast überprüfen, indem Sie das Logging aktivieren und die Anfrage prüfen.