Aktualisierungen mit Feldmasken

In der Google Ads API werden Aktualisierungen mithilfe einer Feldmaske vorgenommen. Die Feldmaske listet alle Felder, die Sie mit der Aktualisierung ändern möchten, sowie alle angegebenen Felder die nicht in der Feldmaske enthalten sind, werden ignoriert, auch wenn sie an den Server gesendet werden.

Hilfsprogramm für Feldmasken

Die empfohlene Methode zum Generieren von Feldmasken ist die Verwendung des Helpers field_mask im Paket google.api_core enthalten. Zwei Protokollzwischenspeicher -Objekt und gibt ein Feldmaskenobjekt mit dem Feld list zurück, das alle der Felder, die sich zwischen den beiden Objekten unterscheiden.

Wenn None als erster Parameter übergeben wird, gilt in der Liste der Feldmasken nur alle Felder im zweiten protobuf-Objekt enthalten, die nicht auf auf ihren Standardwert.

Nach der Erstellung sollte das Feldmaskenobjekt in den Vorgang kopiert werden. , das an den Server gesendet wird:

Hier ein Beispiel für die Aktualisierung einer Kampagne:

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)

Zunächst erstellen wir ein leeres CampaignOperation-Objekt. Dann setzen wir Folgendes: ein leeres Campaign-Objekt aus. Anschließend aktualisieren wir dieses Kampagnenobjekt und erstellen Eine neue Feldmaske. Sie wird mit None verglichen, wodurch eine Feldmaskenliste generiert wird. die nur das Feld network_settings.target_search_network enthält, geändert.

Hier sehen Sie ein Beispiel, mit dem eine bestehende Kampagne aktualisiert wird. Hier nehmen wir an, dass das Skript resource_name-Parameter angegeben, der ein gültiger Ressourcenname Kampagne und eine gültige 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)

Bei dieser Strategie teilt updated_campaign dieselben Felder wie das initial_campaign, der von der API abgerufen wurde, nämlich der Ressourcenname. Die generierte Feldmaske teilt der API mit, dass nur die Das Feld „network_settings.target_search_network“ muss geändert werden.