การออกแบบอินเทอร์เฟซ REST

หน้านี้มีไว้เพื่อความคุ้นเคยกับหลักการด้านทรัพยากร การออกแบบและทรัพยากร คู่มือนักพัฒนาซอฟต์แวร์และ มาช่วยเสริมด้วยรายละเอียดการใช้งาน Google Ads API ที่เจาะจง

การออกแบบที่มุ่งเน้นทรัพยากร

โดยทั่วไป Google Ads API จะมีการออกแบบที่มุ่งเน้นทรัพยากร โดยมีตัวอย่างดังนี้ คอลเล็กชันของทรัพยากรที่ระบุที่อยู่แต่ละรายการ (คำนามของ API) มีการอ้างอิงทรัพยากรด้วยชื่อทรัพยากรและมีการแก้ไขโดยใช้ ชุดเมธอด (หรือเรียกว่ากริยาหรือการดำเนินการ)

ชื่อทรัพยากรและวิธีการเหล่านี้รวมกัน ด้วยคำนำหน้าเวอร์ชัน API ที่เฉพาะเจาะจง ซึ่งประกอบด้วย URL ของอินเทอร์เฟซ REST ตัวอย่างเช่น URL ด้านล่างสามารถแบ่งออกเป็นองค์ประกอบย่อยๆ เหล่านี้ ตามตารางต่อไปนี้

https://googleads.googleapis.com/v17/customers/1234567890:mutate
คำนำหน้าเวอร์ชัน API ชื่อทรัพยากร (สัมพัทธ์) วิธีการ
https://googleads.googleapis.com/v17 customers/1234567890 mutate

URL ของ REST ทั้งหมดสำหรับ API เวอร์ชันใดเวอร์ชันหนึ่ง (เช่น v17) แชร์คำนำหน้าเวอร์ชัน API ทั่วไป ใช้ชื่อทรัพยากรและเมธอดร่วมกัน ระบุบริการ API ที่จะเรียกใช้

Google Ads API จะใช้วิธีการที่กำหนดเองเป็นจำนวนมาก ซึ่งตรงข้ามกับ REST API แบบดั้งเดิมที่ใช้เมธอด REST มาตรฐาน เช่น list, get, create, update และ delete ตัวอย่างของวิธีการที่กำหนดเองใน Google Ads API รวม search, searchStream และ mutate

หน้าต่อไปนี้มีรายละเอียดเพิ่มเติมเกี่ยวกับแหล่งข้อมูลของ Google Ads API ชื่อ วิธีการบริการ และ แบบแผนการตั้งชื่อ JSON เพื่อแสดงลักษณะการใช้งาน ร่วมกันเพื่อกำหนดปลายทางของอินเทอร์เฟซ REST