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