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

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)

सबसे पहले, हम एक खाली Campaign Operations ऑब्जेक्ट बनाते हैं. फिर, हम उससे एक खाली कैंपेन ऑब्जेक्ट फिर से हासिल करना सेट करते हैं. इसके बाद, हम उस कैंपेन ऑब्जेक्ट को अपडेट करके, उसकी तुलना 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 फ़ील्ड को बदलने की ज़रूरत है.