Custom Search JSON API: บทนำ

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

ก่อนจะเริ่ม

สร้าง Programmable Search Engine

การเรียกใช้ API จะทำให้ผู้ใช้ส่งคำขอไปยังอินสแตนซ์ที่มีอยู่ของ Programmable Search Engine ดังนั้นก่อนใช้ 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