การออกแบบอินเทอร์เฟซ REST

หน้านี้ถือว่าคุณคุ้นเคยกับคู่มือนักพัฒนาซอฟต์แวร์การออกแบบที่มุ่งเน้นทรัพยากรและชื่อทรัพยากร และเสริมด้วยรายละเอียดการติดตั้งใช้งานเฉพาะของ Google Ads API

การออกแบบที่เน้นทรัพยากร

โดยทั่วไป Google Ads API จะใช้การออกแบบที่เน้นทรัพยากร ซึ่งจำลองเป็นคอลเล็กชันของทรัพยากรที่ระบุที่อยู่ได้แต่ละรายการ (คำนามของ API) อ้างอิงทรัพยากรด้วยชื่อทรัพยากรและจัดการโดยใช้วิธีการ (หรือที่เรียกว่ากริยาหรือการดำเนินการ) จำนวนเล็กน้อย

ชื่อทรัพยากรและเมธอดเหล่านี้รวมกัน กับคำนำหน้าเวอร์ชัน API ที่เฉพาะเจาะจงจะประกอบเป็น URL ของอินเทอร์เฟซ REST ตัวอย่างเช่น URL ด้านล่างสามารถแยกออกเป็นคอมโพเนนต์แต่ละรายการได้ตามตารางต่อไปนี้

https://googleads.googleapis.com/v22/customers/1234567890:mutate

URL ของ REST ทั้งหมดสำหรับ API เวอร์ชันใดเวอร์ชันหนึ่ง (เช่น v22) แชร์คำนำหน้าเวอร์ชัน API ทั่วไป ชื่อทรัพยากรและเมธอดร่วมกัน จะระบุว่ามีการเรียกใช้บริการ API ใด

Google Ads API ใช้เมธอดที่กำหนดเองอย่างมาก ซึ่งแตกต่างจาก REST API แบบเดิมส่วนใหญ่ที่ใช้เมธอด REST มาตรฐาน เช่น list, get, create, update และ delete ตัวอย่างของวิธีการที่กำหนดเองใน Google Ads API ได้แก่ search, searchStream และ mutate

หน้าต่อไปนี้จะอธิบายรายละเอียดเพิ่มเติมเกี่ยวกับชื่อ ทรัพยากร เมธอดบริการ และแบบแผนการตั้งชื่อ JSON ของ Google Ads API เพื่อแสดงให้เห็นว่ามีการใช้ร่วมกันอย่างไรในการกำหนดปลายทางของอินเทอร์เฟซ REST

เอกสารการค้นหา

หากต้องการอำนวยความสะดวกและทำให้การค้นหาวิธีการที่มีอยู่ใน Google Ads API เป็นไปโดยอัตโนมัติ คุณสามารถใช้เอกสารการค้นพบที่เผยแพร่สำหรับแต่ละเวอร์ชันได้

โดยมีให้บริการที่ https://googleads.googleapis.com/$discovery/rest?version=<API_VERSION> เช่น เอกสารนี้ คือเอกสารการค้นพบสำหรับ Google Ads API เวอร์ชันล่าสุด

เอกสารการค้นหามีข้อมูลเกี่ยวกับบริการ วิธีการ ทรัพยากร และเอนทิตีทั้งหมดที่ใช้ใน Google Ads API เช่น เอกสารอ้างอิง แต่จะอยู่ในรูปแบบ JSON ที่เครื่องอ่านได้