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 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
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

필수 항목입니다. 방문자 추적을 위한 고유 식별자입니다. 예를 들어 단일 기기에서 방문자를 고유하게 식별할 수 있는 HTTP 쿠키를 사용하여 이를 구현할 수 있습니다. 이 고유 식별자는 방문자가 웹사이트에 로그인 또는 로그아웃해도 변경되지 않아야 합니다.

이 필드에는 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)

필수 항목입니다. 추천이 삭제된 시간입니다. 설정하지 않으면 현재 시간이 사용됩니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. '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 권한

completionConfig 리소스에 대해서는 다음 IAM 권한이 필요합니다.

  • discoveryengine.completionConfigs.removeSuggestion

자세한 내용은 IAM 문서를 참조하세요.