Définir des objets de message vides en tant que champs

Dans l'API Google Ads, certains champs de message sont utilisés pour indiquer un choix de stratégie d'enchères pour une campagne. Il peut s'agir de :

Pour mettre à jour un champ primitif tel que campaign.name, définissez-le directement :

campaign.name = "Test campaign value"

Pour mettre à jour un message imbriqué avec des sous-champs définissables, comme campaign.manual_cpc lors de l'activation du CPC optimisé, définissez-le comme suit :

campaign.manual_cpc.enhanced_cpc_enabled = True

Définir des messages réellement vides

Pour utiliser une stratégie d'enchères comme manual_cpm, qui est un message vide :

  1. Obtenez une instance vide du type de message (ManualCpm).
  2. Utilisez client.copy_from pour attribuer cette instance vide au champ de la campagne.
  3. Ajoutez manuellement le nom du champ (manual_cpm) à update_mask sur CampaignOperation. L'outil d'aide pour le masque de champ ne peut pas détecter automatiquement qu'un message vide a été défini de manière explicite.
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. Manually add "manual_cpm" to the update_mask.
from google.api_core.protobuf_helpers import field_mask
campaign_operation = client.get_type('CampaignOperation')
campaign_operation.update = campaign
campaign_operation.update_mask = field_mask(None, campaign)
campaign_operation.update_mask.paths.append("manual_cpm")

# The resulting proto sent to the API will include:
# manual_cpm {
# }

Définir des messages avec des sous-champs facultatifs

Pour utiliser manual_cpc comme stratégie d'enchères sans activer enhanced_cpc_enabled, vous pouvez essayer une approche semblable à ManualCpm. Toutefois, comme ManualCpc comporte des sous-champs, l'ajout de manual_cpc à update_mask génère une erreur FieldMaskError.FIELD_HAS_SUBFIELDS. L'API exige plus de précision lorsqu'un message dans le masque comporte des sous-champs.

Pour définir correctement campaign.manual_cpc tout en vous assurant que enhanced_cpc_enabled reste non défini :

  1. Instanciez un objet ManualCpc vide et attribuez-le à campaign.manual_cpc.
  2. Ajoutez manuellement le chemin d'accès à chaque sous-champ mutable de ManualCpc à update_mask sur CampaignOperation. Dans ce cas, le sous-champ concerné est enhanced_cpc_enabled.
client = GoogleAdsClient.load_from_storage()
# Assume 'campaign' is an existing Campaign object you are updating.

# 1. Instantiate and assign an empty ManualCpc
campaign.manual_cpc = client.get_type('ManualCpc')

# 2. Manually add the subfield path to the update_mask.
from google.api_core.protobuf_helpers import field_mask
campaign_operation = client.get_type('CampaignOperation')
campaign_operation.update = campaign
campaign_operation.update_mask = field_mask(None, 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.

Lorsque vous envoyez des requêtes à l'aide de ces modèles, vous pouvez vérifier la charge utile en activant la journalisation et en inspectant la requête.