עבודה עם סוגי 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 של הקמפיין מסומן בתור 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);