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

מאחר ש-Google Ads API משתמש ב-Protobuf כפורמט ברירת המחדל של עומס העבודה, חשוב להבין כמה סוגים ומוסכמות של 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 }
};

סוגי 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 או 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);