Atualizações usando máscaras de campo

Na API Google Ads, as atualizações são feitas usando uma máscara de campo. A máscara de campo lista todos os campos que você pretende mudar com a atualização. Os campos especificados que não estiverem na máscara de campo serão ignorados, mesmo que sejam enviados ao servidor.

Assistente de máscara de campo

A maneira recomendada de gerar máscaras de campo é usar a função auxiliar field_mask incluída no pacote google.api_core. Ele aceita dois objetos protobuf e retorna um objeto de máscara de campo com um campo list que contém todos os campos diferentes entre os dois objetos.

Se None for transmitido como o primeiro parâmetro, a lista de máscara de campo vai conter apenas todos os campos no segundo objeto protobuf que não estiverem definidos como o valor padrão.

Depois de criado, o objeto de máscara de campo precisa ser copiado para o objeto de operação que será enviado ao servidor:

Confira um exemplo de atualização de uma campanha:

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)

Primeiro, criamos um objeto CampaignOperation vazio. Em seguida, definimos a recuperação de um objeto de campanha vazio. Em seguida, atualizamos esse objeto de campanha e criamos uma nova máscara de campo, comparando-a com None, que vai gerar uma lista de máscaras de campo que contém apenas o campo network_settings.target_search_network que foi alterado.

Confira um exemplo de atualização de uma campanha. Aqui, presumimos que o script tenha fornecido um parâmetro resource_name que seja um nome de recurso válido para uma campanha e um 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)

Com essa estratégia, o updated_campaign vai compartilhar todos os mesmos campos do initial_campaign que foi extraído da API, ou seja, o nome do recurso. A máscara de campo gerada vai informar à API que apenas o campo network_settings.target_search_network precisa ser alterado.