Method: projects.locations.userEvents.collect

ブラウザから 1 つのユーザー イベントを書き込みます。こちらは、サードパーティ ドメインに対する POST がブラウザで制限されているため、GET リクエストを使用します。

このメソッドは、Discovery Engine API の JavaScript Pixel と Google タグ マネージャーでのみ使用されます。ユーザーは、このメソッドを直接呼び出す必要はありません。

HTTP リクエスト

GET https://discoveryengine.googleapis.com/v1/{parent=projects/*/locations/*}/userEvents:collect

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

パスパラメータ

パラメータ
parent

string

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

クエリ パラメータ

パラメータ
userEvent

string

必須。長さの上限が 2,000,000 文字の URL エンコードされた UserEvent proto。
uri

string

cgi パラメータを含むが、ハッシュ フラグメントを含まない URL。長さの上限は 5,000 文字です。多くのブラウザはサードパーティのリクエストに対してのみドメインを送信するため、リファラー URL よりも有用な場合が多々あります。
ets

string (int64 format)

イベントのタイムスタンプ（ミリ秒単位）。これにより、同一の GET リクエストがブラウザにキャッシュ保存されるのを防ぐことができます。ペイロード バイトを削減するため、名前は簡潔になっています。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功した場合、レスポンスはメソッドによって定義された形式の汎用 HTTP レスポンスになります。

認可スコープ

次の 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 をご覧ください。