เนื่องจาก 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 ช่อง
คล้ายกับประเภทยูเนียนใน C
ไลบรารี .NET ใช้ช่อง OneOf โดยการระบุพร็อพเพอร์ตี้ 1 รายการสำหรับค่าแต่ละประเภทที่จะอยู่ในช่อง OneOf และพร็อพเพอร์ตี้ทั้งหมดที่อัปเดตช่องคลาสที่แชร์
เช่น ทำเครื่องหมาย campaign_bidding_strategy
ของแคมเปญเป็นช่องเดียว คลาสนี้มีการติดตั้งใช้งานดังต่อไปนี้ (โค้ดที่เข้าใจง่ายเพื่อความกระชับ)
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);