עבודה עם סוגי Protobuf

מכיוון ש-Google Ads API משתמש ב-Protobuf כפורמט ברירת המחדל למטען ייעודי (payload), חשוב להבין כמה מוסכמות וסוגים של Protobuf בעבודה עם ה-API.

שדות אופציונליים

הרבה שדות ב-Google Ads API מסומנים בתור optional. כך אפשר להבחין בין מקרים שבהם השדה מכיל ערך ריק, לעומת מקרים שבהם השרת לא שלח ערך חזרה. השדות האלה פועלים כמו שדות רגילים, אלא שהם מספקים גם שיטות נוספות לניקוי השדה ולבדיקה אם הוא מוגדר.

לדוגמה, השדה Name של האובייקט Campaign מסומן כאופציונלי. לכן אפשר להשתמש בשיטות הבאות כדי לעבוד עם השדה הזה.

// 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 של קמפיין הוא שדה חוזר, ולכן הוא מיוצג כ-RepeatedField<CustomParameter> לקריאה בלבד בספריית הלקוח .NET.

השדה 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 }
};

אחד מהסוגים

חלק מהשדות ב-Google Ads API מסומנים כשדות OneOf, כלומר השדה הזה יכול לכלול סוגים שונים אבל רק ערך אחד בכל פעם. אחד מהשדות דומה לסוג איחוד ב-C.

ספריית .NET מיישמת את השדות של OneOf באמצעות מאפיין אחד לכל סוג ערך שאפשר לשמור בשדה OneOf, ואת כל המאפיינים שמעדכנים שדה של מחלקה משותפת.

לדוגמה, השדה campaign_bidding_strategy של הקמפיין מסומן כשדה 'אחד או יותר'. הטמעת השיטה הזו מתבצעת באופן הבא (הקוד מופשט לצורך קיצור):

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_; }
    }
}

מכיוון שאחד מהנכסים חולקים נפח אחסון, מטלה אחת יכולה להחליף הקצאה קודמת ולגרום לבאגים קלים. לדוגמה,

Campaign campaign = new Campaign()
{
    ManualCpc = new ManualCpc()
    {
        EnhancedCpcEnabled = true
    },
    ManualCpm = new ManualCpm()
    {

    }
};

במקרה הזה, campaign.ManualCpc הוא עכשיו null כי אתחול השדה campaign.ManualCpm יחליף את האתחול הקודם של campaign.ManualCpc.

המרה לפורמטים אחרים

ניתן להמיר בקלות אובייקטים של protobuf לפורמט 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);