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

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

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

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

לדוגמה, השדה Name של האובייקט Campaign מסומן כ-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 של קמפיין הוא שדה חוזר, ולכן הוא מיוצג כ-RepeatedField<CustomParameter> לקריאה בלבד בספריית הלקוח של ‎ .NET. ‫RepeatedField<T> מטמיע את הממשק IList<T>.

יש שתי דרכים לאכלס RepeatedField נכס:

‫AddRange method

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.

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

המרה לפורמט JSON

אפשר להמיר אובייקטים של protobuf לפורמט JSON ובחזרה באמצעות Google.Protobuf.JsonFormatter. האפשרות הזו שימושית כשמפתחים מערכות שצריכות להתממשק עם מערכות אחרות שנדרשים בהן פורמטים מבוססי-טקסט כמו JSON או XML.

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

המרה לבייטים

אפשר לבצע סריאליזציה של אובייקט לבייטים ובחזרה באמצעות Google.Protobuf. סריאליזציה בינארית יעילה יותר בשימוש בזיכרון ובנפח אחסון מאשר פורמט 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);