המסמך הזה יעזור לכם להכיר את 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
יש רק method אחת להפעלה ב-Custom Search JSON API:
| פעולה | תיאור | מיפוי של REST HTTP |
|---|---|---|
| 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 בלי לכתוב קוד, אפשר להיכנס לכלי 'ניסיון של ה-API הזה'.
תיאור מלא של הפרמטרים מופיע במאמר בנושא הפניה ל-cse.list.
כדי ללמוד איך להשתמש ב-API באמצעות בקשות HTTP, אפשר להמשיך לקרוא את המאמר בנושא שימוש ב-REST.