Actualizaciones con máscaras de campo

En la API de Google Ads, las actualizaciones se realizan mediante una máscara de campo. La máscara de campo enumera todos los campos que deseas cambiar con la actualización y cualquier campo especificado que no esté en la máscara de campo se ignorará, incluso si se envía al servidor.

Asistente de máscara de campo

La forma recomendada de generar máscaras de campo es usar la función auxiliar field_mask incluida en el paquete google.api_core. Acepta dos objetos protobuf y muestra un objeto de máscara de campo con un campo list que contiene todos los campos que son diferentes entre los dos objetos.

Si se pasa None como el primer parámetro, la lista de máscaras de campo solo contendrá todos los campos del segundo objeto protobuf que no estén configurados en su valor predeterminado.

Una vez construido, el objeto de máscara de campo debe copiarse en el objeto de la operación que se enviará al servidor:

A continuación, le mostramos un ejemplo de cómo actualizar una campaña:

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)

Primero, creamos un objeto CampaignOperation vacío. Luego, configuramos la recuperación de un objeto Campaign vacío a partir de ella. Luego, actualizamos ese objeto de campaña y creamos una máscara de campo nueva, que la compara con None, que generará una lista de máscaras de campo que solo contiene el campo network_settings.target_search_network que se modificó.

A continuación, presentamos un ejemplo de actualización de una campaña existente. Aquí suponemos que se le proporcionó a la secuencia de comandos un parámetro resource_name que es un nombre de recurso válido para una campaña y un customer_id válido:

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)

Con esta estrategia, updated_campaign compartirá los mismos campos que initial_campaign que se recuperó de la API, es decir, el nombre del recurso. La máscara de campo generada le indicará a la API que solo se debe cambiar el campo network_settings.target_search_network.