Cloud Search API

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

שירות: cloudsearch.googleapis.com

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

מסמך Discovery

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

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

נקודת קצה של שירות היא כתובת URL בסיסית שצוינה בה כתובת הרשת של שירות API. לשירות אחד יכולות להיות כמה נקודות קצה של שירות. לשירות הזה יש את נקודת הקצה הבאה, וכל מזהי ה-URI שבהמשך הם יחסיים לנקודת הקצה הזו:

  • https://cloudsearch.googleapis.com

משאב REST: v1

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

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

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

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

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

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

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

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

Methods
list GET /v1/debug/{parent=identitysources/*}/unmappedids
הצגת זהויות משתמשים שלא מופו למקור זהויות.

משאב REST: v1.indexing.datasources

Methods
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

Methods
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

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

משאב REST: v1.operations

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

משאב REST: v1.query

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

משאב REST: v1.query.sources

Methods
list GET /v1/query/sources
הפונקציה מחזירה רשימה של מקורות שהמשתמשים יכולים להשתמש בהם לממשקי Search API ו-Suggest API.

משאב REST: v1.settings

Methods
getCustomer GET /v1/settings/customer
מקבלים את הגדרות הלקוחות.
updateCustomer PATCH /v1/settings/customer
מעדכנים את הגדרות הלקוח.

משאב REST: v1.settings.datasources

Methods
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

Methods
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

Methods
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

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

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

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

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

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

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

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