ফিল্ড মাস্ক

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

আপনি আমাদের অন্তর্নির্মিত ফিল্ড মাস্ক ইউটিলিটি ( FieldMasks ) ব্যবহার করতে পারেন, যা অনেক নির্দিষ্ট বিবরণ লুকিয়ে রাখে এবং সত্তার ক্ষেত্রে আপনার করা পরিবর্তনগুলি পর্যবেক্ষণ করে স্বয়ংক্রিয়ভাবে ফিল্ড মাস্ক তৈরি করতে দেয়।

একটি প্রচারাভিযান আপডেট করার জন্য এখানে একটি উদাহরণ:

    $campaign = new Campaign([
        'resource_name' => ResourceNames::forCampaign($customerId, $campaignId),
        'status' => CampaignStatus::PAUSED
    ]);

    $campaignOperation = new CampaignOperation();
    $campaignOperation->setUpdate($campaign);
    $campaignOperation->setUpdateMask(FieldMasks::allSetFieldsOf($campaign));

এই কোডটি প্রথমে একটি ক্যাম্পেইন অবজেক্ট তৈরি করে এবং তারপর ResourceNames ব্যবহার করে তার রিসোর্স নাম সেট করে, যাতে API জানতে পারে কোন প্রচারাভিযান আপডেট করা হচ্ছে। status PAUSED এ সেট করা আছে।

কোডটি তারপর একটি CampaignOperation অবজেক্ট তৈরি করে এবং এটিতে পূর্বে তৈরি করা প্রচারাভিযান সেট করে। এর পরে, এটি FieldMasks::allSetFieldsOf() ব্যবহার করে সমস্ত পরিবর্তিত ক্ষেত্রগুলি ব্যবহার করে প্রচারের জন্য একটি ফিল্ড মাস্ক তৈরি করে। অবশেষে, এটি প্রচারাভিযান অপারেশন অবজেক্টে ফিরে আসা মুখোশটি পাস করে।

মনে রাখবেন FieldMasks::allSetFieldsOf হল FieldMasks::compare() এর জন্য একটি সুবিধাজনক পদ্ধতি। এটি আপনার পাস করা বস্তুটিকে একই শ্রেণীর একটি খালি বস্তুর সাথে তুলনা করে। উদাহরণস্বরূপ, আগের কোডে, আপনি allSetFieldsOf() এর পরিবর্তে FieldMasks::compare(new Campaign(), $campaign) ব্যবহার করতে পারতেন।

বার্তা ক্ষেত্র এবং তাদের সাবফিল্ড আপডেট করা হচ্ছে

MESSAGE ক্ষেত্রের সাবফিল্ড থাকতে পারে (যেমন MaximizeConversions যার তিনটি আছে: target_cpa_micros , cpc_bid_ceiling_micros , এবং cpc_bid_floor_micros ), অথবা তাদের কোনোটিই থাকতে পারে না (যেমন ManualCpm )।

কোনো সংজ্ঞায়িত সাবফিল্ড ছাড়াই বার্তা ক্ষেত্র

কোনো সাবফিল্ডের সাথে সংজ্ঞায়িত নয় এমন একটি MESSAGE ক্ষেত্র আপডেট করার সময়, পূর্বে বর্ণিত হিসাবে একটি ফিল্ড মাস্ক তৈরি করতে FieldMasks ব্যবহার করুন।

সংজ্ঞায়িত সাবফিল্ড সহ বার্তা ক্ষেত্র

একটি MESSAGE ক্ষেত্র আপডেট করার সময় যেটি সাবফিল্ডের সাথে সংজ্ঞায়িত করা হয়েছে সেই বার্তাটিতে স্পষ্টভাবে কোনো সাবফিল্ড সেট না করে, আপনাকে অবশ্যই ম্যানুয়ালি প্রতিটি পরিবর্তনযোগ্য MESSAGE সাবফিল্ড FieldMask যুক্ত করতে হবে, আগের উদাহরণের মতো যা স্ক্র্যাচ থেকে একটি ফিল্ড মাস্ক তৈরি করেছে৷

একটি সাধারণ উদাহরণ হল নতুন বিডিং কৌশলে কোনো ক্ষেত্র সেট না করেই একটি প্রচারাভিযানের বিডিং কৌশল আপডেট করা। নিচের কোডটি প্রদর্শন করে যে কিভাবে বিডিং কৌশলে কোনো সাবফিল্ড সেট না করে MaximizeConversions বিডিং কৌশল ব্যবহার করার জন্য একটি প্রচারাভিযান আপডেট করতে হয়।

এই ক্ষেত্রে, FieldMasks এর allSetFieldsOf() এবং compare() পদ্ধতি ব্যবহার করে লক্ষ্য অর্জন করা যায় না।

নিম্নলিখিত কোডটি একটি ফিল্ড মাস্ক তৈরি করে যাতে maximize_conversions অন্তর্ভুক্ত থাকে। যাইহোক, Google Ads API ভুলবশত ক্ষেত্রগুলি সাফ হওয়া রোধ করতে এই আচরণের অনুমতি দেয় না এবং একটি FieldMaskError.FIELD_HAS_SUBFIELDS ত্রুটি তৈরি করে।

সতর্কতা: নিম্নলিখিত কোডটি একটি ত্রুটি তৈরি করে।

// Creates a campaign with the proper resource name and an empty
// MaximizeConversions field.
$campaign = new Campaign([
    'resource_name' => ResourceNames::forCampaign($customerId, $campaignId),
    'maximize_conversions' => new MaximizeConversions()
]);

// Constructs an operation, using the FieldMasks' allSetFieldsOf utility to
// derive the update mask. The field mask will include 'maximize_conversions`,
// which will produce a FieldMaskError.FIELD_HAS_SUBFIELDS error.
$campaignOperation = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask(FieldMasks::allSetFieldsOf($campaign));

// Sends the operation in a mutate request that will result in a
// FieldMaskError.FIELD_HAS_SUBFIELDS error because empty MESSAGE fields cannot
// be included in a field mask.
$campaignServiceClient = $googleAdsClient->getCampaignServiceClient();
$response = $campaignServiceClient->mutateCampaigns($customerId, [$campaignOperation]);

নিম্নোক্ত কোডটি প্রদর্শন করে যে কীভাবে একটি প্রচারাভিযান সঠিকভাবে আপডেট করতে হয় তার কোনো সাবফিল্ড সেট না করেই MaximizeConversions বিডিং কৌশল ব্যবহার করতে।

সাফল্য: নীচের কোডটি সফলভাবে প্রচারাভিযান বিডিং কৌশল আপডেট করে।

// Creates a Campaign object with the proper resource name.
$campaign = new Campaign([
    'resource_name' => ResourceNames::forCampaign($customerId, $campaignId)
]);

// Creates a field mask from the existing campaign and adds all of the mutable
// fields (only one in this case) on the MaximizeConversions bidding strategy to
// the field mask. Because this field is included in the field mask but
// excluded from the campaign object, the Google Ads API will set the campaign's
// bidding strategy to a MaximizeConversions object without any of its subfields
// set.
fieldMask = FieldMasks::allSetFieldsOf($campaign);
// Only include 'maximize_conversions.target_cpa_micros' in the field mask
// as it is the only mutable subfield on MaximizeConversions when used as a
// standard bidding strategy.
//
// Learn more about standard and portfolio bidding strategies here:
// https://developers.google.com/google-ads/api/docs/campaigns/bidding/assign-strategies
$fieldMask->setPaths(array_merge(
    iterator_to_array($fieldMask->getPaths()->getIterator()),
    ['maximize_conversions.target_cpa_micros']
));

// Creates an operation to update the campaign with the specified fields.
$campaignOperation = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask($fieldMask);

ক্ষেত্র পরিষ্কার করা হচ্ছে

কিছু ক্ষেত্র স্পষ্টভাবে সাফ করা যেতে পারে। আগের উদাহরণের মতো, আপনাকে অবশ্যই এই ক্ষেত্রগুলিকে ফিল্ড মাস্কে স্পষ্টভাবে যুক্ত করতে হবে। উদাহরণ স্বরূপ, ধরে নিন আপনার একটি প্রচারাভিযান রয়েছে যা একটি MaximizeConversions বিডিং কৌশল ব্যবহার করে এবং target_cpa_micros ফিল্ডটি 0 এর বেশি মান দিয়ে সেট করা হয়েছে।

নিম্নলিখিত কোড রান; যাইহোক, maximize_conversions.target_cpa_micros ফিল্ড মাস্কে যোগ করা হবে না এবং তাই target_cpa_micros ফিল্ডে কোন পরিবর্তন করা হবে না:

সতর্কতা: এই কোডটি কোনো ত্রুটি তৈরি করে না, কিন্তু MaximizeConversions বিডিং কৌশলের target_cpa_micros সাফ করা হবে না।

// Creates a campaign with the proper resource name and a MaximizeConversions
// object with target_cpa_micros set to 0.
$campaign = new Campaign([
    'resource_name' => ResourceNames::forCampaign($customerId, $campaignId),
    'maximize_conversions' => new MaximizeConversions(['target_cpa' => 0]),
    'status' => CampaignStatus::PAUSED
]);

// Constructs an operation, using the FieldMasks' allSetFieldsOf utility to
// derive the update mask. However, the field mask will NOT include
// 'maximize_conversions.target_cpa_micros'.
$campaignOperation = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask(FieldMasks::allSetFieldsOf($campaign));

// Sends the operation in a mutate request that will succeed but will NOT update
// the 'target_cpa_micros' field because
// 'maximize_conversions.target_cpa_micros' was not included in the field mask.
$campaignServiceClient = $googleAdsClient->getCampaignServiceClient();
$response = $campaignServiceClient->mutateCampaigns($customerId, [$campaignOperation]);

MaximizeConversions বিডিং কৌশলে target_cpa_micros ফিল্ডটি কীভাবে সঠিকভাবে সাফ করা যায় তা নিম্নলিখিত কোডটি দেখায়।

সাফল্য: নিম্নলিখিত কোড target_cpa_micros সাফ করে।

// Creates a Campaign object with the proper resource name.
$campaign = new Campaign([
    'resource_name' => ResourceNames::forCampaign($customerId, $campaignId)
]);

// Constructs a field mask from the existing campaign and adds the
// 'maximize_conversions.target_cpa_micros' field to the field mask, which will
// clear this field from the bidding strategy without impacting any other fields
// on the bidding strategy.
$fieldMask = FieldMasks::allSetFieldsOf($campaign);
$fieldMask->setPaths(array_merge(
    iterator_to_array($fieldMask->getPaths()->getIterator()),
    ['maximize_conversions.target_cpa_micros']
));

// Creates an operation to update the campaign with the specified field.
$campaignOperation = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask($fieldMask);

মনে রাখবেন যে Google Ads API protocol buffers optional হিসাবে সংজ্ঞায়িত ক্ষেত্রগুলির জন্য "ভুল" কোডটি কাজ করে। কিন্তু যেহেতু target_cpa_micros একটি optional ক্ষেত্র নয়, তাই "ভুল" কোড target_cpa ক্ষেত্রটি সাফ করার জন্য বিডিং কৌশল আপডেট করে না ।

মূল পয়েন্ট: আপনার উদ্দেশ্য যদি একটি ক্ষেত্র পরিষ্কার করা হয়, তবে সবচেয়ে নিরাপদ উপায় হল সেই ক্ষেত্রটিকে স্পষ্টভাবে ফিল্ড মাস্কে যুক্ত করা।