Cloud Search API

Cloud Search מספק יכולות חיפוש מבוססות-ענן באמצעות נתוני Google Workspace. Cloud Search API מאפשר להוסיף לאינדקס נתונים שאינם של Google Workspace אל Cloud Search.

שירות: cloudsearch.googleapis.com

כדי להתקשר לשירות הזה, מומלץ להשתמש בספריות לקוח ש-Google מספקת. אם האפליקציה שלכם צריכה להשתמש בספריות משלכם כדי להתקשר לשירות הזה, השתמשו במידע הבא כשתבצעו את בקשות ה-API.

מסמך Discovery

מסמך Discovery הוא מפרט שמחשב יכול לקרוא כדי לתאר ולצרוך ממשקי API של REST. הוא משמש לבניית ספריות לקוח, יישומי פלאגין של IDE וכלים אחרים שיוצרים אינטראקציה עם Google APIs. שירות אחד עשוי לספק מספר מסמכי גילוי. השירות הזה מספק את מסמך הגילוי הבא:

נקודת הקצה של השירות

נקודת קצה (endpoint) היא כתובת URL בסיסית המציינת את כתובת הרשת של שירות API. ייתכן שלשירות אחד יהיו כמה נקודות קצה. לשירות הזה יש נקודת קצה (endpoint) הבאה וכל ה-URIs הבאים הם יחסיים לנקודת הקצה הזו:

  • https://cloudsearch.googleapis.com

משאב REST: v1

שיטות
initializeCustomer POST /v1:initializeCustomer
הפעלת תמיכה ב-third party ב-Google Cloud Search.

משאב REST: v1.debug.datasources.items

שיטות
checkAccess POST /v1/debug/{name=datasources/*/items/*}:checkAccess
בודקת אם הפריט הראשי נגיש.
searchByViewUrl POST /v1/debug/{name=datasources/*}/items:searchByViewUrl
מאחזר את הפריט ש-viewUrl תואם בדיוק לזה של כתובת האתר שסופקה בבקשה.

משאב REST: v1.debug.datasources.items.unmappedid

שיטות
list GET /v1/debug/{parent=datasources/*/items/*}/unmappedids
הצגת רשימה של כל הזהויות הלא ממופות של פריט ספציפי.

משאב REST: v1.debug.identitysources.items

שיטות
listForunmappedidentity GET /v1/debug/{parent=identitysources/*}/items:forunmappedidentity
מפרט שמות של פריטים המשויכים לזהות שאינה ממופה.

משאב REST: v1.debug.identitysources.unmappedid

שיטות
list GET /v1/debug/{parent=identitysources/*}/unmappedids
פירוט של זהויות משתמשים שאינן ממופות עבור מקור זהות.

משאב REST: v1.indexing.datasources

שיטות
deleteSchema DELETE /v1/indexing/{name=datasources/*}/schema
מחיקת הסכימה של מקור נתונים.
getSchema GET /v1/indexing/{name=datasources/*}/schema
מקבלת את הסכימה של מקור נתונים.
updateSchema PUT /v1/indexing/{name=datasources/*}/schema
מתבצע עדכון של הסכימה של מקור נתונים.

משאב REST: v1.indexing.datasources.items

שיטות
delete DELETE /v1/indexing/{name=datasources/*/items/*}
מחיקת Item resource עבור שם המשאב שצוין.
deleteQueueItems POST /v1/indexing/{name=datasources/*}/items:deleteQueueItems
מתבצעת מחיקה של כל הפריטים בתור.
get GET /v1/indexing/{name=datasources/*/items/*}
מקבל Item resource לפי שם פריט.
index POST /v1/indexing/{item.name=datasources/*/items/*}:index
עדכונים ב-ACL של Item, מטא-נתונים ותוכן.
list GET /v1/indexing/{name=datasources/*}/items
רשימה של כל קבוצות המשנה של Item resources או קבוצת משנה שלהן.
poll POST /v1/indexing/{name=datasources/*}/items:poll
סקרים לגבי פריטים שלא נשמרו מתור ההוספה לאינדקס ומסמנים קבוצה כהזמנה, החל מפריטים עם חותמת הזמן הישנה ביותר מהעדיפות הגבוהה ביותר ItemStatus.
push POST /v1/indexing/{item.name=datasources/*/items/*}:push
דוחף פריט לתור לסקר במועד מאוחר יותר ולעדכון.
unreserve POST /v1/indexing/{name=datasources/*}/items:unreserve
שמירת כל הפריטים ב'הבאים בתור' שומרת את כשירותם לסקר.
upload POST /v1/indexing/{name=datasources/*/items/*}:upload
יוצרת סשן העלאה של תוכן העניינים.

משאב REST: v1.media

שיטות
upload POST /v1/media/{resourceName=**}
POST /upload/v1/media/{resourceName=**}
מעלה מדיה להוספה לאינדקס.

משאב REST: v1.operations

שיטות
get GET /v1/{name=operations/**}
מקבל את המצב העדכני של פעולה ממושכת.

משאב REST: v1.query

שיטות
search POST /v1/query/search
Cloud Search Query API מספק את שיטת החיפוש, שמחזירה את התוצאות הרלוונטיות ביותר משאילתת המשתמש.
suggest POST /v1/query/suggest
מספק הצעות להשלמה אוטומטית של השאילתה.

משאב REST: v1.query.sources

שיטות
list GET /v1/query/sources
מחזירה רשימה של מקורות שבהם המשתמש יכול להשתמש עבור ממשקי API של חיפוש והצעה.

משאב REST: v1.settings

שיטות
getCustomer GET /v1/settings/customer
הגדרות הלקוח.
updateCustomer PATCH /v1/settings/customer
עדכון הגדרות הלקוח.

משאב REST: v1.settings.datasources

שיטות
create POST /v1/settings/datasources
נוצרת מקור נתונים.
delete DELETE /v1/settings/{name=datasources/*}
מחיקת מקור נתונים.
get GET /v1/settings/{name=datasources/*}
מקבל מקור נתונים.
list GET /v1/settings/datasources
מוצגת רשימה של מקורות נתונים.
patch PATCH /v1/settings/{source.name=datasources/*}
מתעדכן מקור נתונים.
update PUT /v1/settings/{source.name=datasources/*}
מתעדכן מקור נתונים.

משאב REST: v1.settings.searchapplications

שיטות
create POST /v1/settings/searchapplications
יוצרת אפליקציית חיפוש.
delete DELETE /v1/settings/{name=searchapplications/*}
מחיקת אפליקציית חיפוש.
get GET /v1/settings/{name=searchapplications/*}
מקבלת את אפליקציית החיפוש שצוינה.
list GET /v1/settings/searchapplications
רשימה של כל אפליקציות החיפוש.
patch PATCH /v1/settings/{searchApplication.name=searchapplications/*}
מתבצע עדכון של אפליקציית חיפוש.
reset POST /v1/settings/{name=searchapplications/*}:reset
מתבצע איפוס של אפליקציית חיפוש להגדרות ברירת המחדל.
update PUT /v1/settings/{searchApplication.name=searchapplications/*}
מתבצע עדכון של אפליקציית חיפוש.

משאב REST: v1.stats

שיטות
getIndex GET /v1/stats/index
הנתונים הסטטיסטיים של הפריטים שנוספו לאינדקס נצברו בכל מקורות הנתונים.
getQuery GET /v1/stats/query
קבלת נתונים סטטיסטיים לגבי השאילתה של הלקוח.
getSearchapplication GET /v1/stats/searchapplication
קבלת נתונים סטטיסטיים לגבי אפליקציית חיפוש עבור הלקוח.
getSession GET /v1/stats/session
ניתן לקבל את מספר הסשנים של חיפוש, % הביקורים שבוצעו בהצלחה עם נתונים סטטיסטיים של שאילתת קליק ללקוח.
getUser GET /v1/stats/user
קבלת נתונים סטטיסטיים לגבי משתמשים עבור הלקוח.

משאב REST: v1.stats.index.datasources

שיטות
get GET /v1/stats/index/{name=datasources/*}
קבלת נתונים סטטיסטיים לגבי פריטים שנוספו לאינדקס עבור מקור נתונים יחיד.

משאב REST: v1.stats.query.searchapplications

שיטות
get GET /v1/stats/query/{name=searchapplications/*}
קבלת נתונים סטטיסטיים לגבי שאילתות חיפוש של אפליקציית חיפוש.

משאב REST: v1.stats.session.searchapplications

שיטות
get GET /v1/stats/session/{name=searchapplications/*}
ניתן לקבל את מספר הסשנים של חיפוש, % הסשנים המובילים עם שאילתה של שאילתת קליק.

משאב REST: v1.stats.user.searchapplications

שיטות
get GET /v1/stats/user/{name=searchapplications/*}
קבלת נתונים סטטיסטיים לגבי משתמשים של אפליקציית חיפוש.