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

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

ตัวอย่างเช่น ช่อง url_custom_parameters ของแคมเปญเป็นฟิลด์ที่ซ้ำได้ ดังนั้นระบบจะแสดงเป็น RepeatedField<CustomParameter> แบบอ่านอย่างเดียวในไลบรารีของไคลเอ็นต์ .NET RepeatedField จะใช้ IList<T> อินเทอร์เฟซ

การป้อนข้อมูลในช่อง RepeatedField ทำได้ 2 วิธี

เมธอด 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" }
 });
 ```

ไวยากรณ์ตัวเริ่มต้นคอลเล็กชัน

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

Campaign campaign = new Campaign()
{
    ManualCpc = new ManualCpc()
    {
        EnhancedCpcEnabled = true
    },
    ManualCpm = new ManualCpm()
    {

    }
};

ในกรณีนี้ campaign.ManualCpc จะเป็น null เนื่องจากตัวเริ่มต้นของช่อง campaign.ManualCpm จะเขียนทับตัวเริ่มต้นก่อนหน้าสำหรับ campaign.ManualCpc

การแปลงเป็นรูปแบบอื่นๆ

แปลงเป็นรูปแบบ JSON

คุณสามารถแปลงออบเจ็กต์ 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);