Method: query.suggest

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

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

גוף הבקשה

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

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

object (RequestOptions)

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

string

שאילתה חלקית שעבורה יוצגו הצעות להשלמה אוטומטית. לדוגמה, אם השאילתה היא 'sea', יכול להיות שהשרת יחזיר את הערכים 'season',‏ 'search',‏ 'seagull' וכו'.
dataSourceRestrictions[]

object (DataSourceRestriction)

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

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

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

גוף התשובה

התגובה של Suggest 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)

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