Aggiornamenti utilizzando le maschere di campo

Nell'API Google Ads, gli aggiornamenti vengono eseguiti utilizzando una maschera dei campi. La maschera di campo elenca tutti i campi che intendi modificare con l'aggiornamento e qualsiasi campo specificato non presenti nella maschera del campo verranno ignorati, anche se inviati al server.

Assistente per la maschera di campo

Il modo consigliato per generare maschere dei campi è usare l'helper field_mask inclusa nel pacchetto google.api_core. Accetta due protobuf e restituisce un oggetto maschera di campo con un campo list che contiene tutti dei campi che sono diversi tra i due oggetti.

Se None viene passato come primo parametro, l'elenco delle maschere dei campi verrà Contengono tutti i campi del secondo oggetto protobuf che non sono impostati su il loro valore predefinito.

Una volta creato, l'oggetto della maschera del campo deve essere copiato nell'operazione che verrà inviato al server:

Di seguito è riportato un esempio di aggiornamento di una campagna:

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)

Per prima cosa, creiamo un oggetto CampaignOperation vuoto. Quindi impostiamo il metodo oggetto Campagna vuota. Aggiorniamo poi l'oggetto della campagna e creiamo una nuova maschera di campo, confrontandola con None, che genererà un elenco di maschere di campo che contiene solo il campo network_settings.target_search_network è cambiato.

Di seguito è riportato un esempio di aggiornamento di una campagna esistente. Supponiamo che lo script abbia è stato fornito un parametro resource_name che è un nome risorsa valido per campagna e un customer_id valido:

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 questa strategia, l'updated_campaign condividerà gli stessi campi del initial_campaign recuperato dall'API, ossia il nome della risorsa. La maschera del campo generato indicherà all'API che solo Il campo network_settings.target_search_network deve essere modificato.