หน้านี้จะถือว่าคุณคุ้นเคยกับคู่มือนักพัฒนาซอฟต์แวร์เกี่ยวกับการออกแบบที่มุ่งเน้นทรัพยากรและชื่อทรัพยากร และเสริมด้วยรายละเอียดการติดตั้งใช้งานเฉพาะของ Google Ads API
การออกแบบที่มุ่งเน้นทรัพยากร
โดยทั่วไป Google Ads API จะใช้การออกแบบที่มุ่งเน้นทรัพยากร ซึ่งจำลองเป็น คอลเล็กชันของ ทรัพยากรที่ระบุได้ทีละรายการ (คำนามของ API) ทรัพยากรจะอ้างอิงด้วยชื่อทรัพยากรและจัดการโดยใช้ เมธอดจำนวนเล็กน้อย (หรือที่เรียกว่า คำกริยาหรือ การดำเนินการ) ชื่อทรัพยากรและเมธอดเหล่านี้เมื่อรวม กับคำนำหน้าเวอร์ชัน APIที่เฉพาะเจาะจงจะประกอบกันเป็น URL ของอินเทอร์เฟซ REST ตัวอย่างเช่น URL ตัวอย่างนี้สามารถแบ่งออกเป็นคอมโพเนนต์แต่ละรายการตามตารางต่อไปนี้
https://googleads.googleapis.com/v25/customers/1234567890:mutate
| คำนำหน้าเวอร์ชัน API | ชื่อทรัพยากร (สัมพัทธ์) | เมธอด |
|---|---|---|
https://googleads.googleapis.com/v25
|
customers/1234567890
|
mutate
|
URL REST ทั้งหมดสำหรับ API เวอร์ชันใดเวอร์ชันหนึ่ง (เช่น v25) จะมีคำนำหน้าเวอร์ชัน 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 ที่เครื่องอ่านได้