Method: cse.siterestrict.list

הצגת מטא-נתונים לגבי החיפוש שבוצע, מטא-נתונים לגבי המנוע ששימש לחיפוש ותוצאות החיפוש. המערכת משתמשת בקבוצה קטנה של תבניות URL.

בקשת HTTP

GET https://customsearch.googleapis.com/customsearch/v1/siterestrict

בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.

פרמטרים של שאילתה

פרמטרים
c2coff

string

מפעילה או משביתה חיפוש בסינית פשוטה ומסורתית.

ערך ברירת המחדל של הפרמטר הזה הוא 0 (אפס), כלומר התכונה מופעלת. הערכים הנתמכים הם:

  • 1: מושבת

  • 0: מופעל (ברירת מחדל)
cr

string

הגבלת תוצאות החיפוש למסמכים שמקורם במדינה מסוימת. אפשר להשתמש באופרטורים בוליאניים בערך של הפרמטר cr.

המערכת של חיפוש Google קובעת את המדינה של מסמך באמצעות ניתוח של:

  • הדומיין ברמה העליונה (TLD) של כתובת ה-URL של המסמך

  • המיקום הגיאוגרפי של כתובת ה-IP של שרת האינטרנט

רשימה של ערכים חוקיים לפרמטר הזה מופיעה בדף ערכים של פרמטר מדינה.
cx

string

מזהה Programmable Search Engine שישמש בבקשה הזו.
dateRestrict

string

הגבלת התוצאות לכתובות URL על סמך תאריך. הערכים הנתמכים כוללים:

  • d[number]: מבקש תוצאות ממספר הימים האחרונים שצוין.

  • w[number]: מבקש תוצאות ממספר השבועות האחרונים שצוין.

  • m[number]: מבקשת תוצאות ממספר החודשים האחרונים שצוין.

  • y[number]: מבקש תוצאות ממספר השנים האחרונות.
exactTerms

string

מזהה ביטוי שכל המסמכים בתוצאות החיפוש חייבים להכיל.
excludeTerms

string

מזהה מילה או ביטוי שלא אמורים להופיע באף מסמך בתוצאות החיפוש.
fileType

string

הגבלת התוצאות לקבצים של תוסף שצוין. במרכז העזרה של Search Console תוכלו למצוא רשימה של סוגי קבצים ש-Google יכולה להוסיף לאינדקס.
filter

string

המדיניות הזו קובעת אם מפעילים או משביתים את מסנן התוכן הכפול.

  • למידע נוסף על מסנני תוצאות החיפוש של Google, אפשר לעיין במאמר סינון אוטומטי. שימו לב שסינון הצפיפות של המארח חל רק על חיפושים באתרים מרובים.

  • כברירת מחדל, Google מחילה את הסינון על כל תוצאות החיפוש כדי לשפר את האיכות של התוצאות האלה.

הערכים הקבילים הם:

  • 0: השבתה של מסנן התוכן הכפול.

  • 1: הפעלה של מסנן התוכן הכפול.
gl

string

המיקום הגיאוגרפי של משתמש הקצה.

  • ערך הפרמטר gl הוא קוד מדינה בן שתי אותיות. הפרמטר gl מגדיל את תוצאות החיפוש שמדינת המקור שלהן תואמת לערך הפרמטר. אפשר למצוא רשימה של ערכים חוקיים בדף קודי מדינות.

  • ציון ערך הפרמטר gl אמור להוביל לתוצאות רלוונטיות יותר. הדבר נכון במיוחד ללקוחות בינלאומיים, ובאופן ספציפי יותר ללקוחות במדינות דוברות אנגלית מחוץ לארה"ב.
googlehost

string

הוצא משימוש. כדי להשיג השפעה דומה, משתמשים בפרמטר gl.

הדומיין המקומי של Google (לדוגמה, google.com , google.de או google.fr) שבו רוצים להשתמש לביצוע החיפוש.
highRange

string

מציינת את ערך הסיום של טווח חיפוש.

  • אפשר להשתמש ב-lowRange וב-highRange כדי לצרף לשאילתה טווח חיפוש כולל של lowRange...highRange.
hl

string

המדיניות הזו מגדירה את שפת ממשק המשתמש.
hq

string

מצרף את מונחי השאילתה שצוינו לשאילתה, כאילו הם שולבו עם אופרטור AND לוגי.
imgColorType

enum (ImgColorType)

מחזירה תמונות בשחור-לבן, תמונות בגווני אפור, תמונות שקופות או תמונות צבעוניות. הערכים הקבילים הם:

  • "color"

  • "gray"

  • "mono": שחור ולבן

  • "trans": רקע שקוף
imgDominantColor

enum (ImgDominantColor)

מחזירה תמונות בצבע דומיננטי מסוים. הערכים הקבילים הם:

  • "black"

  • "blue"

  • "brown"

  • "gray"

  • "green"

  • "orange"

  • "pink"

  • "purple"

  • "red"

  • "teal"

  • "white"

  • "yellow"
imgSize

enum (ImgSize)

מחזירה תמונות בגודל שצוין. הערכים הקבילים הם:

  • "huge"

  • "icon"

  • "large"

  • "medium"

  • "small"

  • "xlarge"

  • "xxlarge"
imgType

enum (ImgType)

מחזירה תמונות מסוג. הערכים הקבילים הם:

  • "clipart"

  • "face"

  • "lineart"

  • "stock"

  • "photo"

  • "animated"
lowRange

string

מציינת את הערך ההתחלתי של טווח חיפוש. אפשר להשתמש ב-lowRange וב-highRange כדי לצרף לשאילתה טווח חיפוש כולל של lowRange...highRange.
lr

string

מגבילה את החיפוש למסמכים שנכתבו בשפה מסוימת (למשל, lr=lang_ja).

הערכים הקבילים הם:

  • "lang_ar": ערבית

  • "lang_bg": בולגרית

  • "lang_ca": קטלאנית

  • "lang_cs": צ'כית

  • "lang_da": דנית

  • "lang_de": גרמנית

  • "lang_el": יוונית

  • "lang_en": אנגלית

  • "lang_es": ספרדית

  • "lang_et": אסטונית

  • "lang_fi": פינית

  • "lang_fr": צרפתית

  • "lang_hr": קרואטית

  • "lang_hu": הונגרית

  • "lang_id": אינדונזית

  • "lang_is": איסלנדית

  • "lang_it": איטלקית

  • "lang_iw": עברית

  • "lang_ja": יפנית

  • "lang_ko": קוריאנית

  • "lang_lt": ליטאית

  • "lang_lv": לטבית

  • "lang_nl": הולנדית

  • "lang_no": נורווגית

  • "lang_pl": פולנית

  • "lang_pt": פורטוגזית

  • "lang_ro": רומנית

  • "lang_ru": רוסית

  • "lang_sk": סלובקית

  • "lang_sl": סלובנית

  • "lang_sr": סרבית

  • "lang_sv": שוודית

  • "lang_tr": טורקית

  • "lang_zh-CN": סינית (פשוטה)

  • "lang_zh-TW": סינית (מסורתית)
num

integer

מספר תוצאות החיפוש שיש להחזיר.

  • הערכים החוקיים הם מספרים שלמים בין 1 ל-10, כולל.
orTerms

string

מספק מונחי חיפוש נוספים לבדיקה במסמך, כשכל מסמך בתוצאות החיפוש חייב להכיל לפחות אחד ממונחי החיפוש הנוספים.
q

string

שאילתה
relatedSite
(deprecated)

string

הוּצא משימוש.
rights

string

מסננים שמבוססים על רישוי. הערכים הנתמכים כוללים: cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived ושילובים של הערכים האלה. מידע נוסף זמין בשילובים אופייניים.
safe

enum (Safe)

רמת הבטיחות של החיפוש. הערכים הקבילים הם:

  • "active": הפעלת הסינון של החיפוש הבטוח.

  • "off": משבית את הסינון של חיפוש בטוח. (ברירת מחדל)
searchType

enum (SearchType)

מציין את סוג החיפוש: image. אם לא צוין אחרת, התוצאות מוגבלות לדפי אינטרנט.

הערכים הקבילים הם:

  • "image": חיפוש תמונות בהתאמה אישית.
siteSearchFilter

enum (SiteSearchFilter)

המדיניות קובעת אם לכלול או להחריג תוצאות מהאתר שצוין בפרמטר siteSearch.

הערכים הקבילים הם:

  • "e": לא לכלול

  • "i": כולל
sort

string

ביטוי המיון שיש להחיל על התוצאות. פרמטר המיון מציין שהתוצאות ימוינו לפי הביטוי שצוין, כלומר מיון לפי תאריך. דוגמה: sort=date.
start

integer (uint32 format)

האינדקס של התוצאה הראשונה שיש להחזיר. מספר ברירת המחדל של תוצאות לדף הוא 10, כך ש-&start=11 יתחיל בראש דף התוצאות השני. הערה: JSON API לעולם לא יחזיר יותר מ-100 תוצאות, גם אם יותר מ-100 מסמכים תואמים לשאילתה, ולכן הגדרת הסכום של start + num למספר גדול מ-100 תיצור שגיאה. כמו כן, חשוב לשים לב שהערך המקסימלי של num הוא 10.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול מופע של Search.

היקפי הרשאות

נדרש היקף OAuth הבא:

  • https://www.googleapis.com/auth/cse

למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.