หน้านี้จะถือว่าคุ้นเคยกับคู่มือนักพัฒนาซอฟต์แวร์ Resource Oriented Design และ Resource Names และเสริมด้วยรายละเอียดการใช้งานเฉพาะของ Search Ads 360 Reporting API
การออกแบบที่เน้นทรัพยากร
โดยทั่วไป Search Ads 360 Reporting API จะใช้การออกแบบที่มุ่งเน้นทรัพยากร ประมาณเป็นคอลเล็กชันของทรัพยากรที่ระบุได้ทีละรายการ (คำนามของ API) มีการอ้างอิงทรัพยากรด้วยชื่อทรัพยากรและจัดการโดยใช้เมธอดชุดเล็กๆ (หรือที่เรียกว่ากริยาหรือการดำเนินการ)
ชื่อทรัพยากรและเมธอดเหล่านี้ รวมกับคำนำหน้าเวอร์ชัน API ที่เฉพาะเจาะจง จะประกอบด้วย URL ของอินเทอร์เฟซ REST ตัวอย่างเช่น URL ด้านล่างสามารถแยกออกเป็นองค์ประกอบแต่ละอย่างตามตารางต่อไปนี้
https://searchads360.googleapis.com/v0/customers/1234567890/searchAds360:search
| คำนำหน้าเวอร์ชัน API | ชื่อทรัพยากร (สัมพัทธ์) | วิธีการ |
|---|---|---|
https://searchads360.googleapis.com/v0
|
customers/1234567890
|
search
|
URL ของ REST ทั้งหมดสำหรับ API เวอร์ชันใดเวอร์ชันหนึ่ง (เช่น v0) แชร์คำนำหน้าเวอร์ชัน API ทั่วไป ชื่อทรัพยากรและเมธอดรวมกันจะระบุว่าบริการ API ใดที่กำลังถูกเรียก
Search Ads 360 Reporting API ใช้เมธอดที่กำหนดเองมาค่อนข้างมาก ซึ่งต่างจาก REST API แบบดั้งเดิมส่วนใหญ่ที่ใช้เมธอด REST มาตรฐาน เช่น list และ get Search Ads 360 Reporting API
มีวิธีการที่กำหนดเอง 2 วิธี ได้แก่ search และ searchStream
หน้าต่อไปนี้จะอธิบายรายละเอียดเพิ่มเติมเกี่ยวกับชื่อทรัพยากร วิธีการให้บริการ และแบบแผนการตั้งชื่อ JSON ของ Search Ads 360 Reporting API เพื่อแสดงให้เห็นการใช้งานร่วมกันในการกำหนดปลายทางของอินเทอร์เฟซ REST