การทำงานกับประเภท 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 ทำได้ 2 วิธี

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 ช่อง ซึ่งหมายความว่าช่องนั้นจะมีประเภทได้หลายประเภท แต่จะมีค่าได้เพียงครั้งละ 1 ค่า ช่อง 1 ช่องนั้นคล้ายกับประเภทการรวม ในช่อง 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 แชร์พื้นที่เก็บข้อมูล งาน 1 งานจึงอาจเขียนทับงานก่อนหน้า ซึ่งนำไปสู่ข้อบกพร่องเล็กๆ น้อยๆ ตัวอย่างเช่น

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