Alan maskelerini kullanarak güncelleme

Google Ads API'de güncellemeler alan maskesi kullanılarak yapılır. Alan maskesi, güncelleme ile değiştirmeyi planladığınız tüm alanları listeler. Alan maskesinde olmayan belirtilen alanlar, sunucuya gönderilse bile yoksayılır.

Alan maskesi yardımcısı

Alan maskeleri oluşturmak için önerilen yöntem, field_mask paketinde bulunan google.api_core yardımcı işlevini kullanmaktır. İki protobuf nesnesini kabul eder ve iki nesne arasında farklı olan tüm alanları içeren bir paths listesiyle alan maskesi nesnesi döndürür.

None ilk parametre olarak iletilirse alan maskesi listesi, ikinci protobuf nesnesindeki varsayılan değerine ayarlanmamış tüm alanları içerir.

Oluşturulduktan sonra alan maskesi nesnesi, sunucuya gönderilecek işlem nesnesine kopyalanmalıdır.

Yeni bir yerel nesneden güncelleme

Aşağıdaki örnekte, boş bir CampaignOperation nesnesi oluşturup update alanından boş bir Campaign nesnesi alıyorsunuz. Ardından, bu kampanya nesnesini değiştirir ve None ile karşılaştırarak yeni bir alan maskesi oluşturursunuz. Bu işlem, değiştirilmiş network_settings.target_search_network alanını içeren bir alan maskesi oluşturur:

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)

Mevcut bir kaynağı güncelleme

Aşağıdaki örnekte, geçerli bir resource_name ve customer_id olduğu varsayılarak API'den alınan mevcut bir kampanya güncellenmektedir. Bu stratejiyle, updated_campaign, initial_campaign üzerinde alınan tüm alanları (resource_name dahil) paylaşır ve oluşturulan alan maskesi, API'ye yalnızca network_settings.target_search_network alanının değiştiğini bildirir:

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)

Alanları temizleme veya boş mesajlar ayarlama

None ile karşılaştırıldığında field_mask yardımcı programı, boş veya varsayılan değerlere ayarlanmış alanları yoksayar. Bir alanı açıkça temizlemek veya boş bir mesaj alanı ayarlamak için alan yolunu doğrudan campaign_operation.update_mask.paths öğesine ekleyin. Daha fazla bilgi için Boş mesaj nesnelerini alan olarak ayarlama başlıklı makaleyi inceleyin.