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

必須。訪問者をトラッキングするための一意の識別子。たとえば、これは HTTP Cookie で実装できます。これにより、1 台のデバイス上の訪問者を一意に識別できます。この一意の識別子は、訪問者がウェブサイトに対してログインまたはログアウトしても変更されません。

このフィールドには、unknown_visitor などの固定値は設定しないでください。

これは、UserEvent.user_pseudo_id および SearchRequest.user_pseudo_id と同じ識別子にする必要があります。

このフィールドは、長さの上限が 128 の UTF-8 でエンコードされた文字列にする必要があります。
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 をご覧ください。