הצגת מטא-נתונים לגבי החיפוש שבוצע, מטא-נתונים לגבי המנוע ששימש לחיפוש ותוצאות החיפוש.
בקשת HTTP
GET https://customsearch.googleapis.com/customsearch/v1
בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.
פרמטרים של שאילתה
| פרמטרים | |
|---|---|
| c2coff | 
 מפעילה או משביתה חיפוש בסינית פשוטה ומסורתית. ערך ברירת המחדל של הפרמטר הזה הוא 0 (אפס), כלומר התכונה מופעלת. הערכים הנתמכים הם: 
 | 
| cr | 
 הגבלת תוצאות החיפוש למסמכים שמקורם במדינה מסוימת. אפשר להשתמש באופרטורים בוליאניים בערך של הפרמטר cr. המערכת של חיפוש Google קובעת את המדינה של מסמך באמצעות ניתוח של: 
 רשימה של ערכים חוקיים לפרמטר הזה מופיעה בדף ערכים של פרמטר מדינה. | 
| cx | 
 מזהה Programmable Search Engine שישמש בבקשה הזו. | 
| dateRestrict | 
 הגבלת התוצאות לכתובות URL על סמך תאריך. הערכים הנתמכים כוללים: 
 | 
| exactTerms | 
 מזהה ביטוי שכל המסמכים בתוצאות החיפוש חייבים להכיל. | 
| excludeTerms | 
 מזהה מילה או ביטוי שלא אמורים להופיע באף מסמך בתוצאות החיפוש. | 
| fileType | 
 הגבלת התוצאות לקבצים של תוסף שצוין. במרכז העזרה של Search Console תוכלו למצוא רשימה של סוגי קבצים ש-Google יכולה להוסיף לאינדקס. | 
| filter | 
 המדיניות הזו קובעת אם מפעילים או משביתים את מסנן התוכן הכפול. 
 הערכים הקבילים הם: 
 | 
| gl | 
 המיקום הגיאוגרפי של משתמש הקצה. 
 | 
| googlehost | 
 הוצא משימוש. כדי להשיג השפעה דומה, משתמשים בפרמטר  הדומיין המקומי של Google (לדוגמה, google.com , google.de או google.fr) שבו רוצים להשתמש לביצוע החיפוש. | 
| highRange | 
 מציינת את ערך הסיום של טווח חיפוש. 
 | 
| hl | 
 המדיניות הזו מגדירה את שפת ממשק המשתמש. 
 | 
| hq | 
 מצרף את מונחי השאילתה שצוינו לשאילתה, כאילו הם שולבו עם אופרטור AND לוגי. | 
| imgColorType | 
 מחזירה תמונות בשחור-לבן, תמונות בגווני אפור, תמונות שקופות או תמונות צבעוניות. הערכים הקבילים הם: 
 | 
| imgDominantColor | 
 מחזירה תמונות בצבע דומיננטי מסוים. הערכים הקבילים הם: 
 | 
| imgSize | 
 מחזירה תמונות בגודל שצוין. הערכים הקבילים הם: 
 | 
| imgType | 
 מחזירה תמונות מסוג. הערכים הקבילים הם: 
 | 
| linkSite | 
 ההגדרה הזו מציינת שכל תוצאות החיפוש צריכות להכיל קישור לכתובת URL מסוימת. | 
| lowRange | 
 מציינת את הערך ההתחלתי של טווח חיפוש. אפשר להשתמש ב- | 
| lr | 
 מגבילה את החיפוש למסמכים שנכתבו בשפה מסוימת (למשל,  הערכים הקבילים הם: 
 | 
| num | 
 מספר תוצאות החיפוש שיש להחזיר. 
 | 
| orTerms | 
 מספק מונחי חיפוש נוספים לבדיקה במסמך, כשכל מסמך בתוצאות החיפוש חייב להכיל לפחות אחד ממונחי החיפוש הנוספים. | 
| q | 
 שאילתה | 
| relatedSite | 
 הוּצא משימוש. | 
| rights | 
 מסננים שמבוססים על רישוי. הערכים הנתמכים כוללים:  | 
| safe | 
 רמת הבטיחות של החיפוש. הערכים הקבילים הם: 
 | 
| searchType | 
 מציין את סוג החיפוש:  הערכים הקבילים הם: 
 | 
| siteSearch | 
 מציינת אתר נתון שתמיד צריך לכלול או להחריג מהתוצאות (מידע נוסף מופיע בפרמטר  | 
| siteSearchFilter | 
 המדיניות קובעת אם לכלול או להחריג תוצאות מהאתר שצוין בפרמטר  הערכים הקבילים הם: 
 | 
| sort | 
 ביטוי המיון שיש להחיל על התוצאות. פרמטר המיון מציין שהתוצאות ימוינו לפי הביטוי שצוין, כלומר מיון לפי תאריך. דוגמה: sort=date. | 
| start | 
 האינדקס של התוצאה הראשונה שיש להחזיר. מספר ברירת המחדל של תוצאות לדף הוא 10, כך ש- | 
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול מופע של Search.
היקפי הרשאות
נדרש היקף OAuth הבא:
- https://www.googleapis.com/auth/cse
למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.