ফিল্ড মাস্ক

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

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

ক্যাম্পেন আপডেট করার একটি উদাহরণ এখানে দেওয়া হল:

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

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

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

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

মনে রাখবেন যে FieldMasks::allSetFieldsOf() হল FieldMasks::compare()-এর জন্য একটি সুবিধাজনক পদ্ধতি। এটি আপনার পাস করা অবজেক্টকে একই ক্লাসের একটি খালি অবজেক্টের সাথে তুলনা করে। যেমন, আগের কোডে, আপনি FieldMasks::allSetFieldsOf($campaign)-এর পরিবর্তে 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 includes 'maximize_conversions',
// which produces 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 results in a
// FieldMaskError.FIELD_HAS_SUBFIELDS error because empty MESSAGE fields cannot
// be included in a field mask.
$campaignServiceClient = $googleAdsClient->getCampaignServiceClient();
$response = $campaignServiceClient->mutateCampaigns(
    MutateCampaignsRequest::build($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 the mutable
// subfield 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 sets 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:
// https://developers.google.com/google-ads/api/docs/campaigns/bidding/assign-strategies
$fieldMask->getPaths()[] = '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);

ফিল্ডে থাকা কন্টেন্ট মুছে দিন

কিছু ফিল্ড স্পষ্টভাবে মুছে ফেলা যেতে পারে। আগের উদাহরণের মতো, আপনাকে অবশ্যই স্পষ্টভাবে ফিল্ড মাস্কে এইসব ফিল্ড যোগ করতে হবে কারণ FieldMasks Proto3 স্কেলার ফিল্ডকে ডিফল্ট ভ্যালুতে সেট করে (যেমন 0, false, অথবা "")। উদাহরণস্বরূপ, ধরুন আপনার কাছে এমন একটি ক্যাম্পেন আছে যা 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_micros' => 0
    ]),
    'status' => CampaignStatusEnum\CampaignStatus::PAUSED
]);

// Constructs an operation, using the FieldMasks' allSetFieldsOf utility to
// derive the update mask. However, the field mask does 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 succeeds, but does 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(
    MutateCampaignsRequest::build($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
// clears this field from the bidding strategy without impacting any other
// fields on the bidding strategy.
$fieldMask = FieldMasks::allSetFieldsOf($campaign);
$fieldMask->getPaths()[] = '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 প্রোটোকল বাফারে optional হিসেবে সংজ্ঞায়িত ফিল্ডের জন্য উদ্দেশ্য অনুযায়ী কাজ করে। তবে, target_cpa_micros কোনও optional ফিল্ড না হওয়ার কারণে, ফিল্ড মাস্কে পাথ স্পষ্টভাবে যোগ না করে এটিকে 0-এ সেট করলে, target_cpa_micros মুছে ফেলার জন্য বিডিং স্ট্র্যাটেজি আপডেট হয় না।

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