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

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 प्रॉपर्टी को दो तरीकों से भरा जा सकता है:

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 के लिए पिछली बार शुरू की गई प्रॉपर्टी बदल जाती है.

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

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