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

1 つのユーザー イベントを書き込みます。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
parent

string

必須。親リソース名。ユーザー イベント書き込みアクションが DataStore レベルで適用される場合、形式は projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore} になります。ユーザー イベント書き込みアクションが Location レベル（複数の DataStore にわたる Document を含むイベントなど）で適用される場合、形式は projects/{project}/locations/{location} になります。

クエリ パラメータ

パラメータ
writeAsync

boolean

true に設定すると、ユーザー イベントは検証後に非同期で書き込まれ、API は書き込みを待たずに応答します。

リクエストの本文

リクエストの本文には UserEvent のインスタンスが含まれます。

レスポンスの本文

成功した場合、レスポンスの本文には UserEvent のインスタンスが含まれます。

認可スコープ

次の 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 権限

parent リソースに対する次の IAM 権限が必要です。

  • discoveryengine.userEvents.create

詳細については、IAM のドキュメントをご覧ください。