Method: query.suggest

הצגת הצעות להשלמה אוטומטית של השאילתה.

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

בקשת HTTP

POST https://cloudsearch.googleapis.com/v1/query/suggest

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "requestOptions": {
    object (RequestOptions)
  },
  "query": string,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ]
}
שדות
requestOptions

object (RequestOptions)

אפשרויות של בקשות, כמו אפליקציית החיפוש ואזור הזמן של המשתמש.
query

string

שאילתה חלקית שיוצגו בה הצעות להשלמה אוטומטית. לדוגמה, אם השאילתה היא "ת"א", השרת עשוי להחזיר "עונה", "חיפוש", "שחף" וכן הלאה.
dataSourceRestrictions[]

object (DataSourceRestriction)

המקורות שבהם אפשר להשתמש להצעות. אם לא מציינים זאת, מקורות הנתונים נלקחים מאפליקציית החיפוש הנוכחית.

הערה: יש תמיכה בהצעות רק למקורות הבאים:

  • מקורות נתונים של צד שלישי
  • PredefinedSource.PERSON
  • PredefinedSource.GOOGLE_DRIVE

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

התשובה להצעה של ה-API.

ייצוג JSON 
{
  "suggestResults": [
    {
      object (SuggestResult)
    }
  ]
}
שדות
suggestResults[]

object (SuggestResult)

רשימת הצעות.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud_search.query
  • https://www.googleapis.com/auth/cloud_search

מידע נוסף זמין במדריך להרשאות.

SuggestResult

תוצאה אחת של הצעה.

ייצוג JSON 
{
  "suggestedQuery": string,
  "source": {
    object (Source)
  },

  // Union field suggestion can be only one of the following:
  "querySuggestion": {
    object (QuerySuggestion)
  },
  "peopleSuggestion": {
    object (PeopleSuggestion)
  }
  // End of list of possible types for union field suggestion.
}
שדות
suggestedQuery

string

השאילתה המוצעת שתשמש לחיפוש, כשהמשתמש ילחץ על ההצעה
source

object (Source)

מקור ההצעה.
שדה איחוד suggestion. מכיל מטא-נתונים נוספים על השאילתה המוצעת. מצוין גם סוג השאילתה המוצעת. לדוגמה: אם התכונה PeopleSuggestion קיימת, היא מציינת שה-suggested_query הוא הצעה של אדם. suggestion יכול להיות רק אחת מהאפשרויות הבאות:
querySuggestion

object (QuerySuggestion)

השדה הזה יוצג אם השאילתה המוצעת היא השלמה של מילה או ביטוי.
peopleSuggestion

object (PeopleSuggestion)

הסמל הזה מוצג אם בהצעה מצוין אדם. ההודעה מכילה מידע נוסף על האדם, כמו מזהה האימייל שלו, השם שלו וכו'.

QuerySuggestion

השדה הזה לא מכיל שום דבר נכון לעכשיו והוא משמש רק כסימן לכך שהתוצאה המוצעת הייתה השלמת ביטוי.

PeopleSuggestion

השדה הזה מכיל מידע על האדם שמוצע.

ייצוג JSON 
{
  "person": {
    object (Person)
  }
}
שדות
person

object (Person)

הצעה לאדם. יכול להיות שכל השדות של אובייקט האדם לא יאוכלסו.