Method: projects.locations.dataStores.userEvents.purge

特定のフィルタで指定されたすべてのユーザー イベントを完全に削除します。フィルタで指定されたイベントの数によっては、このオペレーションが完了するまでに数時間または数日かかることがあります。フィルタをテストするには、まずリスト コマンドを使用します。

HTTP リクエスト

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

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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 のドキュメントをご覧ください。