फ़ील्ड मास्क का इस्तेमाल करके अपडेट करने की सुविधा

Google Ads API में, फ़ील्ड मास्क का इस्तेमाल करके अपडेट किए जाते हैं. फ़ील्ड मास्क सूचियां वे सभी फ़ील्ड जिन्हें आपको अपडेट के साथ बदलना है. साथ ही, तय किए गए वे फ़ील्ड भी शामिल करें जो फ़ील्ड मास्क में नहीं हैं उन्हें अनदेखा किया जाएगा, भले ही उन्हें सर्वर पर भेजा गया हो.

फ़ील्ड मास्क हेल्पर

फ़ील्ड मास्क जनरेट करने का सुझाया गया तरीका, google.api_core पैकेज में शामिल field_mask हेल्पर फ़ंक्शन का इस्तेमाल करना है. यह दो प्रोटोबुक ऑब्जेक्ट स्वीकार करता है और list फ़ील्ड वाला फ़ील्ड मास्क ऑब्जेक्ट दिखाता है. इस फ़ील्ड में, उन सभी फ़ील्ड की जानकारी होती है जो दोनों ऑब्जेक्ट में अलग-अलग होते हैं.

अगर None को पहले पैरामीटर के तौर पर पास किया जाता है, तो फ़ील्ड मास्क की सूची बस दूसरे प्रोटोबफ़ ऑब्जेक्ट पर वे सभी फ़ील्ड शामिल होते हैं जो डिफ़ॉल्ट वैल्यू न हो.

फ़ील्ड मास्क ऑब्जेक्ट बनाने के बाद, उसे ऑपरेशन ऑब्जेक्ट पर कॉपी किया जाना चाहिए. इस ऑब्जेक्ट को सर्वर पर भेजा जाएगा:

कैंपेन को अपडेट करने का उदाहरण यहां दिया गया है:

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)

सबसे पहले, हम एक खाली CampaignOperation ऑब्जेक्ट बनाते हैं. इसके बाद, हमने उससे खाली कैंपेन ऑब्जेक्ट को फिर से पाने के लिए सेट किया. इसके बाद, हम उस कैंपेन ऑब्जेक्ट को अपडेट करते हैं और None से तुलना करके, एक नया फ़ील्ड मास्क बनाते हैं. इससे फ़ील्ड मास्क की एक सूची जनरेट होगी, जिसमें सिर्फ़ वह network_settings.target_search_network फ़ील्ड शामिल होगा जिसे बदला गया था.

यहां मौजूदा कैंपेन को अपडेट करने का एक उदाहरण दिया गया है. यहां हम मानते हैं कि स्क्रिप्ट में resource_name पैरामीटर दिया गया है, जो किसी कैंपेन के लिए मान्य संसाधन का नाम है और एक मान्य 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)

इस रणनीति के तहत, updated_campaign वही सभी फ़ील्ड शेयर करेगा जो एपीआई से मिले initial_campaign से मिले थे. जैसे, संसाधन का नाम. जनरेट किया गया फ़ील्ड मास्क, एपीआई को यह जानकारी देगा कि सिर्फ़ network_settings.target_search_network फ़ील्ड को बदलने की ज़रूरत है.