प्रोटोबफ़ टाइप के साथ काम करना

Google Ads API, अपने डिफ़ॉल्ट पेलोड फ़ॉर्मैट के तौर पर Protobuf का इस्तेमाल करता है. इसलिए, एपीआई के साथ काम करते समय, Protobuf के कुछ नियमों और टाइप को समझना ज़रूरी है.

वैकल्पिक फ़ील्ड

Google Ads API के कई फ़ील्ड, optional के तौर पर मार्क किए गए हैं. इससे, आपको उन मामलों के बीच अंतर करने में मदद मिलती है जहां फ़ील्ड में कोई वैल्यू नहीं है और जहां सर्वर ने फ़ील्ड के लिए कोई वैल्यू नहीं भेजी है. ये फ़ील्ड, सामान्य फ़ील्ड की तरह ही काम करते हैं. हालांकि, इनमें फ़ील्ड को खाली करने और यह देखने के लिए अन्य तरीके भी उपलब्ध होते हैं कि फ़ील्ड सेट है या नहीं.

उदाहरण के लिए, Campaign ऑब्जेक्ट का Name फ़ील्ड, वैकल्पिक के तौर पर मार्क किया गया है. इसलिए, इस फ़ील्ड के साथ काम करने के लिए, इन तरीकों का इस्तेमाल किया जा सकता है.

// 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 Name field from
// being sent to the server in a subsequent API call.
campaign.ClearName();

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

// This will throw a runtime error. Use ClearName() instead.
campaign.Name = null;

दोहराए गए टाइप

Google Ads API में, फ़ील्ड कलेक्शन को सिर्फ़ पढ़ने के लिए उपलब्ध RepeatedField के तौर पर दिखाया जाता है.

उदाहरण के लिए, कैंपेन का url_custom_parameters फ़ील्ड, दोहराया गया फ़ील्ड है. इसलिए, इसे .NET क्लाइंट लाइब्रेरी में रीड-ओनली RepeatedField<CustomParameter> के तौर पर दिखाया जाता है.

RepeatedField, IList<T> इंटरफ़ेस को लागू करता है.

RepeatedField फ़ील्ड को पॉप्युलेट करने के दो तरीके हैं.

C# का पुराना वर्शन: AddRange तरीके का इस्तेमाल करके वैल्यू जोड़ना

इसका उदाहरण नीचे दिया गया है.

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

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

C# के नए वर्शन: कलेक्शन को शुरू करने वाले सिंटैक्स का इस्तेमाल करना

// 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()
    {
        EnhancedCpcEnabled = true
    },
    ManualCpm = new ManualCpm()
    {

    }
};

इस मामले में, campaign.ManualCpc अब null है, क्योंकि campaign.ManualCpm फ़ील्ड को शुरू करने पर, campaign.ManualCpc के लिए पहले से शुरू किया गया वैल्यू बदल जाती है.

अन्य फ़ॉर्मैट में बदलना

protobuf ऑब्जेक्ट को JSON फ़ॉर्मैट में आसानी से बदला जा सकता है. इसके अलावा, JSON फ़ॉर्मैट को protobuf फ़ॉर्मैट में भी बदला जा सकता है. यह तब काम आता है, जब ऐसे सिस्टम बनाए जा रहे हों जिन्हें ऐसे दूसरे सिस्टम के साथ इंटरफ़ेस करना हो जिनके लिए JSON या एक्सएमएल जैसे टेक्स्ट-आधारित फ़ॉर्मैट में डेटा की ज़रूरत होती है.

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

किसी ऑब्जेक्ट को बाइट में सीरियलाइज़ किया जा सकता है और फिर से ऑब्जेक्ट में बदला जा सकता है. बाइनरी सीरियलाइज़ेशन, JSON फ़ॉर्मैट की तुलना में मेमोरी और स्टोरेज के लिहाज़ से ज़्यादा बेहतर होता है.

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