การทำงานกับประเภท Protobuf

เนื่องจาก Google Ads API ใช้ proto3 เป็นรูปแบบเพย์โหลดเริ่มต้น คุณจึงควรทำความเข้าใจเกี่ยวกับข้อกำหนดและประเภทของบัฟเฟอร์โปรโตคอลบางอย่างเมื่อใช้ไลบรารีของไคลเอ็นต์ .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 ได้ 2 วิธีดังนี้

เมธอด AddRange

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 คล้ายกับประเภท Union ในภาษาโปรแกรม C

ไลบรารี .NET ใช้ฟิลด์ oneof โดยระบุพร็อพเพอร์ตี้ 1 รายการสำหรับค่าแต่ละประเภทที่เก็บไว้ในฟิลด์ 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);