イベントAPIリファレンス

イベントは、ユーザーがあなたのサイト上で行ったアクションを表します。これらのイベントは、クライアント側のコードを介してEvents APIを通じてContentsquareに定義され、送信されます。

JavaScriptを使用すると、どのようなアクションがイベントとして送信されるかを決定するための独自の基準を設定できます。イベントは、ページが読み込まれたとき、モーダルが表示されたとき、またはユーザーがABテストを通じてページの特定のバリエーションを見たときに送信される可能性があります。

• Events APIの呼び出し
• ベストプラクティス
• イベントのテスト

Events APIの呼び出し

以下は、Events APIへの呼び出しの基本形式です：

window._uxa.push(["event", "eventName"]);

• 最初のパラメータには常に文字列値eventが含まれている必要があります。
• 2番目のパラメータは、イベントに割り当てられたカスタム名です。上記の例では、イベント名はaction_nameですが、これはあなたが選択する任意の名前にすることができます。（例：'opened_modal', 'shown_variant_a'など）

以下は、ユーザーが登録ボタンをクリックしたときにユーザー調査をトリガーするために使用できるイベントを送信する例です：

window._uxa.push(["event", "subscribed_to_email_list"]);

イベントを実装する際の制限に注意してください

• イベントの命名

  イベント名は250文字を超えてはならず、以下のいずれかのみを含むことができます：英数字（a-z, A-Z, 0-9）、スペース、アンダースコア（_）、ダッシュ（-）、ピリオド（.）、コロン（:）およびスラッシュ（/）。

• サイトごとに10,000のユニークイベント制限があります

  サイトごとに10,000のユニークイベントをサポートしており、これらのイベントに関連付けられたユーザーの数は無制限です。これを超えると、最も使用される10,000のイベント（0-9、a-Zでソートされたもの）のみが利用可能になります。

• 現在、イベントと一緒に任意のイベントプロパティを渡すことはできません。

トップに戻る

ベストプラクティス

• 個人を特定できる情報をイベントとして渡さないでください

  個人を特定できる情報（PII）は、イベントとして使用するべきではありません。特定のユーザーとデータを接続したい場合は、代わりにユーザー属性機能を検討してください。

• Identify APIの呼び出しを行う場合、これらはEvent APIの呼び出しの前に実行する必要があります

  イベントをユーザー属性に基づくターゲティングと組み合わせて、ユーザー調査をトリガーすることを検討するかもしれません。これを設定するには、Identify APIの呼び出しがEvent APIの呼び出しの前に行われる必要があり、他のサービスへの非同期呼び出しを考慮する必要があります。Identify APIの呼び出しが完了する前にEvent APIの呼び出しが実行されると、調査は表示されません。

• イベントを使用してEメールやIPアドレス、または9桁以上の数字を収集することはできません

  現在、イベントでユーザー検索ツールを使用する方法がないため、Eメール、IPアドレス、または9桁以上の数字を収集することはできません。これは、クレジットカード番号がContentsquareに渡されるのを防ぐためです。この決定は、一般データ保護規則（GDPR）に基づいています。ユーザーの同意に基づいてEメールアドレスを収集したい場合は、GDPRに従ってユーザー属性を使用して行うことができます。

• eコマースサイトでは、特定のプロダクト情報を送信しないでください

  これにはSKUコードなどの情報が含まれます。通常、URLの方がより有用であり、デフォルトでキャプチャされます。

• GTMデータレイヤーなどのオブジェクトから値を送信する際は注意してください

  これらは、予想以上のデータを保持していることがよくあります。

• 日付やタイムスタンプのようなものを渡さないでください
• リファラルコードのようなURLからの情報を渡さないでください
• 詳細なエラーログを渡さないでください

トップに戻る

イベントのテスト

以下のステップに従うことで、あなたのEvent APIの呼び出しがContentsquareに正常に受信されているかを確認できます。ブラウザのコンソールや開発者ツールに不慣れな場合は、これらのツールに詳しいチームメンバーやウェブ開発者に協力を依頼してください。

1. ブラウザのコンソールでデバッグログを有効にします。

イベントをテストしたいページを開き、URLの末尾に?hjDebug=1パラメータを追加します。以下はその例です：

https://www.example.com/?hjDebug=1

https://www.example.com/?utm_1234&hjDebug=1

2. ブラウザのコンソールを開きます。

ブラウザの開発者ツールやコンソールに不慣れな場合は、このガイドを参照して、ブラウザのコンソールを開く方法を学んでください。

3. イベントを手動で発火させます。

イベントを手動で発火させるには、ブラウザのコンソールにEvent APIのコードを追加し、キーボードのEnterまたはReturnを押します。イベントが正常に発火した場合、以下のような確認ログが表示されます：

COMMAND: Processing command: event example_action

ユーザーが行うステップを通過して、イベントを自動的にトリガーすることをお勧めします。イベントが自動的に発火した場合、コードが成功裏に実装されていることがわかります。

手動で発火したときに同じイベントが検出されるが、ユーザージャーニーをテストしているときに自動的には検出されない場合は、イベントAPIコールが送信される基準とコードを再確認する必要があるかもしれません。

トップに戻る