Google বিজ্ঞাপন API-এ, একটি ফিল্ড মাস্ক ব্যবহার করা হয় ফিল্ডের একটি তালিকা প্রদান করতে যেগুলি API অনুরোধের আপডেট করা উচিত। ফিল্ড মাস্কে নির্দিষ্ট করা নেই এমন যেকোনো ক্ষেত্র উপেক্ষা করা হবে, এমনকি সার্ভারে পাঠানো হলেও।
FieldMaskUtil ক্লাস
ফিল্ড মাস্ক তৈরি করার প্রস্তাবিত উপায় হল অন্তর্নির্মিত FieldMaskUtil
ক্লাস ব্যবহার করা, যা আপনাকে স্ক্র্যাচ থেকে তৈরি করার পরিবর্তে একটি পরিবর্তিত বস্তু থেকে ফিল্ড মাস্ক তৈরি করতে দেয়।
এখানে একটি প্রচারাভিযান আপডেট করার একটি উদাহরণ দেওয়া হল, যেটি ফিল্ড মাস্ক তৈরি করতে FieldMasks.AllSetFieldsOf
পদ্ধতি ব্যবহার করে যা সমস্ত সেট ক্ষেত্র গণনা করে। তারপরে আপনি জেনারেট করা ফিল্ড মাস্কটি সরাসরি আপডেট কলে পাস করতে পারেন।
// Update campaign by setting its status to paused, and "Search network" to false.
Campaign campaignToUpdate = new Campaign()
{
ResourceName = ResourceNames.Campaign(customerId, campaignId),
Status = CampaignStatus.Paused,
NetworkSettings = new NetworkSettings()
{
TargetSearchNetwork = false
}
};
// Create the operation.
CampaignOperation operation = new CampaignOperation()
{
Update = campaignToUpdate,
UpdateMask = FieldMasks.AllSetFieldsOf(campaignToUpdate)
};
// Update the campaign.
MutateCampaignsResponse response = campaignService.MutateCampaigns(
customerId.ToString(), new CampaignOperation[] { operation });
কখনও কখনও, আপনাকে একটি বিদ্যমান বস্তুর সাথে কাজ করতে হবে এবং কয়েকটি ক্ষেত্র আপডেট করতে হবে। এই ধরনের ক্ষেত্রে, আপনি পরিবর্তে FieldMasks.FromChanges
পদ্ধতি ব্যবহার করার জন্য কোডটি পরিবর্তন করতে চান। এই পদ্ধতিটি একটি ফিল্ড মাস্ক তৈরি করে যা দুটি বস্তুর মধ্যে পার্থক্য উপস্থাপন করে।
Campaign existingCampaign;
// Obtain existingCampaign from elsewhere.
...
// Create a new campaign based off the existing campaign for update.
Campaign campaignToUpdate = new Campaign(existingCampaign);
// Update campaign by setting its status to paused, and "Search network" to
// false.
campaignToUpdate.Status = CampaignStatus.Paused;
campaignToUpdate.NetworkSettings = new NetworkSettings()
{
TargetSearchNetwork = false
}
// Create the operation.
CampaignOperation operation = new CampaignOperation()
{
Update = campaignToUpdate,
UpdateMask = FieldMasks.FromChanges(existingCampaign, campaignToUpdate)
};
FieldMaskError.FIELD_HAS_SUBFIELDS
ত্রুটিগুলি কীভাবে পরিচালনা করবেন
বিরল অনুষ্ঠানে, আপনাকে সেই ধরনের উপ-ক্ষেত্র আপডেট না করেই একটি ক্ষেত্র সেট করতে হতে পারে। নিম্নলিখিত উদাহরণ বিবেচনা করুন:
// Creates a campaign with the proper resource name and an empty
// MaximizeConversions field.
Campaign campaign = new Campaign()
{
ResourceName = ResourceNames.Campaign(customerId, campaignId),
MaximizeConversions = new MaximizeConversions()
};
CampaignOperation operation = new CampaignOperation()
{
Update = campaign,
UpdateMask = FieldMasks.AllSetFieldsOf(campaign)
};
MutateCampaignsResponse response = campaignService.MutateCampaigns(
customerId.ToString(), new CampaignOperation[] { operation });
এই API কল একটি FieldMaskError.FIELD_HAS_SUBFIELDS
ত্রুটির সাথে ব্যর্থ হবে৷ যেহেতু MaximizeConversions
তিনটি সাব-ফিল্ড রয়েছে, তাই Google Ads API সার্ভার অনুরোধে সেই ফিল্ডগুলির জন্য ফিল্ড মাস্কগুলি উপস্থিত থাকবে বলে আশা করে৷ যাইহোক, FieldMaskUtil
এই পরিস্থিতিতে সঠিকভাবে ফিল্ড মাস্ক তৈরি করতে পারে না, যেহেতু অনুরোধ এই ক্ষেত্রগুলি সেট করছে না।
এই ধরনের ক্ষেত্রে, আপনি ম্যানুয়ালি ফিল্ড মাস্কটি নিম্নরূপ সম্পাদনা করতে পারেন:
// Creates a Campaign object with the proper resource name.
Campaign campaign = new Campaign()
{
ResourceName = ResourceNames.Campaign(customerId, campaignId),
};
FieldMask 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.Paths.AddRange(new string[] {
"maximize_conversions.target_cpa_micros",
});
// Creates an operation to update the campaign with the specified fields.
CampaignOperation operation = new CampaignOperation()
{
Update = campaign,
UpdateMask = fieldMask
};
ক্ষেত্রগুলি কীভাবে সাফ করবেন
Google Ads API কিছু ফিল্ড মান সাফ করতে সমর্থন করে। একটি ক্ষেত্র সাফ করতে, আপনাকে অবশ্যই সেই ক্ষেত্রের জন্য ক্ষেত্র মাস্ক ম্যানুয়ালি সেট করতে হবে। একটি ক্ষেত্রকে তার ডিফল্ট মান (যেমন int64 ক্ষেত্রের জন্য শূন্য) সেট করা ক্ষেত্রটি সাফ করবে না।
নিম্নলিখিত কোডের উদাহরণটি দেখায় কিভাবে MaximizeConversions
বিডিং কৌশলের target_cpa_micros
ফিল্ড সাফ করতে হয়।
সঠিক কোড
নিচের কোডটি target_cpa_micros
ফিল্ড সাফ করে কারণ আমরা ফিল্ড মাস্কে maximize_conversions.target_cpa_micros
সেট করছি এবং campaign.MaximizeConversions.TargetCpaMicros
সেট করছি না।MaximizeConversions.TargetCpaMicros ফিল্ড।
// Creates a Campaign object with the proper resource name.
Campaign campaign = new Campaign()
{
ResourceName = ResourceNames.Campaign(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 fieldMask = FieldMasks.AllSetFieldsOf(campaign);
fieldMask.Paths.AddRange(new string[] {
"maximize_conversions.target_cpa_micros",
});
// Creates an operation to update the campaign with the specified field.
CampaignOperation operation = new CampaignOperation()
{
Update = campaign,
UpdateMask = fieldMask
};
ভুল কোড
নিম্নলিখিত কোড target_cpa_micros
ক্ষেত্রটি সাফ করে না , যেহেতু আমরা এই ক্ষেত্রটি শূন্যে সেট করছি। FieldMaskUtils
এবং Google Ads API সার্ভার উভয়ই এই মানটিকে উপেক্ষা করবে। উপরন্তু, আপনি এই ক্ষেত্রে একটি ত্রুটি নাও পেতে পারেন, যেহেতু মানটি সার্ভার দ্বারা উপেক্ষা করা হয়েছে৷
// Creates a campaign with the proper resource name and a MaximizeConversions
// object. Attempt to clear the target_cpa_micros field by setting it to 0.
Campaign campaign = new Campaign()
{
ResourceName = ResourceNames.Campaign(customerId, campaignId),
MaximizeConversions = new MaximizeConversions()
{
TargetCpaMicros = 0
}
};
// 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 operation = new CampaignOperation()
{
Update = campaign,
UpdateMask = 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.
MutateCampaignsResponse response = campaignService.MutateCampaigns(
customerId.ToString(), new CampaignOperation[] { operation });