Method: projects.locations.collections.dataStores.userEvents.purge

제공된 필터로 지정된 모든 사용자 이벤트를 영구적으로 삭제합니다. 필터에 지정된 이벤트 수에 따라 이 작업을 완료하는 데 몇 시간 또는 며칠이 걸릴 수 있습니다. 필터를 테스트하려면 먼저 list 명령어를 사용합니다.

HTTP 요청

POST https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:purge

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
parent

string

필수 항목입니다. 이벤트가 생성되는 카탈로그의 리소스 이름입니다. 형식은 projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}입니다.

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

JSON 표현 
{
  "filter": string,
  "force": boolean
}
필드
filter

string

필수 항목입니다. 삭제할 이벤트를 지정하는 필터 문자열입니다. 길이는 5,000자로 제한됩니다. 필터링할 수 있는 필드는 다음과 같습니다.

  • eventType: 큰따옴표로 묶인 UserEvent.event_type 문자열입니다.
  • eventTime: ISO 8601 'zulu' 형식
  • userPseudoId: 큰따옴표로 묶인 문자열입니다. 이 값을 지정하면 방문자와 연결된 모든 이벤트가 삭제됩니다.
  • userId: 큰따옴표로 묶인 문자열입니다. 이 값을 지정하면 사용자와 연결된 모든 이벤트가 삭제됩니다.

참고: 이 API는 최대 30일 범위의 삭제만 지원합니다.

예:

  • 특정 기간의 모든 이벤트 삭제: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"
  • 특정 기간의 특정 eventType 삭제: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" eventType = "search"
  • 특정 기간의 특정 방문자의 모든 이벤트 삭제: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024"
  • DataStore 내에서 지난 30일의 이벤트 삭제: *

필터링 필드에는 암시적 AND가 있다고 가정됩니다.
force

boolean

force 필드는 현재 지원되지 않습니다. 사용자 이벤트 삭제 요청은 삭제 가능한 모든 이벤트를 영구적으로 삭제합니다. 개발이 완료되면 force이 false로 설정된 경우 메서드가 사용자 이벤트를 삭제하지 않고 예상되는 삭제 횟수를 반환합니다. 이 필드는 요청에 포함되지 않은 경우 기본적으로 false로 설정됩니다.

응답 본문

성공한 경우 응답 본문에 Operation의 인스턴스가 포함됩니다.

승인 범위

다음 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 권한

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

  • discoveryengine.userEvents.purge

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