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

Google Ads API, 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 फ़ील्ड हैं यूनियन टाइप की तरह सी है.

.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.

अन्य फ़ॉर्मैट में कन्वर्ज़न

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

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