Custom Search JSON API: บทนำ

เอกสารนี้จะช่วยให้คุณคุ้นเคยกับ Custom Search JSON API และการใช้งาน

ก่อนจะเริ่ม

สร้าง Programmable Search Engine

เรียกใช้คำขอปัญหาของผู้ใช้ API ต่ออินสแตนซ์ที่มีอยู่ของ Programmable Search Engine ดังนั้นก่อนใช้ API คุณต้องสร้าง API ในแผงควบคุม ทำตามบทแนะนำ เพื่อดูข้อมูลเพิ่มเติมเกี่ยวกับตัวเลือกการกำหนดค่าต่างๆ เมื่อสร้างแล้ว คุณจะเห็นรหัสเครื่องมือค้นหาในส่วนพื้นฐานของหน้าภาพรวม นี่คือพารามิเตอร์ cx ที่ API ใช้

ระบุแอปพลิเคชันของคุณกับ Google ด้วยคีย์ API

Custom Search JSON API กำหนดให้ใช้คีย์ API คีย์ API เป็นวิธีระบุไคลเอ็นต์ให้ Google ทราบ

หลังจากมีคีย์ API แล้ว แอปพลิเคชันจะเพิ่มพารามิเตอร์การค้นหา key=yourAPIKey ต่อท้าย URL คำขอทั้งหมดได้ คีย์ API ปลอดภัยสำหรับการฝังใน URL โดยไม่จำเป็นต้องมีการเข้ารหัสใดๆ

ภาพรวม API

การทำงานของ API

การเรียกใน Custom Search JSON API ทำได้เพียงวิธีเดียวคือ

การดำเนินการ คำอธิบาย การแมป HTTP ของ REST
list แสดงผลการค้นหาที่ขอจาก Programmable Search Engine GET

โมเดลข้อมูล API

ผลลัพธ์ของคำค้นหาสำหรับ Custom Search JSON API คือออบเจ็กต์ JSON ที่มีข้อมูล 3 ประเภทดังนี้

  • ข้อมูลเมตาที่อธิบายการค้นหาที่ขอ (และอาจเป็นคำขอการค้นหาที่เกี่ยวข้อง)
  • ข้อมูลเมตาที่อธิบาย Programmable Search Engine
  • ผลการค้นหา

โปรดดูรายละเอียดเพิ่มเติมในส่วนข้อมูลการตอบกลับในการใช้ REST

โมเดลข้อมูลจะขึ้นอยู่กับข้อกำหนดของ OpenSearch 1.1 นอกจากพร็อพเพอร์ตี้ OpenSearch แบบมาตรฐานแล้ว Custom Search JSON API ยังกำหนดพร็อพเพอร์ตี้ที่กำหนดเอง 2 รายการ และบทบาทการค้นหาที่กำหนดเอง 2 บทบาท ดังนี้

  • พร็อพเพอร์ตี้ที่กำหนดเอง
    • cx: ตัวระบุของ Programmable Search Engine
    • safe: คำอธิบายของระดับฟีเจอร์ค้นหาปลอดภัยเพื่อกรองผลการค้นหาที่แสดง
  • บทบาทการค้นหาที่กำหนดเอง
    • nextPage: บทบาทที่บ่งบอกว่าสามารถใช้คำค้นหาเพื่อเข้าถึงผลการค้นหาหน้าเชิงตรรกะถัดไปได้ หากมี
    • previousPage: บทบาทที่บ่งบอกว่ามีการใช้คำค้นหาเพื่อเข้าถึงหน้าผลลัพธ์แบบตรรกะก่อนหน้า (หากมี)

ลองเลย

หากต้องการลองทดสอบและดูว่า API ทำอะไรได้บ้างโดยไม่ต้องเขียนโค้ด ให้ไปที่เครื่องมือ"ลองใช้ API นี้"

ดูคำอธิบายแบบเต็มของพารามิเตอร์ได้ที่ข้อมูลอ้างอิงของ CSE.list

หากต้องการเรียนรู้วิธีใช้ API ผ่านคำขอ HTTP ให้ไปที่การใช้ REST