- בקשת HTTP
- גוף הבקשה
- גוף התשובה
- היקפי ההרשאות
- SuggestResult
- QuerySuggestion
- PeopleSuggestion
- רוצים לנסות?
הצגת הצעות להשלמה אוטומטית של השאילתה.
הערה: כדי להפעיל את ה-API הזה, נדרש חשבון רגיל של משתמש קצה. חשבון שירות לא יכול לשלוח בקשות API של שאילתה באופן ישיר. כדי להשתמש בחשבון שירות לביצוע שאילתות, צריך להגדיר הענקת סמכויות ברמת הדומיין ב-Google Workspace.
בקשת HTTP
POST https://cloudsearch.googleapis.com/v1/query/suggest
בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{ "requestOptions": { object ( |
שדות | |
---|---|
requestOptions |
אפשרויות בקשה, כמו אפליקציית החיפוש ואזור הזמן של המשתמש. |
query |
שאילתה חלקית שיוצגו עבורה הצעות להשלמה אוטומטית. לדוגמה, אם השאילתה היא "ים", השרת עשוי להחזיר "עונה", "חיפוש", "שחף" וכן הלאה. |
dataSourceRestrictions[] |
המקורות לשימוש בהצעות. אם לא מציינים שום אפשרות, מקורות הנתונים נלקחים מאפליקציית החיפוש הנוכחית. הערה: ההצעות נתמכות רק עבור המקורות הבאים:
|
גוף התגובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:
תגובה של ממשק ה-API המוצע.
ייצוג JSON |
---|
{
"suggestResults": [
{
object ( |
שדות | |
---|---|
suggestResults[] |
רשימת ההצעות. |
היקפי הרשאות
כדי להשתמש בתכונה הזו יש צורך באחד מההיקפים הבאים של OAuth:
https://www.googleapis.com/auth/cloud_search.query
https://www.googleapis.com/auth/cloud_search
למידע נוסף, ניתן לעיין במדריך ההרשאות.
SuggestResult
תוצאה אחת של הצעה.
ייצוג JSON |
---|
{ "suggestedQuery": string, "source": { object ( |
שדות | |
---|---|
suggestedQuery |
השאילתה המוצעת שתשמש לחיפוש, כאשר המשתמש ילחץ על ההצעה |
source |
מקור ההצעה. |
שדה איחוד suggestion . מכיל מטא-נתונים נוספים על השאילתה המוצעת. הוא מציין גם את סוג השאילתה המוצעת. לדוגמה, אם קיימת הצעה ב-PeopleSuggestion, הוא מציין ש-suggested_query היא הצעה של אדם. הערך של suggestion יכול להיות רק אחת מהאפשרויות הבאות: |
|
querySuggestion |
שדה זה יהיה נוכח אם השאילתה המוצעת היא השלמת מילה/ביטוי. |
peopleSuggestion |
הערך הזה מוצג כשההצעה מציינת אדם. ההודעה מכילה מידע נוסף על האדם, כמו מזהה האימייל, השם שלו וכו'. |
QuerySuggestion
השדה הזה לא מכיל כרגע דבר, והוא משמש רק כאינדיקציה לכך שהתוצאה המוצעת הייתה השלמת ביטוי.
PeopleSuggestion
שדה זה מכיל מידע על האדם שהוצע.
ייצוג JSON |
---|
{
"person": {
object ( |
שדות | |
---|---|
person |
הצעה לאדם. ייתכן שלא כל השדות של אובייקט האדם לא יאוכלסו. |