แสดงโปรแกรมสํารวจ APIs และเรียกใช้เมธอด

ในหน้าเอกสารประกอบส่วนใหญ่ คุณจะเห็นเครื่องมือสำรวจ API แบบย่อทางด้านขวาของหน้าจอ หากไม่เห็นโปรแกรมสำรวจ API ให้คลิกลองเลยเพื่อแสดงโปรแกรมสำรวจ API เวอร์ชันย่อ

หากลองเลยไม่ปรากฏทางด้านขวาของหน้าเอกสารอ้างอิง แสดงว่า API Explorer ไม่รองรับเมธอดนั้น ตัวอย่างเช่น โปรแกรมสำรวจ API ใช้ร่วมกับ API ที่ต้องใช้บัญชีบริการไม่ได้ จึงไม่ปรากฏในหน้าเอกสารประกอบสำหรับ API เหล่านั้น

แสดงโปรแกรมสำรวจ API เวอร์ชันขยาย

API Explorer เวอร์ชันที่ขยายแล้วจะมีตัวอย่างโค้ด cURL, HTTP และอาจมีตัวอย่างโค้ดอื่นๆ หากต้องการแสดงโปรแกรมสำรวจ API เวอร์ชันขยาย ให้คลิกเต็มหน้าจอ

เรียกใช้เมธอด

โปรแกรมสำรวจ API ช่วยให้คุณป้อนพารามิเตอร์ที่จำเป็น พารามิเตอร์ที่ไม่บังคับ และเนื้อหาคำขอสำหรับเมธอด API (หากมี) สำหรับเมธอด REST หลายรายการ เช่น เมธอด list คุณจะต้องกรอกข้อมูลเพียง 1 หรือ 2 ช่องก่อนจึงจะ เรียกใช้เมธอดได้ เช่น เมธอด books.volumes.list ของ Books API ต้องการเพียงพารามิเตอร์การค้นหา (q) เพื่อแสดงรายการหนังสือ วิธีลองใช้เมธอด books.volumes.list

  1. ไปที่ books.volumes.list
  2. หากโปรแกรมสำรวจ API ไม่แสดง ให้คลิกลองใช้เลย
  3. ในช่อง q ให้พิมพ์ Hunger Games (โดยไม่มีเครื่องหมายคำพูดหรืออักขระพิเศษ )
  4. เลื่อนลง แล้วคลิกดำเนินการ
  5. (ไม่บังคับ) หน้าจอลงชื่อเข้าใช้ Google จะขอให้คุณเลือกบัญชี Google
  6. (ไม่บังคับ) กล่องโต้ตอบการให้สิทธิ์ของ Google จะถามคุณว่าตกลงที่จะ "จัดการหนังสือของคุณ" หรือไม่ คลิกอนุญาต ผลลัพธ์จะปรากฏใต้ปุ่ม "ดำเนินการ"

หากโปรแกรมสำรวจ API แสดงผลลัพธ์เป็น 200 แสดงว่าเมธอดสำเร็จ

แก้ปัญหาเกี่ยวกับโปรแกรมสำรวจ APIs

คุณได้รับข้อผิดพลาด 401 หรือ 403

หากคุณได้รับข้อผิดพลาด 401 หรือ 403 เมื่อเรียกใช้เมธอดโดยใช้ API Explorer แสดงว่าอาจเกิดปัญหาอย่างใดอย่างหนึ่งต่อไปนี้

  • คุณใช้ประเภทการให้สิทธิ์ที่ไม่ถูกต้อง (คีย์ API แทน OAuth 2.0) ลองเปลี่ยนประเภทการให้สิทธิ์
  • คุณใช้ OAuth 2.0 แต่มีขอบเขตที่แคบเกินไป ลองใช้ขอบเขตที่กว้างขึ้น

กล่องโต้ตอบการให้สิทธิ์ไม่ปรากฏ

API Explorer ใช้ป๊อปอัปเพื่อให้สิทธิ์เข้าถึงข้อมูลส่วนตัวของคุณ หาก เบราว์เซอร์บล็อกป๊อปอัป ป๊อปอัปนี้จะไม่ปรากฏและคุณจะให้สิทธิ์เข้าถึงไม่ได้

หากคุณคลิกอนุญาตในกล่องโต้ตอบการให้สิทธิ์แล้วไม่มีอะไรเกิดขึ้น ให้ลอง เปลี่ยนการตั้งค่าป๊อปอัปของเบราว์เซอร์เพื่อเปิดใช้ป๊อปอัป