Aktualizacje z użyciem masek pól

W interfejsie Google Ads API aktualizacje są wprowadzane przy użyciu maski pola. Maska pola zawiera listę wszystkich pól, które chcesz zmienić w ramach aktualizacji. Wszystkie określone pola, których nie ma w masce pola, będą ignorowane, nawet jeśli zostaną wysłane na serwer.

Pomocnik maski pola

Zalecanym sposobem generowania masek pól jest użycie funkcji pomocniczej field_mask zawartej w pakiecie google.api_core. Akceptuje 2 obiekty protobuf i zwraca obiekt maski pól z polem list, które zawiera wszystkie pola, które są różne w tych 2 obiektach.

Jeśli jako pierwszy parametr zostanie przekazany None, lista masek pól będzie zawierać po prostu wszystkie pola w drugim obiekcie protokołu, które nie mają wartości domyślnej.

Po utworzeniu obiektu maski pola należy skopiować do obiektu operacji, który zostanie wysłany na serwer:

Oto przykład aktualizacji kampanii:

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)

Najpierw tworzymy pusty obiekt CampaignOperation. Następnie ustawiamy pobranie z niego pustego obiektu kampanii. Następnie aktualizujemy ten obiekt kampanii i tworzymy nową maskę pola, porównując ją z tabelą None. W ten sposób wygenerujemy listę masek pól zawierającą tylko zmienione pole network_settings.target_search_network.

Oto przykład aktualizacji istniejącej kampanii. Przyjmujemy, że do skryptu został dostarczony parametr resource_name, który jest prawidłową nazwą zasobu kampanii i prawidłową wartością customer_id:

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)

Dzięki tej strategii updated_campaign będzie udostępniać wszystkie te same pola co initial_campaign pobrany z interfejsu API, czyli nazwę zasobu. Wygenerowana maska pola poinformuje interfejs API, że należy zmienić tylko pole network_settings.target_search_network.