หน้านี้จะถือว่าคุ้นเคยกับคู่มือนักพัฒนาซอฟต์แวร์ด้านการออกแบบเชิงทรัพยากรและชื่อทรัพยากร และเสริมรายละเอียดการใช้งานที่เฉพาะเจาะจงของ Google Ads API
การออกแบบที่เน้นทรัพยากรเป็นหลัก
โดยทั่วไป Google Ads API จะใช้การออกแบบที่มุ่งเน้นทรัพยากร โดยจำลองแบบคอลเล็กชันของทรัพยากรที่ระบุที่อยู่ได้ทีละรายการ (คำนามของ API) มีการอ้างอิงทรัพยากรด้วยชื่อทรัพยากรและจัดการโดยใช้ชุด Method ขนาดเล็ก (หรือที่เรียกว่า คำกริยา หรือ operations)
ชื่อทรัพยากรและเมธอดเหล่านี้ รวมกับคำนำหน้าเวอร์ชัน API ที่เฉพาะเจาะจงประกอบขึ้นเป็น URL ของอินเทอร์เฟซ REST ตัวอย่างเช่น URL ด้านล่างอาจแบ่งออกเป็นคอมโพเนนต์แต่ละรายการตามตารางต่อไปนี้
https://googleads.googleapis.com/v16/customers/1234567890:mutate
| คำนำหน้าเวอร์ชัน API | ชื่อทรัพยากร (สัมพัทธ์) | วิธีการ |
|---|---|---|
https://googleads.googleapis.com/v16
|
customers/1234567890
|
mutate
|
URL ของ REST ทั้งหมดสำหรับ API เวอร์ชันใดเวอร์ชันหนึ่ง (เช่น v16)
ใช้คำนำหน้าเวอร์ชัน API ที่ใช้ร่วมกัน ชื่อทรัพยากรและเมธอดรวมกันจะระบุว่าบริการ API ใดที่กำลังเรียกใช้
Google Ads API ใช้เมธอดที่กำหนดเองเป็นจำนวนมาก ซึ่งต่างจาก REST API แบบดั้งเดิมส่วนใหญ่ที่ใช้เมธอด REST มาตรฐาน เช่น list, get, create, update และ delete ตัวอย่างของเมธอดที่กำหนดเองใน Google Ads API ได้แก่ search, searchStream และ mutate
หน้าต่อไปนี้จะอธิบายรายละเอียดเพิ่มเติมเกี่ยวกับชื่อทรัพยากร วิธีการของบริการ และแบบแผนการตั้งชื่อ JSON ของ Google Ads API เพื่อแสดงให้เห็นวิธีการใช้ข้อมูลเหล่านี้ร่วมกันเพื่อกำหนดปลายทางของอินเทอร์เฟซ REST