ফিল্ড মাস্ক

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

ফিল্ডমাস্ক ইউটিল

ফিল্ড মাস্ক তৈরি করার প্রস্তাবিত উপায় হল আমাদের অন্তর্নির্মিত ফিল্ড মাস্ক ইউটিলিটি ব্যবহার করা, যা আপনাকে স্ক্র্যাচ থেকে তৈরি করার পরিবর্তে একটি পরিবর্তিত বস্তু থেকে ফিল্ড মাস্ক তৈরি করতে দেয়।

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

// Creates a Campaign object with the proper resource name and any other changes.
Campaign campaign =
    Campaign.newBuilder()
        .setResourceName(ResourceNames.campaign(customerId, campaignId))
        .setStatus(CampaignStatus.PAUSED)
        .build();

// Constructs an operation that will update the campaign, using the FieldMasks'
// allSetFieldsOf utility to derive the update mask. This mask tells the Google
// Ads API which attributes of the campaign you want to change.
CampaignOperation operation =
    CampaignOperation.newBuilder()
        .setUpdate(campaign)
        .setUpdateMask(FieldMasks.allSetFieldsOf(campaign))
        .build();

// Sends the operation in a mutate request.
MutateCampaignsResponse response =
    campaignServiceClient.mutateCampaigns(
        customerId.toString(), Collections.singletonList(operation));

এই উদাহরণটি প্রথমে একটি খালি Campaign অবজেক্ট তৈরি করে এবং তারপরে এর রিসোর্সের নাম সেট করে যাতে API জানতে পারে কোন প্রচারাভিযান আপডেট করা হচ্ছে।

উদাহরণটি প্রচারে FieldMasks.allSetFieldsOf() পদ্ধতিটি স্বয়ংক্রিয়ভাবে একটি ফিল্ড মাস্ক তৈরি করতে ব্যবহার করে যা সমস্ত সেট ক্ষেত্র গণনা করে। তারপরে আপনি ফিরে আসা মাস্কটি সরাসরি আপডেট কলে পাস করতে পারেন।

আপনি যদি কয়েকটি ক্ষেত্র আপডেট করার জন্য একটি বিদ্যমান বস্তুর সাথে কাজ করতে চান তবে আপনি নিম্নলিখিত কোডটি সংশোধন করতে পারেন:

Campaign existingCampaign;

// Obtains existingCampaign from elsewhere.
...

// Creates a new campaign based off the existing campaign and updates the
// campaign by setting its status to paused.
Campaign campaignToUpdate =
    existingCampaign.toBuilder()
        .setStatus(CampaignStatus.PAUSED)
        .build();

// Constructs an operation that will update the campaign, using the FieldMasks'
// compare utility to derive the update mask. This mask tells the Google Ads API
// which attributes of the campaign you want to change.
CampaignOperation operation =
    CampaignOperation.newBuilder()
        .setUpdate(campaignToUpdate)
        .setUpdateMask(FieldMasks.compare(existingCampaign, campaignToUpdate))
        .build();

// Sends the operation in a mutate request.
MutateCampaignsResponse response =
    campaignServiceClient.mutateCampaigns(
        customerId.toString(), Collections.singletonList(operation));

স্ক্র্যাচ থেকে একটি ফিল্ড মাস্ক তৈরি করতে, আপনি প্রথমে একটি FieldMask অবজেক্ট তৈরি করবেন, তারপর অবজেক্টে পরিবর্তন করতে চান এমন প্রতিটি ক্ষেত্রের নাম যোগ করুন।

FieldMask fieldMask =
    FieldMask.newBuilder()
        .addPaths("status")
        .addPaths("name")
        .build();

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

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

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

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

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

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

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

এই ক্ষেত্রে, FieldMaskUtil-এর 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 campaign = Campaign.newBuilder()
    .setResourceName(ResourceNames.campaign(customerId, campaignId))
    .setMaximizeConversions(MaximizeConversions.newBuilder().build())
    .build();

// 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 operation =
    CampaignOperation.newBuilder()
        .setUpdate(campaign)
        .setUpdateMask(FieldMasks.allSetFieldsOf(campaign))
        .build();

// 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.
MutateCampaignsResponse response =
    campaignServiceClient.mutateCampaigns(
        customerId.toString(), Collections.singletonList(operation));

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

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

// Creates a Campaign object with the proper resource name.
Campaign campaign = Campaign.newBuilder()
    .setResourceName(ResourceNames.campaign(customerId, campaignId))
    .build();

// 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 fieldMask = FieldMasks.allSetFieldsOf(campaign)
    .toBuilder()
    // 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
    .addPaths("maximize_conversions.target_cpa_micros")
    .build();

// Creates an operation to update the campaign with the specified fields.
CampaignOperation operation =
    CampaignOperation.newBuilder()
        .setUpdate(campaign)
        .setUpdateMask(fieldMask)
        .build();

ক্লিয়ারিং ফিল্ড

কিছু ক্ষেত্র স্পষ্টভাবে সাফ করা যেতে পারে। উপরের উদাহরণের মতো, আপনাকে অবশ্যই এই ক্ষেত্রগুলিকে ফিল্ড মাস্কে স্পষ্টভাবে যুক্ত করতে হবে। উদাহরণস্বরূপ, ধরে নিন আপনার একটি প্রচারাভিযান রয়েছে যা একটি 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 campaign =
    Campaign.newBuilder()
        .setResourceName(ResourceNames.campaign(customerId, campaignId))
        .setMaximizeConversions(
            MaximizeConversions.newBuilder().setTargetCpa(0).build())
        .setStatus(CampaignStatus.PAUSED)
        .build();

// 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 =
    CampaignOperation.newBuilder()
        .setUpdate(campaign)
        .setUpdateMask(FieldMasks.allSetFieldsOf(campaign))
        .build();

// 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 =
    campaignServiceClient.mutateCampaigns(
        customerId.toString(), Collections.singletonList(operation));

পরবর্তী উদাহরণ দেখায় কিভাবে MaximizeConversions বিডিং কৌশলে target_cpa_micros ফিল্ডটি সঠিকভাবে সাফ করা যায়।

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

// Creates a Campaign object with the proper resource name.
Campaign campaign = Campaign.newBuilder()
    .setResourceName(ResourceNames.campaign(customerId, campaignId))
    .build();

// 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)
    .toBuilder()
    .addPaths("maximize_conversions.target_cpa_micros")
    .build();

// Creates an operation to update the campaign with the specified field.
CampaignOperation operation =
    CampaignOperation.newBuilder()
        .setUpdate(campaign)
        .setUpdateMask(fieldMask))
        .build();

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

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