protobuf টাইপ নিয়ে কাজ করা

Google Ads API-এর ডিফল্ট পে-লোড ফর্ম্যাট হিসেবে proto3 ব্যবহার করা হয়, তাই .NET ক্লায়েন্ট লাইব্রেরির সাথে কাজ করার সময় কিছু প্রোটোকল বাফার কনভেনশন ও ধরন বোঝা গুরুত্বপূর্ণ।

ঐচ্ছিক ফিল্ড

Google Ads API-এর অনেক ফিল্ড optional হিসেবে চিহ্নিত করা আছে। এটি আপনাকে এমন কেসগুলির মধ্যে পার্থক্য করতে দেয় যেখানে ফিল্ডের একটি খালি মান থাকে বনাম যখন সার্ভার ফিল্ডের জন্য একটি মান ফেরত দেয় না। এইসব ফিল্ড সাধারণ প্রপার্টির মতো কাজ করে, তবে ফিল্ড খালি করা এবং ফিল্ড সেট করা আছে কিনা তা চেক করার জন্য অতিরিক্ত পদ্ধতিও প্রদান করে।

যেমন, Campaign অবজেক্টের Name ফিল্ডটি optional হিসেবে চিহ্নিত করা হয়েছে, তাই এই ফিল্ডের সাথে কাজ করার জন্য আপনি নিম্নলিখিত পদ্ধতি ব্যবহার করতে পারবেন:

// Get the name.
string name = campaign.Name;

// Set the name.
campaign.Name = name;

// Check if the campaign object has the name field set.
bool hasName = campaign.HasName();

// Clear the name field. Use this method to exclude the Name field from
// being sent to the server in a subsequent API call.
campaign.ClearName();

// Set the campaign name to an empty string value. This value will be
// sent to the server if you use this object in a subsequent API call.
campaign.Name = "";

// This throws a runtime ArgumentNullException. Use ClearName() instead.
campaign.Name = null;

রিপিটেড ফিল্ড

Google Ads API-তে ফিল্ড অ্যারে শুধু দেখার উপযুক্ত RepeatedField হিসেবে দেখানো হয়।

যেমন, কোনও ক্যাম্পেনের url_custom_parameters ফিল্ড হল একটি রিপিট করা ফিল্ড, তাই .NET ক্লায়েন্ট লাইব্রেরিতে এটি শুধু-পঠনযোগ্য RepeatedField<CustomParameter> হিসেবে দেখানো হয়। RepeatedField<T> IList<T> ইন্টারফেস প্রয়োগ করে।

RepeatedField প্রপার্টি পূরণ করার দুটি উপায় আছে:

AddRange পদ্ধতি

Campaign campaign = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
    Status = CampaignStatus.Paused,
};

// Add values to UrlCustomParameters using the AddRange method.
campaign.UrlCustomParameters.AddRange(new CustomParameter[]
{
    new CustomParameter { Key = "season", Value = "christmas" },
    new CustomParameter { Key = "promocode", Value = "NY123" }
});

কালেকশন ইনিশিয়ালাইজার সিনট্যাক্স

// Option 1: Initialize the field directly.
Campaign campaign = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
    Status = CampaignStatus.Paused,
    // Directly initialize the field.
    UrlCustomParameters =
    {
        new CustomParameter { Key = "season", Value = "christmas" },
        new CustomParameter { Key = "promocode", Value = "NY123" }
    }
};

// Option 2: Initialize using an intermediate variable.
CustomParameter[] parameters = new CustomParameter[]
{
    new CustomParameter { Key = "season", Value = "christmas" },
    new CustomParameter { Key = "promocode", Value = "NY123" }
};

Campaign campaign1 = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
    Status = CampaignStatus.Paused,
    // Initialize from an existing array.
    UrlCustomParameters = { parameters }
};

Oneof ফিল্ড

Google Ads API-এর কিছু ফিল্ড oneof ফিল্ড হিসেবে চিহ্নিত করা থাকে, যার অর্থ হল ফিল্ডে বিভিন্ন ধরনের ভ্যালু থাকতে পারে তবে নির্দিষ্ট সময়ে একটিই ভ্যালু থাকবে। oneof ফিল্ডগুলি C প্রোগ্রামিং ভাষায় ব্যবহৃত ইউনিয়ন টাইপের মতো।

.NET লাইব্রেরি oneof ফিল্ডে থাকতে পারে এমন প্রতিটি ধরনের ভ্যালুর জন্য একটি করে প্রপার্টি প্রদান করে oneof ফিল্ড প্রয়োগ করে, যেখানে সব প্রপার্টি একটি শেয়ার করা অন্তর্নিহিত স্টোরেজ ফিল্ড আপডেট করে।

যেমন, ক্যাম্পেনের campaign_bidding_strategy-কে oneof ফিল্ড হিসেবে চিহ্নিত করা হয়েছে। এই ক্লাসটি নিম্নলিখিতভাবে প্রয়োগ করা হয় (সংক্ষিপ্ত করার জন্য কোড সরল করা হয়েছে):

public sealed partial class Campaign : pb::IMessage<Campaign>
{
    object campaignBiddingStrategy_ = null;
    CampaignBiddingStrategyOneofCase campaignBiddingStrategyCase_;

    public ManualCpc ManualCpc
    {
        get
        {
            return campaignBiddingStrategyCase_ ==
                CampaignBiddingStrategyOneofCase.ManualCpc
                ? (ManualCpc)campaignBiddingStrategy_ : null;
        }
        set
        {
            campaignBiddingStrategy_ = value;
            campaignBiddingStrategyCase_ =
                CampaignBiddingStrategyOneofCase.ManualCpc;
        }
    }

    public ManualCpm ManualCpm
    {
        get
        {
            return campaignBiddingStrategyCase_ ==
                CampaignBiddingStrategyOneofCase.ManualCpm
                ? (ManualCpm)campaignBiddingStrategy_ : null;
        }
        set
        {
            campaignBiddingStrategy_ = value;
            campaignBiddingStrategyCase_ =
                CampaignBiddingStrategyOneofCase.ManualCpm;
        }
    }

    public CampaignBiddingStrategyOneofCase CampaignBiddingStrategyCase
    {
        get { return campaignBiddingStrategyCase_; }
    }
}

oneof প্রপার্টি স্টোরেজ শেয়ার করে বলে, একটি অ্যাসাইনমেন্ট আগের অ্যাসাইনমেন্টকে ওভাররাইট করতে পারে, যার ফলে সূক্ষ্ম বাগ দেখা দিতে পারে। যেমন:

Campaign campaign = new Campaign()
{
    ManualCpc = new ManualCpc(),
    ManualCpm = new ManualCpm()
};

এই ক্ষেত্রে, campaign.ManualCpc হল null কারণ campaign.ManualCpm প্রপার্টি ইনিশিয়ালাইজ করলে campaign.ManualCpc-এর আগের ইনিশিয়ালাইজেশন ওভাররাইট হয়ে যায়।

অন্যান্য ফর্ম্যাটে কনভার্ট করা

JSON ফর্ম্যাটে কনভার্ট করুন

আপনি protobuf অবজেক্টকে JSON ফর্ম্যাটে এবং আবার আগের অবস্থায় ফিরিয়ে আনতে Google.Protobuf.JsonFormatter ব্যবহার করতে পারেন। JSON বা XML-এর মতো টেক্সট-ভিত্তিক ফর্ম্যাট প্রয়োজন হয় এমন অন্যান্য সিস্টেমের সাথে ইন্টারফেস করার প্রয়োজন হলে, সিস্টেম তৈরি করার সময় এটি কাজে লাগে।

using Google.Protobuf;

GoogleAdsRow row = new GoogleAdsRow()
{
    Campaign = new Campaign()
    {
        Id = 123,
        Name = "Campaign 1",
        ResourceName = ResourceNames.Campaign(1234567890, 123)
    }
};

// Serialize to JSON and back.
string json = JsonFormatter.Default.Format(row);
row = GoogleAdsRow.Parser.ParseJson(json);

বাইট হিসেবে কনভার্ট করা

আপনি Google.Protobuf ব্যবহার করে কোনও অবজেক্টকে বাইটে এবং বাইটকে অবজেক্টে সিরিয়ালাইজ করতে পারবেন। JSON ফর্ম্যাটের তুলনায় বাইনারি সিরিয়ালাইজেশন আরও বেশি মেমরি ও স্টোরেজ-সাশ্রয়ী।

using Google.Protobuf;

GoogleAdsRow row = new GoogleAdsRow()
{
    Campaign = new Campaign()
    {
        Id = 123,
        Name = "Campaign 1",
        ResourceName = ResourceNames.Campaign(1234567890, 123)
    }
};

// Serialize to bytes and back.
byte[] bytes = row.ToByteArray();
row = GoogleAdsRow.Parser.ParseFrom(bytes);