ユーザー イベントを管理する

このページでは、ユーザー イベント情報を表示する方法と、ユーザー イベントをパージする方法について説明します。

ユーザー イベントが発生した際の記録については、リアルタイムのユーザー イベントの記録をご覧ください。過去のイベントからユーザー イベントデータをインポートするには、過去のユーザー イベントのインポートをご覧ください。

集計されたユーザー イベント情報を表示する

アプリで記録されたユーザー イベントに関する情報は、Google Cloud コンソールのアプリの [データ] ページの [イベント] タブで確認できます。

このページには、取り込まれたイベント数、結合されていないイベント数、期間中のイベント数の増減率、ドキュメントあたりのイベントタイプの平均数などの情報が表示されます。また、各イベントタイプの指標を経時的に確認することもできます。指標は、メディアのレコメンデーションに初めてイベントをアップロードしてから約 24 時間後に表示されます。

ユーザー イベント情報を表示する手順は次のとおりです。

  1. Google Cloud コンソールで、[Agent Builder] ページに移動します。

    Agent Builder

  2. ユーザー イベント情報を表示するアプリの名前をクリックします。

  3. [データ] ページで、[イベント] タブに移動します。このタブには、ユーザー イベント情報が表示されます。

ユーザー イベントを削除する

正しく記録されていないユーザー イベントがある場合に、このイベントを削除するには、userEvents.purge API メソッドを使用します。

ユーザー イベント フィルタを使用して、削除するイベントを指定します。ユーザー イベント フィルタを使用して、パージするイベントを指定できます。 eventTime、eventType、visitorID、userID フィールドでフィルタできます。

パージを取り消すことはできないため、ユーザー イベントを削除する前に、ドライランを実行してフィルタをテストしてください。force フィールドは、デフォルトで false に設定されています。この設定の場合、ユーザー イベントは実際に削除されず、削除されるイベントの数が返されます。ユーザー イベントを実際に削除する準備ができたら、force フィールドを true に設定します。

この例では、期間でフィルタリングをします。期間は、Zulu 時間日付形式を使用する必要があります。force フィールドは false に設定されています。

curl -X POST \
  -H "Authorization: Bearer "$(gcloud auth application-default print-access-token)"" \
  -H "Content-Type: application/json; charset=utf-8" \
  --data '{
    "filter":"eventTime > \"2023-12-21T18:25:43.511Z\" eventTime < \"2023-12-21T18:30:43.511Z\"",
    "force":"false"
  }' \
  "https://discoveryengine.googleapis.com/v1/projects/PROJECT_NUMBER/locations/global/dataStores/DATA_STORE_ID/userEvents:purge"

次のようなレスポンス オブジェクトを受け取ります。ここで purge-user-events-54321 はオペレーション ID です。

{
  "name": "projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/operations/purge-user-events-54321"
}

この例では、オペレーションのステータスをリクエストします。

curl -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
"https://discoveryengine.googleapis.com/v1/projects/PROJECT_NUMBER/locations/global/dataStores/DATA_STORE_ID/operations/OPERATION_ID"

オペレーションのステータスの例:

{
  "name": "projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/operations/OPERATION_ID",
  "done": true,
  "response": {
    "@type": "type.googleapis.com/google.cloud.discoveryengine.v1.PurgeUserEventsResponse"
    "purgedEventsCount": "1"
  }
}

force フィールドを true に設定すると、強制的に削除が行われます。

curl -X POST \
  -H "Authorization: Bearer "$(gcloud auth application-default print-access-token)"" \
  -H "Content-Type: application/json; charset=utf-8" \
  --data '{
    "filter":"eventTime > \"2023-12-21T18:25:43.511Z\" eventTime < \"2023-12-21T18:30:43.511Z\"",
    "force":"true"
  }' \
"https://discoveryengine.googleapis.com/v1/projects/PROJECT_NUMBER/locations/global/dataStores/DATA_STORE_ID/userEvents:purge"

ユーザー イベント フィルタを使用する

削除するユーザー イベントをフィルタできます。

フィルタは、次の条件の 1 つ以上を含む文字列です。

  • eventTime: 削除するイベントに結びつけるタイムスタンプを指定します。このフィルタは、大なり記号（>）または小なり記号（<）とともに、1 回または 2 回指定できます。結びつける時間は、連続する単一のブロックにする必要があります。

  • eventType: 削除するイベントを単一のイベントタイプに限定します。

  • visitorID: 削除するイベントを単一の訪問者 ID に限定します。

  • userID: 削除するイベントを単一のユーザー ID に限定します。

すべての条件を満たすユーザー イベントのみが削除されます。

たとえば、2023 年 2 月 1 日以降に記録された add-to-cart タイプのすべてのユーザー イベントを削除するには、次のフィルタ文字列を指定します。

eventTime > "2023-02-01T00:00:00Z" eventType = add-to-cart

次のステップ