Mises à jour concernant l'utilisation des masques de champ

Dans l'API Google Ads, les mises à jour sont effectuées à l'aide d'un masque de champ. Le masque de champ répertorie tous les champs que vous souhaitez modifier avec la mise à jour. Tous les champs spécifiés qui ne figurent pas dans le masque de champ sont ignorés, même s'ils sont envoyés au serveur.

Outil d'aide pour les masques de champ

La méthode recommandée pour générer des masques de champ consiste à utiliser la fonction d'assistance field_mask incluse dans le package google.api_core. Elle accepte deux objets Protobuf et renvoie un objet de masque de champ avec un champ list contenant tous les champs différents entre les deux objets.

Si None est transmis en tant que premier paramètre, la liste des masques de champ ne contiendra que tous les champs du deuxième objet protobuf qui ne sont pas définis sur leur valeur par défaut.

Une fois créé, l'objet masque de champ doit être copié sur l'objet d'opération qui sera envoyé au serveur:

Voici un exemple de mise à jour d'une campagne:

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)

Commençons par créer un objet CampaignOperation vide. Ensuite, nous allons récupérer un objet Campaign vide. Nous mettons ensuite à jour cet objet de campagne et créons un masque de champ en le comparant à None, ce qui génère une liste de masques de champ ne contenant que le champ network_settings.target_search_network modifié.

Voici un exemple de mise à jour d'une campagne existante. Ici, nous partons du principe que le script a reçu un paramètre resource_name correspondant à un nom de ressource valide pour une campagne et à un customer_id valide:

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)

Avec cette stratégie, updated_campaign partage les mêmes champs que le initial_campaign récupéré à partir de l'API, à savoir le nom de la ressource. Le masque de champ généré indique à l'API que seul le champ network_settings.target_search_network doit être modifié.