ফিল্ড মাস্ক ব্যবহার করে আপডেট

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 মতো একই ক্ষেত্র শেয়ার করবে যা API থেকে পুনরুদ্ধার করা হয়েছিল, যথা সম্পদের নাম। জেনারেট করা ফিল্ড মাস্ক API কে বলবে যে শুধুমাত্র network_settings.target_search_network ক্ষেত্র পরিবর্তন করতে হবে।