Alan Maskeleri Kullanılarak Güncellemeler

Google Ads API'de güncellemeler bir alan maskesi kullanılarak yapılır. Alan maskesi, güncellemeyle değiştirmek istediğiniz tüm alanları listeler. Alan maskesinde bulunmayan belirtilen alanlar, sunucuya gönderilmiş olsa bile yoksayılır.

Alan maskesi yardımcısı

Alan maskeleri oluşturmak için önerilen yöntem field_mask yardımcısını kullanmaktır işlevi google.api_core paketinde yer alıyor. İki protobuf nesnesi kabul eder ve iki nesne arasında farklı olan tüm alanları içeren bir list alanı içeren bir alan maskesi nesnesi döndürür.

İlk parametre olarak None iletilirse alan maskesi listesi, ikinci protobuf nesnesinde varsayılan değerlerine ayarlanmamış tüm alanları içerir.

Alan maskesi nesnesi oluşturulduktan sonra, sunucuya gönderilecek işlem nesnesine kopyalanmalıdır:

Aşağıda, bir kampanyayı güncellemeyle ilgili bir örnek verilmiştir:

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)

İlk olarak, boş bir CampaignOperation nesnesi oluştururuz. Daha sonra, Campaign nesnesini boş bırakın. Ardından bu kampanya nesnesini güncelleyip None ile karşılaştırarak yeni bir alan maskesi oluştururuz. Bu işlem, yalnızca değiştirilen network_settings.target_search_network alanını içeren bir alan maskesi listesi oluşturur.

Mevcut bir kampanyanın güncellenmesine ilişkin örnek aşağıda verilmiştir. Burada, komut dosyasına bir kampanya için geçerli bir kaynak adı olan resource_name parametresi ve geçerli bir customer_id sağlandığını varsayıyoruz:

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)

Bu stratejiyle updated_campaign, API'den alınan initial_campaign ile aynı alanları (ör. kaynak adı) paylaşır. Oluşturulan alan maskesi, API'ye yalnızca network_settings.target_search_network alanının değiştirilmesi gerektiğini bildirir.