Aktualizacje przy użyciu masek pól

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

Pomocnik maski pola

Zalecany sposób generowania masek pól to użycie funkcji pomocniczej field_mask zawartej w pakiecie google.api_core. Przyjmuje 2 obiekty protobuf i zwraca obiekt maski pola z listą paths, która zawiera wszystkie pola, które różnią się między tymi 2 obiektami.

Jeśli jako pierwszy parametr zostanie przekazany znak None, lista masek pól będzie zawierać wszystkie pola drugiego obiektu protobuf, które nie mają wartości domyślnej.

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

Aktualizacja na podstawie nowego obiektu lokalnego

W tym przykładzie tworzysz pusty obiekt CampaignOperation i pobierasz pusty obiekt Campaign z pola update. Następnie modyfikujesz ten obiekt kampanii i tworzysz nową maskę pola, porównując ją z None, co generuje maskę pola zawierającą zmodyfikowane pole network_settings.target_search_network:

from google.ads.googleads.client import GoogleAdsClient
from google.api_core import protobuf_helpers

# 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 and set its resource
# name.
campaign = campaign_operation.update
campaign.resource_name = client.get_service("CampaignService").campaign_path(
    customer_id, campaign_id
)

# Mutate the campaign (use direct attribute assignment in proto-plus).
campaign.network_settings.target_search_network = False

# Create a field mask using the updated campaign.
# The field_mask helper is compatible with raw protobuf message instances,
# which you 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)

Aktualizowanie istniejącego zasobu

W tym przykładzie aktualizujemy istniejącą kampanię pobraną z interfejsu API, zakładając, że mamy prawidłowe wartości resource_name i customer_id. W przypadku tej strategii updated_campaign udostępnia wszystkie pola pobrane w initial_campaign (w tym resource_name), a wygenerowana maska pola informuje interfejs API, że zmieniło się tylko pole network_settings.target_search_network:

from google.ads.googleads.client import GoogleAdsClient
from google.api_core import protobuf_helpers

# 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 the campaign. Quote string literals in GAQL.
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.
initial_campaign = None
for batch in response:
    for row in batch.results:
        initial_campaign = row.campaign
        break

if not initial_campaign:
    raise ValueError(f"Campaign '{resource_name}' not found.")

# 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.
# client.copy_from works with both native protobuf messages and messages
# wrapped by the proto-plus library.
client.copy_from(updated_campaign, initial_campaign)

# Mutate the new campaign.
updated_campaign.network_settings.target_search_network = False

# Create a field mask by comparing initial and updated protobuf objects.
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 works with both native messages
# and messages wrapped by proto-plus, including google.protobuf.field_mask_pb2.
client.copy_from(campaign_operation.update_mask, field_mask)

Wyczyść pola lub ustaw puste wiadomości

Podczas porównywania z wartością None narzędzie field_mask ignoruje pola ustawione na wartości puste lub domyślne. Aby jawnie wyczyścić pole lub ustawić puste pole wiadomości, dołącz ścieżkę pola bezpośrednio do campaign_operation.update_mask.paths. Więcej informacji znajdziesz w artykule Ustawianie pustych obiektów wiadomości jako pól.