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

Google Ads API-তে, ফিল্ড মাস্ক ব্যবহার করে আপডেট করা হয়। ফিল্ড মাস্ক, আপডেটের মাধ্যমে আপনি যেসব ফিল্ড পরিবর্তন করতে চান তার সবকটি তালিকাভুক্ত করে এবং ফিল্ড মাস্কে নেই এমন কোনও নির্দিষ্ট ফিল্ড সার্ভারে পাঠানো হলেও তা উপেক্ষা করা হয়।

ফিল্ড মাস্ক হেল্পার

ফিল্ড মাস্ক তৈরি করার জন্য সাজেস্ট করা পদ্ধতি হল google.api_core প্যাকেজে অন্তর্ভুক্ত field_mask হেল্পার ফাংশন ব্যবহার করা। এটি দুটি protobuf অবজেক্ট গ্রহণ করে এবং paths তালিকা সহ একটি ফিল্ড মাস্ক অবজেক্ট রিটার্ন করে, এই তালিকায় দুটি অবজেক্টের মধ্যে ভিন্ন সব ফিল্ড থাকে।

প্রথম প্যারামিটার হিসেবে None পাস করা হলে, ফিল্ড মাস্ক তালিকায় দ্বিতীয় protobuf অবজেক্টের সব ফিল্ড থাকে যেগুলি ডিফল্ট ভ্যালুতে সেট করা নেই।

তৈরি হয়ে গেলে, ফিল্ড মাস্ক অবজেক্টকে অপারেশন অবজেক্টে কপি করতে হবে যা সার্ভারে পাঠানো হবে।

নতুন স্থানীয় অবজেক্ট থেকে আপডেট করুন

নিচের উদাহরণে, আপনি একটি খালি CampaignOperation অবজেক্ট তৈরি করেন এবং এটির update ফিল্ড থেকে একটি খালি Campaign অবজেক্ট ফিরিয়ে আনেন। আপনি তারপরে সেই ক্যাম্পেন অবজেক্টটি পরিবর্তন করেন এবং সেটিকে None-এর সাথে তুলনা করে একটি নতুন ফিল্ড মাস্ক তৈরি করেন, যা পরিবর্তিত network_settings.target_search_network ফিল্ড সহ একটি ফিল্ড মাস্ক তৈরি করে:

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)

আগে থেকে থাকা রিসোর্স আপডেট করা

নিম্নলিখিত উদাহরণটি API থেকে পাওয়া আগে থেকে থাকা ক্যাম্পেন আপডেট করে, ধরে নেওয়া হচ্ছে যে resource_name এবং customer_id সঠিক। এই স্ট্র্যাটেজি অনুযায়ী, updated_campaign initial_campaign-এ পাওয়া সব ফিল্ড শেয়ার করে (এর resource_name সহ) এবং জেনারেট করা ফিল্ড মাস্ক API-কে জানায় যে শুধুমাত্র network_settings.target_search_network ফিল্ড পরিবর্তন করা হয়েছে:

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)

ফিল্ড মুছে দিন বা খালি মেসেজ সেট করুন

None-এর সাথে তুলনা করার সময়, field_mask হেল্পার খালি বা ডিফল্ট ভ্যালুতে সেট করা ফিল্ড উপেক্ষা করে। কোনও ফিল্ড স্পষ্টভাবে মুছে ফেলতে বা খালি মেসেজ ফিল্ড সেট করতে, ফিল্ড পাথ সরাসরি campaign_operation.update_mask.paths-এ যোগ করুন। আরও জানতে, ফিল্ড হিসেবে খালি মেসেজ অবজেক্ট সেট করুন দেখুন।