Aktualisierungen mit Feldmasken

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

Hilfe zu Feldmasken

Wir empfehlen, Feldmasken mithilfe der Hilfsfunktion field_mask zu generieren, die im Paket google.api_core enthalten ist. Es akzeptiert zwei Protobuf-Objekte und gibt ein Feldmaskenobjekt mit einem list-Feld zurück, das alle Felder enthält, die sich zwischen den beiden Objekten unterscheiden.

Wenn None als erster Parameter übergeben wird, enthält die Liste der Feldmasken nur alle Felder im zweiten Protobuf-Objekt, die nicht auf ihren Standardwert festgelegt sind.

Das Feldmaskenobjekt sollte nach dem Erstellen in das Vorgangsobjekt 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)

Zuerst erstellen wir ein leeres CampaignOperation-Objekt. Anschließend wird ein leeres Kampagnenobjekt abgerufen. Wir aktualisieren dann dieses Kampagnenobjekt und erstellen eine neue Feldmaske, die wir mit None vergleichen. Dadurch wird eine Feldmaskenliste generiert, die nur das geänderte Feld network_settings.target_search_network enthält.

Hier sehen Sie ein Beispiel für die Aktualisierung einer bestehenden Kampagne. Hier gehen wir davon aus, dass dem Script ein resource_name-Parameter mit einem gültigen Ressourcennamen für eine Kampagne und einem gültigen customer_id übergeben wurde:

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 hat die updated_campaign dieselben Felder wie die initial_campaign, die aus der API abgerufen wurde, nämlich den Ressourcennamen. Die generierte Feldmaske teilt der API mit, dass nur das Feld network_settings.target_search_network geändert werden muss.