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,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "searchHistorySuggestion": string,
  "removeAllSearchHistorySuggestions": boolean
  // End of mutually exclusive fields.
}
שדות
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".
ההצעה שרוצים להסיר. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
searchHistorySuggestion

string

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

boolean

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

גוף התשובה

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

היקפי הרשאות

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

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

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

הרשאות IAM

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

  • discoveryengine.completionConfigs.removeSuggestion

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