Cloud Search API

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

שירות: cloudsearch.googleapis.com

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

מסמך Discovery

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

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

נקודת קצה של שירות היא כתובת URL בסיסית שמציינת את כתובת הרשת של שירות API. יכול להיות שלשירות אחד יהיו כמה נקודות קצה של שירות. לשירות הזה יש נקודת קצה (endpoint) משלו, וכל כתובות ה-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
מאחזר את הפריט שכתובת ה-URL שלו זהה לכתובת ה-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
removeActivity POST /v1/query:removeActivity
מספק פונקציונליות להסרת פעילות שנרשמה ביומן של משתמש.
search POST /v1/query/search
ה-API של Cloud Search Query מספק את שיטת החיפוש, שמחזירה את התוצאות הרלוונטיות ביותר משאילתת משתמש.
suggest POST /v1/query/suggest
מספק הצעות להשלמה אוטומטית של השאילתה.

משאב REST: ‏ v1.query.sources

Methods
list GET /v1/query/sources
מחזירה רשימה של מקורות שהמשתמש יכול להשתמש בהם בממשקי ה-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/*}
קבלת נתוני השימוש של המשתמשים באפליקציית החיפוש.