প্রোটোবাফ প্রকারের সাথে কাজ করা

যেহেতু গুগল অ্যাডস এপিআই তার ডিফল্ট পেলোড ফরম্যাট হিসেবে প্রোটো৩ (proto3) ব্যবহার করে, তাই .NET ক্লায়েন্ট লাইব্রেরি নিয়ে কাজ করার সময় প্রোটোকল বাফারস (Protocol Buffers)-এর কয়েকটি কনভেনশন ও টাইপ বোঝা জরুরি।

ঐচ্ছিক ক্ষেত্র

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;

পুনরাবৃত্ত ক্ষেত্র

গুগল অ্যাডস এপিআই-তে একটি ফিল্ড অ্যারে একটি রিড-অনলি RepeatedField হিসেবে উপস্থাপিত হয়।

উদাহরণস্বরূপ, একটি ক্যাম্পেইনের url_custom_parameters ফিল্ডটি একটি রিপিটেড ফিল্ড, তাই .NET ক্লায়েন্ট লাইব্রেরিতে এটিকে একটি রিড-অনলি RepeatedField<CustomParameter> হিসেবে উপস্থাপন করা হয়। RepeatedField<T> ইন্টারফেসটি IList<T> ইমপ্লিমেন্ট করে।

একটি RepeatedField প্রপার্টিতে ডেটা প্রবেশ করানোর দুটি উপায় আছে:

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 ফিল্ড হিসেবে চিহ্নিত করা হয়, যার অর্থ হলো ফিল্ডটি বিভিন্ন ধরনের ডেটা টাইপ ধারণ করতে পারলেও, যেকোনো সময়ে কেবল একটিই ভ্যালু ধারণ করতে পারে। oneof ফিল্ডগুলো সি প্রোগ্রামিং ল্যাঙ্গুয়েজের 'union' টাইপের অনুরূপ।

.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 এর পূর্ববর্তী ইনিশিয়ালাইজেশনকে ওভাররাইট করে দেয়।

অন্যান্য ফরম্যাটে রূপান্তর

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);

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);