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