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