Method: projects.locations.collections.engines.completionConfig.removeSuggestion

הסרת ההצעה להיסטוריית החיפושים במנוע עבור משתמש. ההצעה הזו לא תוצג יותר ב-AdvancedCompleteQueryResponse.recent_search_suggestions למשתמש הזה. אם המשתמש יחפש שוב את אותה הצעה, ההיסטוריה החדשה תבטל את ההיסטוריה הקודמת ותציע שוב את ההצעה הזו.

בקשת HTTP

POST https://discoveryengine.googleapis.com/v1beta/{completionConfig=projects/*/locations/*/collections/*/engines/*/completionConfig}:removeSuggestion

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

פרמטרים של נתיב

פרמטרים
completionConfig

string

חובה. המאפיין completionConfig של שם משאב מנוע האב שממנו רוצים להסיר את ההצעה להיסטוריית החיפושים, כמו projects/*/locations/global/collections/default_collection/engines/*/completionConfig.

גוף הבקשה

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

ייצוג ב-JSON 
{
  "userPseudoId": string,
  "userInfo": {
    object (UserInfo)
  },
  "removeTime": string,

  // Union field suggestion can be only one of the following:
  "searchHistorySuggestion": string,
  "removeAllSearchHistorySuggestions": boolean
  // End of list of possible types for union field suggestion.
}
שדות
userPseudoId

string

חובה. מזהה ייחודי למעקב אחרי מבקרים. לדוגמה, אפשר להטמיע את זה באמצעות קובץ Cookie של HTTP, שאמור להיות מסוגל לזהות מבקר באופן ייחודי במכשיר יחיד. המזהה הייחודי הזה לא אמור להשתנות אם המבקר נכנס לאתר או יוצא ממנו.

בשדה הזה לא צריך להזין ערך קבוע כמו unknown_visitor.

המזהה הזה צריך להיות זהה למזהים UserEvent.user_pseudo_id ו-SearchRequest.user_pseudo_id.

השדה חייב להיות מחרוזת בקידוד UTF-8 עם מגבלת אורך של 128.
userInfo

object (UserInfo)

זה שינוי אופציונלי. מידע על משתמש הקצה.

פרטי המזהה צריכים להיות זהים לפרטים שמופיעים ב-UserEvent.user_info וב-SearchRequest.user_info.
removeTime

string (Timestamp format)

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

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
שדה איחוד suggestion. ההצעה שרוצים להסיר. הערך suggestion יכול להיות רק אחד מהבאים:
searchHistorySuggestion

string

ההצעה מהיסטוריית החיפושים שרוצים להסיר.
removeAllSearchHistorySuggestions

boolean

הסרת כל ההצעות להיסטוריית החיפושים של המשתמש.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יהיה ריק.

היקפי הרשאות

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

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite

ניתן למצוא מידע נוסף כאן: Authentication Overview.

הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב completionConfig:

  • discoveryengine.completionConfigs.removeSuggestion

מידע נוסף מופיע במאמרי העזרה בנושא IAM.