หน้านี้ถือว่าคุณคุ้นเคยกับการออกแบบที่เน้นทรัพยากรและชื่อทรัพยากรในคู่มือนักพัฒนาซอฟต์แวร์ และเสริมด้วยรายละเอียดการใช้งานที่เฉพาะเจาะจงของ 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