עבודה עם סוגי 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. כלומר, הם יכולים להכיל סוגים שונים של שדות, אבל רק ערך אחד בכל פעם. השדה 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.

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

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