เอกสารนี้จะช่วยให้คุณคุ้นเคยกับ 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 ดังนี้
| การดำเนินการ | คำอธิบาย | การแมป REST HTTP |
|---|---|---|
| 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 Enginesafe: คำอธิบายระดับการค้นหาปลอดภัยสำหรับการกรองผลลัพธ์ที่แสดงผล
- บทบาทการค้นหาที่กำหนดเอง
nextPage: บทบาทที่บ่งบอกว่าสามารถใช้การค้นหาเพื่อเข้าถึงหน้าผลการค้นหาเชิงตรรกะถัดไป (หากมี)previousPage: บทบาทที่ระบุว่าสามารถใช้การค้นหาเพื่อเข้าถึงหน้าผลการค้นหาเชิงตรรกะก่อนหน้าได้ (หากมี)
ลองใช้
หากต้องการทดลองใช้และดูว่า API ทำอะไรได้บ้างโดยไม่ต้องเขียนโค้ด ให้ไปที่เครื่องมือ "ลองใช้ API นี้"
ดูคำอธิบายพารามิเตอร์ทั้งหมดได้ที่ข้อมูลอ้างอิง cse.list
หากต้องการดูวิธีใช้ API ผ่านคำขอ HTTP ให้ไปที่การใช้ REST