מסמך זה יעזור לך להכיר את ממשק ה-API של JSON לחיפוש בהתאמה אישית ואת השימוש בו.
לפני שמתחילים
יצירת Programmable Search Engine
באמצעות קריאה ל-API, המשתמש שולח בקשות נגד מכונה קיימת של Programmable Search Engine.
לכן, לפני השימוש ב-API, צריך ליצור אותו בלוח הבקרה. קראו את המדריך כדי לקבל מידע נוסף על אפשרויות ההגדרה השונות.
אחרי שיוצרים אותו, אפשר למצוא את מזהה מנוע החיפוש בקטע Basic בדף Overview. ה-API משתמש בפרמטר cx.
זיהוי האפליקציה שלכם ב-Google באמצעות מפתח API
ב-Custom Search JSON API יש להשתמש במפתח API. מפתח API מאפשר לזהות את הלקוח ב-Google.
- משתמשי Programmable Search Engine (מהדורת חינם): קבלת מפתח
אחרי שיוצרים מפתח 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 שכולל שלושה סוגי נתונים:
- מטא-נתונים שמתארים את החיפוש המבוקש (וכנראה גם בקשות של חיפוש קשור)
- מטא-נתונים שמתארים את Programmable Search Engine
- תוצאות חיפוש
לפרטים נוספים, אפשר לעיין בקטע של נתוני התשובות שבמאמר שימוש ב-REST.
מודל הנתונים מבוסס על המפרט של OpenSearch 1.1. בנוסף לנכסים הרגילים של OpenSearch, Custom Search JSON API מגדיר שני מאפיינים מותאמים אישית ושני תפקידי שאילתות מותאמים אישית:
- מאפיינים מותאמים אישית
cx: המזהה של Programmable Search Engine.safe: תיאור של רמת החיפוש הבטוח לסינון התוצאות שהוחזרו.
- תפקידים בשאילתות בהתאמה אישית
nextPage: תפקיד שמציין את האפשרות שאפשר להשתמש בה כדי לגשת לדף הלוגי הבא של התוצאות, אם קיים.previousPage: תפקיד שמציין שאפשר להשתמש בשאילתה כדי לגשת לדף הלוגי הקודם של התוצאות, אם קיים.
רוצה לנסות?
כדי להתנסות ולראות מה ה-API יכול לעשות בלי לכתוב קוד, היכנסו אל הכלי 'Try this API'.
לתיאור מלא של פרמטרים, בקרו בחומר העזר בנושאcse.list.
כדי להבין איך להשתמש ב-API באמצעות בקשות HTTP, המשיכו למאמר שימוש ב-REST.