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. שירות אחד עשוי לספק כמה מסמכי גילוי. השירות הזה מספק את מסמך הגילוי הבא:

נקודת קצה (endpoint) של שירות

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

  • 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 שלו תואם בדיוק לכתובת ה-URL שצוינה בבקשה.

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

שיטות
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.unmappedids

שיטות
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 של חיפוש Google ו-Offer API.

REST Resource: 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 Resource: 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 Resource: 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/*}
קבלת הנתונים הסטטיסטיים של המשתמשים עבור אפליקציית החיפוש.