イベント
イベントは、エンドユーザーがブランドとやり取りするときに実行するアクティビティです。
例:
- メール内のリンクを開く
- アプリでカートにアイテムを追加する
- ウェブサイト上のフォームで電話番号を更新する。
エンド ユーザーがアクションを実行すると、そのアクションに関する情報がイベントとして People に保存されます。
例: エンド ユーザーがリンクを操作するときに、次の情報を People に保存できます。
- アクションの種類 (クリックまたは開く)
- アクションのソース (Web ページまたはアプリ)
- アクションが実行された時刻
- リンクがクリックされた Web ページ
その後、この情報をさまざまな方法で使用できます。例: イベントが発生したときにエンドユーザーにメッセージを送信したり、ウェブにアクセスしたエンドユーザーの数を分析したりします。
イベントを表示するには、終了ユーザーのプロファイルページの属性、タグ、Eventsタブに移動します。
イベントの使用方法
次に、イベントの使用方法の例を示します。
- イベントデータを使用してエンドユーザーをフォローアップします。例: エンド ユーザーがカート内のアイテムを放棄すると、放棄されたカート イベントがログに記録されます。サポートが必要かどうかを尋ねるフォローアップメールを送信します。
- イベントデータの分析によって、エンドユーザーの行動パターンを理解します。
- イベントデータを使用して、エンドユーザーに関連製品を推奨します。例: エンド ユーザーが携帯電話を購入した場合、イベント 購入したアイテム がログに記録されます。モバイルバッテリーやイヤホンなどのアクセサリーをお勧めします。
- イベントデータを使用して オーディエンスをセグメント化。例: ウェブサイトで特定の製品を閲覧するエンドユーザーにのみフォローアップメールを送信します。
- イベントを使用して、エンドユーザーにメッセージをパーソナライズします。
- 計算済み属性でイベントを使用します。イベント集計のイベントデータに対して計算を行い、プロファイルスコアリングを実行するときにプロファイルを評価できます。
イベントの種類
Events には次の種類があります。
-
カスタムイベント: これらは、ウェブサイト、モバイルアプリ、その他のプラットフォームやアプリケーションなどのデジタルアセットのユーザーアクティビティを追跡するためにPeopleで作成するイベントです。カスタムイベントは、お客様のビジネスに固有のものです。
-
テンプレート events: イベント properties が事前に入力されたイベントテンプレートで、e コマースなどの一般的なユースケースに合わせてカスタマイズして使用できます。
-
標準イベント: 次の場合に発生する定義済みのイベント。
- Moments、Conversations、Answersなどの NTTCPaaS 製品を通じてエンドユーザーと通信する際。
- 個人プロファイル(属性、宛先またはタグ)が更新されたとき。
標準イベントには、People events、チャネル events、Product events が含まれます。
カスタム Events [#events-custom-events]
これらは、Web サイト、モバイル アプリ、その他のプラットフォームやアプリケーションなどのデジタル資産でのエンド ユーザー アクティビティを追跡するために People で作成するイベントです。カスタムイベントは、お客様のビジネスに固有のものです。
カスタムイベントを作成する
-
NTT CPaaSのWebインターフェース で、People > Events (イベント) > Custom events (カスタムイベント) タブに移動します。
-
[イベントの作成] を選択します。
-
イベント名 フィールドに、イベントの名前を入力します。例: AddedToCart。
-
Event ID (イベントID) が一意であることを確認します。このフィールドはイベント名に基づいて自動的に入力されます。このIDは、NTT CPaaS APIやSDKを通じてイベントを追跡する時に使用します。
-
(オプション)説明 フィールドに、イベントの説明を入力します。
-
(オプション)プロパティを必要な数だけ作成します。
イベントにプロパティを追加するには、次の操作を行います。
-
[イベント プロパティの追加] を選択します。
-
名前 フィールドで、プロパティの名前を指定します。名前は、次の基準に従う必要があります。
- 英数字
- 小文字のアルファベットで始まる必要があります
- 最大 128 文字まで入力できます。
-
タイプ フィールドで、プロパティのデータ型を選択します。
プロパティのデータ型とイベントプロパティの詳細については、イベントプロパティ のドキュメントを参照してください。
-
イベントのプロパティ [#properties-custom-events]
イベント プロパティを使用すると、イベントに追加情報を追加できます。
次の表に、いくつかの例を示します。
| 出来事 | プロパティ |
| カートに追加されたアイテム | アイテム名 アイテム価格 |
| フォームの記入 | 入力されたフィールド |
| 購入した航空券 | 旅行の種類 |
| サポートチケットのクローズ | チケットID 休館日 |
プロパティのデータ型
イベントプロパティには、次のデータ型を指定できます。
| データ型 | 形容 | 仕様 |
| テキスト | テキスト形式のプロパティに使用します。 例: productName と productDescription。 | プロパティ値には、最大 1,500 文字を含めることができます。 |
| 真/偽 | True または False 値を含むブール型プロパティに使用します。 | |
| 日付 | 日付値を含むプロパティに使用します。 | |
| 数 | 数値形式のプロパティに使用します。例: productPrice | |
| リスト | リストをプロパティとして追加します。 例:エンドユーザーのショッピングカートに関する情報をWebサイトからMomentsのフローに渡すには、List タイプのcartItems プロパティを作成します。このプロパティに、品目名、品目 ID、数量、価格 などのフィールドを追加します。 | イベントには、最大 1 つの List プロパティを追加できます。 List プロパティには、最大 128 個のフィールドを追加できます。 |
イベントのテスト送信
-
NTT CPaaSのWebインターフェース で、People > Events (イベント) > Web SDK タブに移動します。
-
試してみる セクションで、イベントとそれに関連するユーザープロファイルを選択します。
-
[イベントの送信] を選択します。
イベントがユーザーのプロファイル ページに追加されます。
現在、テストイベントでリストプロパティの値を設定することはできません。
プラットフォーム上のカスタムイベントをトラッキングする [#events-custom-events-track]
カスタムイベントは、次の方法で追跡できます。
- Web SDK
- API
- モバイルSDK
Web SDK [#web-sdk-custom-events]
Web SDK を使用すると、Web サイトからイベントをキャプチャできます。Web SDKコードをWebサイトに追加し、それを使用してカスタムイベントをトラッキングする方法については、guidelinesおよびWeb SDKドキュメントを参照してください。
Events API [#events-api-custom-events]
APIは、他のシステムからNTT CPaaSにイベントを送信する安全な方法と考えられています。
既定では、イベントは既存の People プロファイルにのみ送信できます。API 呼び出しでオプションのパラメーターを設定して、指定したユーザー ID のプロファイルが存在しない場合に新しいプロファイルを自動的に作成できます。
実装の詳細については、guidelinesおよび 開発者ガイドを参照してください。
モバイルSDK [#mobile-sdk-custom-events]
モバイル SDK を使用して、モバイルアプリケーションからイベントをキャプチャします。
次のタイプのイベントをキャプチャできます。
-
標準アプリイベント は、モバイルアプリにモバイルSDKが実装されているすべてのMomentsユーザーに対して有効になります。これらのイベントを追跡するために追加のアクションを実行する必要はありません。例: アプリケーションがインストールされました。
利用可能なモバイルアプリイベントのリストについては、チャネル Eventsセクションを参照してください。
-
カスタム イベント は、エンド ユーザーのアクティビティを追跡するために作成および構成するイベントです。Mobile SDK を使用してカスタムイベントを追跡できます。例: エンドユーザーがショッピングカートにアイテムを追加したり、アイテムを購入したり、オンボーディングプロセスのステップを完了したりするときに、Mobile SDK を使用してカスタムイベントを送信します。
モバイルイベントトラッキングの設定方法については、以下をご覧ください。
- iOSの場合
- AndroidとHuaweiSDK
- リアクトネイティブプラグイン
- コルドバプラグイン
- フラッタープラグイン
モバイルSDKでは、イベントのトラッキングリストプロパティはサポートされていません。詳細については、NTT CPaaS アカウントマネージャーにお問い合わせください。
ガイドライン [#guidelines-custom-events]
カスタム イベント が Web SDK または Events API の呼び出しを介して送信される場合、イベント スキーマと イベント スキーマの間に 1 対 1 のマッピングが必要です。
以下のガイドラインが適用されます。
- 呼び出しにスキーマで定義されているよりも多くのプロパティが含まれている場合、その呼び出しは拒否されます。
- 呼び出しに含まれるプロパティがスキーマで定義されている数よりも少ない場合、呼び出しに含まれていないプロパティのイベントの値は NULL になります。
- スキーマと一致しないプロパティが呼び出しに含まれている場合、その呼び出しは拒否されます。例: イベント スキーマのプロパティは大文字ですが、イベント呼び出しのプロパティは小文字です。
- プロパティ値が文字列の場合は、引用符で囲んで追加します。そうでない場合は、引用符を使用しないでください。
- イベントにプロパティがない場合でも、JSON 本文を送信する必要があります。この場合、空の JSON 本文を送信します。 例: {{}}
テンプレート Events [#events-template-events]
イベントテンプレートには イベント properties があらかじめ入力されており、カスタマイズして e コマースなどの一般的なユースケースで使用できます。
テンプレートには、必須フィールドと省略可能なプロパティの両方が含まれています。
次の表に、テンプレート イベントの一覧を示します。このイベントテンプレートのリストを Web インターフェイスで表示するには、[People] > [Events] > [テンプレート events] タブに移動します。
| テンプレート名 | 目的 | プロパティ |
|---|---|---|
| itemViewed (アイテム ビュー済み) | このイベントには、プロファイルによって表示されるアイテムの詳細が表示されます。 | itemID: 数値。必須 duration: 数値。随意 |
| itemPurchased (アイテム購入済み) | このイベントには、プロファイルによって行われた購入の詳細が表示されます。 | itemID: 数値。必須 amount: 数値。随意 価格: 数値。随意 利益: 数値。随意 |
| 評価追加済み | このイベントは、プロファイルがアイテムに与えた評価を示します。 | itemID: 数値。必須 評価: 10 進数。随意 |
| カートに追加されました | このイベントには、プロファイルがカートに追加したアイテムの詳細が表示されます。 | itemID: 数値。必須 amount: 数値。随意 価格: 数値。随意 |
| addedToFavourites (お気に入りに追加されました) | このイベントは、特定のアイテムがプロファイルによってブックマークされたことを示します | itemID: 数値。必須 |
| viewPortionSet (ビュー ポーション セット) | このイベントは、セッション内のプロファイルによるビデオや記事などの項目の部分的なビューを示します。 | itemID: 数値。必須 部分: 10 進数。随意* sessionID: 文字列。随意** * 部分は、項目の表示部分を示します。これは、0.0 (未表示の項目) から 1.0 (完全に表示された項目) までの数値です。 表示される部分は、アイテムが表示された位置によって異なります。例: エンド ユーザーが 50% で動画を開き、その後 10% しか視聴しない場合、** 部分** は 0.6 ではなく 0.1 になります。 ** エンド ユーザーがアイテムを表示したセッションの ID。既定値は null です。 |
標準 Events [#events-standard-events]
標準イベントは、エンドユーザーが Moments、Conversations、Answers などの NTTCPaaS 製品を介してお客様のサービスとやりとりする際に生成されます。
これらのイベントは、これらの製品のイベントをサポートするすべての要素で使用できます。例: Momentsでは、トリガーなどの要素でイベントを使用できます。
標準イベントを有効または無効にする [#enable-disable-standard-events]
NTT CPaaS 製品でイベントを使用するには、People でイベントを有効にする必要があります。
イベントを有効または無効にするには、次の操作を行います。
- NTT CPaaSのWebインターフェース で、People > Events (イベント) に移動します。
- 必要なイベント カテゴリ (People イベント または 製品イベント) に移動します。
- イベントを追跡するには、イベントの横にあるチェックボックスをオンにします。
- イベントの追跡を停止するには、イベントの横にあるチェックボックスの選択を解除します。
- 変更を保存するには、[イベントのアクティブ化] を選択します。
製品イベント を有効にすると、イベントに基づいて プロファイルが自動的に作成されます。これらのイベントは、このオプションに同意した場合にのみアクティブ化できます。
標準イベントの種類
標準イベントには、次のものが含まれます。
People Events [#people-events-standard-events]
People イベントは、ユーザープロファイルに変更があったときにトリガーされます。変更は次のいずれかになります。
- ユーザー アクティビティ: エンド ユーザーによって実行されるアクティビティ。例: ログインしています。
- 標準属性: 標準属性への変更。
- カスタム属性: カスタム属性への変更。
これらのプロファイルの更新に基づいてパーソナライズされたメッセージを作成できます。
人物活動
人物アクティビティイベントのユースケース
- 匿名訪問者のWebサイト訪問を追跡する:匿名訪問者からリードとコンバージョンに至るまでのエンドユーザーのジャーニーを追跡します。
- ターゲットを絞ったオファリング:人が月に5回あなたの 住宅ローン ページを訪問した場合、住宅ローンのオファーとアドバイスについてメールを送信します。
- 特定のカテゴリのプロモーション コード: エンド ユーザーが 1 週間以内に 靴 ページを 3 回閲覧した場合、靴のプロモーション コードを記載したメッセージを送信します。
- 再アクティブ化: 過去 45 日間にウェブページにアクセスしていないエンドユーザーを含む再アクティブ化キャンペーンStart。
- 放棄されたカート:エンドユーザーが チケットの検索 ページにアクセスし、チケットの選択 ページに移動しますが、チェックアウト ページには移動しません。
- アクティブな顧客向けのアンケート: エンド ユーザーが 30 日間で 100 ページ ビューを超える場合は、アンケートを送信します。
Web サイトでの人物アクティビティ イベントの追跡
Web サイトでの 人物アクティビティ イベントをトラッキングするには、JavaScript ベースの Web SDK を Web サイトに追加します。詳細については、Web SDKを参照してください。
Person アクティビティ イベントの種類
- セッションが開始されました
- ページビュー
- セッション終了
- 作成されたユーザー
- マージされたユーザー
セッションが開始されました
このイベントは、エンド ユーザーが Web サイトにアクセスしたときにログに記録されます。
各 セッション開始 イベントには、Web SDK によって自動的に入力される次のプロパティが含まれています。
| 財産 | 形容 |
|---|---|
| セッション ID | 一意のセッション識別子 |
| セッション開始 | セッションが開始された時刻。 形式は DD/MM/YYYY HH:MM:ss です。 |
| セッションの種類 | ウェブ |
| UTM パラメーター | utm_source utm_medium utm_campaign utm_term utm_content 「セッションタイプ」が「Web」で、ページリクエストに UTM タグが設定されていない場合、utm_sourceは「direct」に設定されます。 |
ページビュー
このイベントは、エンド ユーザーが Web ページを表示したときにログに記録されます。このイベントを使用して、これらのビューに基づいてエンド ユーザーを引き付けます。例: エンド ユーザーが 靴 ページを週に 3 回閲覧した場合、靴のプロモーション コードを記載したメッセージを送信します。
各 ページビュー イベントには、Web SDK によって自動的に入力される次のプロパティが含まれています。
| 財産 | 種類 | 形容 |
|---|---|---|
| ページタイトル | 糸 | 現在のページのタイトル。 |
| URL (英語) | 糸 | PageView 用に読み込まれたページの URL。 このプロパティ値には、最大 1,500 文字を含めることができます。URL がこの制限を超えると、プロパティ値は 1,500 文字に切り捨てられます。 |
| ドメイン | 糸 | 要求 URL のドメイン部分。 |
| パス | 糸 | URL のパス部分。この値は、スラッシュ (/) 文字で始まる必要があります。 |
| デバイスタイプ | 糸 | ページの読み込みに使用されるデバイスの種類。 このプロパティには、次の値を指定できます。 不明 モビール 錠剤 デスクトップ 蜘蛛 テレビ 慰める |
| タイムスタンプ | 日時 | インタラクションが発生した時刻 (日付、時、分、秒)。 |
| ブラウザ名 | 糸 | ブラウザ名(Chrome や Firefox など) この情報は、HTTP 要求の User-Agent ヘッダーから取得されます。 |
| browserVersion (ブラウザ バージョン) | 糸 | 報告されたブラウザのソフトウェアバージョン。 この情報は、HTTP 要求の User-Agent ヘッダーから取得されます。 |
| ブラウザOS | 糸 | ブラウザーが実行されている報告されたオペレーティング システム。例: Windows または Linux。 この情報は、HTTP 要求の User-Agent ヘッダーから取得されます。 |
| リファラー | 糸 | Referrer HTTPリクエストヘッダーには、リクエストを行うページの絶対アドレスまたは部分アドレスが含まれています。 |
| ブラウザ言語 | 糸 | ブラウザーの言語。 |
| ウェブサイト言語 | 糸 | ウェブサイトの言語。 |
セッション終了
このイベントは、エンド ユーザーが Web サイトでアクティブでなくなったときにログに記録されます。
各セッション終了イベントには、Web SDK によって自動的に入力される次のプロパティが含まれています。
| 財産 | 形容 |
|---|---|
| セッション ID | 一意のセッション識別子 |
| セッション終了 | セッションが終了した時刻。 形式は DD/MM/YYYY HH:MM:ss です。 |
| セッションの長さ | セッション終了 - セッション Start。 数秒で。 |
| セッションの種類 | ウェブ |
| タイプ別終了 | セッションがエンド・ユーザーまたはシステムのどちらによって終了したかを示します。 値は USER と SYSTEM です。 |
| UTM パラメーター | utm_source utm_medium utm_campaign utm_term utm_content 「セッションタイプ」が「Web」で、ページリクエストに UTM タグが設定されていない場合、utm_sourceは「direct」に設定されます。 |
作成されたユーザー
このイベントは、ユーザープロファイルが作成されたときにログに記録されます。
マージされた人
このイベントは、個人プロファイルがマージされたときにログに記録されます。
標準属性 [#standard-attributes-standard-events]
プロファイルの標準属性への変更を追跡します。
次の標準属性を追跡できます。
- ユーザープロファイルの名前の変更: 個人の名、ミドルネーム、姓の変更。
- ユーザープロファイルの場所の変更: 住所、市区町村、国の変更。
- ユーザープロファイルのその他の変更: 例: 生年月日。
- タグの変更: タグがプロファイルに追加されたり、プロファイルから削除されたりします。
- 連絡先情報: その人と連絡を取ることができるチャネルの追加または削除。
連絡先 [#contact-information-standard-events]
ユーザープロファイルでは、次の連絡先情報イベントを使用できます。
| 連絡先情報の種類 | イベント |
|---|---|
| 電子メール | メールアドレスが追加されました メールアドレスが変更されました メールアドレスが削除されました |
| 押す | プッシュ通知連絡先が追加されました プッシュ通知連絡先が変更されました プッシュ通知連絡先が削除されました これらのプッシュ先イベントは、モバイルアプリでのエンドユーザーのアクティビティに関する情報を提供します。これらのイベントは Mobile SDK によって生成され、People の個人プロファイルに表示されます。 |
| フェイスブック | Facebookの連絡先が追加されました Facebookの連絡先が変更されました Facebookの連絡先が削除されました |
| SMS/Voice/MMS | 電話番号が追加されました 電話番号が変更されました 電話番号が削除されました |
| その他の連絡先情報 | 連絡先情報が変更されました |
カスタム属性 [#custom-attributes-standard-events]
プロファイルのカスタム属性への変更を追跡します。
People の ユーザー インターフェイスの煩雑さを最小限に抑えるには、使用する予定のない attributes を含めないでください。
チャネル Events [#channel-events-standard-events]
これらのイベントは、エンド ユーザーとの通信に使用されるチャネルに固有です。チャネルイベントを使用して、メッセージのステータスと、メッセージに対する顧客の反応を追跡します。
デフォルトでは、すべてのチャネルイベントがアクティブです。そのため、構成中に変更を加える必要はありません。
次の表は、チャネルでサポートされるイベントを示しています。
| チャンネル | イベント名 |
|---|---|
| 電子メール | 送信 配信 開けた クリック 退会 不満 |
| モバイルプッシュ | 送信 配信 開けた |
| アプリ内メッセージ | 送信 配信 見て クリック |
| SMS | 送信 配信 クリック |
| 送信 配信 開けた クリック | |
| Viber | 送信 配信 開けた クリック |
| メッセンジャー | 送信 配信 開けた クリック |
| モバイルアプリ | パーソナライズ 非個人化 取り付ける アンインストール アプリの起動 |
| 声 | Voice 通話開始 応答された Voice 通話 Voice 通話に応答しない Voiceビジー 機械が応答した Voice 通話 応答された Voice 着信コール 話中転送コール(Call Forwarded Busy) 転送されたコールに応答がありませんでした プレイVoice IVR (自動音声応答) Voice IVR (自動音声応答) 収集される情報 Voice ユーザーが電話を切る |
| 線 | 送信 クリックされたリンク |
| MMS | 送信 配信 |
製品Events [#product-events-standard-events]
これらのイベントは特定のNTT CPaaS製品用であり、Peopleでエンドユーザーのパーソンプロファイルに追加 されます。
瞬間
次の表は、Moments の製品イベントを示しています。これらのイベントは、顧客の属性とアクティビティに基づいて、設定に従って発生します。
| 出来事 | 形容 |
|---|---|
| 入力されたフロー | 人がフローに入りました。 |
| フローが終了しました | 人がフローを出ました。 |
| フロー エントリが拒否されました | ネットワークの問題など、さまざまな理由でフローに入ることができませんでした。 |
答え
次の表は、Answers の製品イベントを示しています。
| 出来事 | 形容 |
|---|---|
| Answers セッションが開始しました | チャットボットとのセッションが開始されました。 |
| Answers セッションが終了しました | チャットボットとのセッションが終了しました。 |
| Answers セッション Start が失敗しました | ネットワークの問題など、さまざまな理由により、Answersセッションが開始されませんでした。 |
会話
次の表は、Conversations の製品イベントを示しています。
| 出来事 | 形容 |
|---|---|
| 作成された会話 | 会話が始まりました。 |
| 会話終了 | 会話が終わった。 |
フォーム
フォームに対して 処理ルール が有効になっている場合は、フォーム送信 イベントを追跡できます。その後、この情報を使用して、要求された情報をフォーム送信者に送信できます。
イベントを使用してメッセージをパーソナライズする
アプリのイベントを使用してエンド ユーザーへのメッセージをパーソナライズする方法の例を次に示します。
- Peopleで、使用する既存のイベントを特定するか、カスタムイベントの作成のいずれかを行います。
- アプリにイベントを統合 します。これで、アプリからNTT CPaaSプラットフォームにイベントを送信できるようになります。
- Momentsで、イベントによってトリガーされるフローを作成する。
- データのマッピングをイベント変数に含めます。
- フロー変数を使用して、エンドユーザーにメッセージをパーソナライズします。
イベントを使用してオーディエンスをセグメント化する
イベントを使用して、エンドユーザーの行動に基づいてオーディエンスセグメントを作成します。その後、セグメントに基づいてコミュニケーションを整理できます。例:イベントに基づいてメッセージを送信するか、エンドユーザーコンタクトセンターに電話した回数を確認するかを決定できます。
セグメントは、People の セグメント ページで作成できます。セグメントを作成するときは、イベントと属性を組み合わせて、より関連性の高いセグメンテーションを行います。
現在、List 型のイベント プロパティのセグメンテーションはサポートされていません。
次の例では、選択された属性は 国 で、イベントは タグ追加 です。
Momentsでイベントを使用する
Momentsでは、Peopleリアルタイムイベントトリガーとイベント待ちエレメントでイベントを使用できます。
標準イベントを追跡するには、People で イベントを有効にする する必要があります。
現在、List 型のイベント プロパティのセグメンテーションはサポートされていません。
People リアルタイム イベント トリガー
People で以前に定義したカスタム イベント、または事前定義された (標準) イベントに基づいて、フロー キャンペーンをトリガーします。
例: カートにアイテムを追加するすべてのエンド ユーザーにメッセージを送信するには、コミュニケーション フローで、People リアルタイム イベント トリガーとカスタム イベント アイテム カートに追加されました を使用します。
イベント エレメントを待つ
通信フローの後の段階でイベントを使用する場合は、[イベントを待つ] エレメントを使用します。
例: イベントを待つ エレメントで、待機するイベントとして チェックアウトが完了しました を選択します。このエレメントがこのイベントが発生するまで待機する必要がある時間を入力します。
People 分析でイベントを使用する
イベントは以下で使用します。
- Eventsセグメンテーション:イベントを使用して、分析するオーディエンスセグメントを作成します。
- ファネルAnalytics: ファネルのステップとして使用するイベントを選択します。
例: ファネル分析 を選択し、使用する標準イベントを選択します。
外部システムでのイベントの使用
外部システムでイベントデータを使用するには、 People API を使用して、イベントを圧縮ファイルとしてアマゾン ウェブ サービス (AWS) S3 バケットにエクスポートします。
Events エクスポート API を使用して、次の操作を行います。
- エクスポート イベント要求を送信する (投稿)
- エクスポート要求の状態を確認する (Get)
- エクスポート要求の非同期取り消し (Del)
- イベント定義の一覧を取得する (Get)
過程 [#export-events]
AWS S3 バケットのセットアップ
AWS S3バケットの設定方法については、Amazon AWSドキュメントを参照してください。
S3 バケットのアクセス許可を設定する
AWS Identity and Access Management (IAM) を使用して、Events エクスポートアプリケーションが S3 バケットにアクセスするために使用するロールを作成します。
このロールには、次のポリシーが必要です。
- S3 バケットへのアクセスを許可する S3 アクセスポリシー。
- イベントエクスポートアプリケーションのユーザーがAWS Security Token Service (AWSセキュリティトークンサービス)を使用して一時セッションを取得できるようにする信頼ポリシー。このコードは、NTT CPaaSのWebインターフェースのEvents Export (イベントエクスポート)ページから取得できます。
必要なパーミッションを設定すると、S3バケットはNTT CPaaSからエクスポートされたファイルを受け入れる準備が整います。
イベントをエクスポートする [#export-files-events-in-external-systems]
「 エクスポートイベント要求の送信」で定義されているスキーマに従って、エクスポートイベント要求を送信します。
リクエストが完了すると、イベントを含むファイルが指定された S3 バケットにエクスポートされます。ファイルを保存する S3 バケットのディレクトリパスを指定できます。
各ファイルは .gzip 形式に圧縮されます。ファイル名の形式は
<requestid>-events-<starttime(yyyymmddhhmmsssss)>-<endtime(yyyymmddhhmmsssss)>.json.gz</endtime(yyyymmddhhmmsss)></starttime(yyyymmddhhmmsssss)></requestid>.
ファイルが圧縮解除されると、最大 50,000 行が含まれます。各行には、JSON 形式のイベントが 1 つ含まれています。
イベントスキーマ [#event-schema-events-in-external-systems]
各イベントには、次のフィールドがあります。
- すべてのイベントに存在する必須フィールド。
- 各イベントに固有の追加のプロパティ。
必須フィールド
| フィールド名 | 値の形式 | 例 | 筆記 |
|---|---|---|---|
| definitionId(定義ID) | 糸 | personEnteredFlow (英語) | イベントの定義(タイプ)。「 イベント定義の一覧を取得する 」エンドポイントを参照してください。 |
| eventId(イベント ID) | 糸 | fent_100000000270199_1_1647967373262 | イベントの一意の ID。 |
| セッション ID | 糸 | 61bc52b9ba3ae43407dbb246 | People Web SDK を使用して追跡されるイベントの Web セッションの一意の ID それ以外の場合、この値は NULL です。 |
| personId(パーソン ID) | 糸 | 2342 | イベントが登録されているプロファイルの一意の内部 ID。 |
| externalPersonId (英語) | 糸 | CS26_342 | イベントが登録されているプロファイルの外部 ID。 プロファイルが存在しない場合、この値は NULL です。 |
| 発生時刻 | 糸 | 2022-09-14T15:00:35.495+0000 | システムがイベントを受信したときのタイムスタンプ (ISO-8601 形式)。 |
イベント固有のフィールド
各イベントには、アクティビティに関する追加情報を含む 1 つ以上のプロパティが含まれる場合があります。プロパティは、イベントの種類によって異なります。
標準イベントのプロパティを表示するには、イベント ID を基本URL https://portal.infobip.com/people/events/definitions/ に追加します。
例: 「https://portal.infobip.com/people/events/definitions/emailLinkClicked 」と入力すると、標準イベント「Email Link Clicked」のプロパティのリストが表示されます。
アカウントで使用可能なイベント ID の一覧については、「イベント定義の一覧を取得する」を使用します
カスタム イベントのプロパティ名が必須フィールドの名前と同じ場合、エクスポート ファイルでは、プロパティ名の先頭にイベント ID が付きます。
例: カスタム イベントの場合、プロパティは externalPersonId です。ただし、externalPersonId は必須フィールドの名前です。そのため、エクスポート ファイルでは、プロパティ名の先頭にイベント ID myCustomDefinitionID が付きます。ファイル内のプロパティ名は myCustomDefinitionID_externalPersonId になります。
Events エクスポートは、Moments によって生成されたイベントの追加プロパティを提供できます。例: campaignName。この情報をエクスポートして、外部システムで使用できます。次の表に、これらのプロパティの一覧を示します。
| フィールド名 | 値の形式 | 例 | 筆記 |
|---|---|---|---|
| キャンペーン名 | 糸 | 通信名 56 | キャンペーンの名前 (このデータが存在する場合) |
| elementName (エレメント名) | 糸 | メールを送る | フロー エレメントの名前 (このデータが存在する場合) |
| キャンペーン開始 | 糸 | 2022-06-14T10:54:30.033+0000 | キャンペーンの開始日時 (このデータが存在する場合) |
| flowElementId (フロー要素 ID) | 糸 | 10000005271386-12 | フロー エレメントの ID (このデータが存在する場合) |
この機能を有効にするには、 エクスポート イベント要求を送信するときに enrichWithMomentsInfo パラメーターを True に設定します。
イベントのデータ保持 [#data-retention-events]
Peopleイベントは、NTTCPaaSの製品およびサービスに適用されるデータ保持ポリシーに従います。イベントは限られた期間のみ保存されます。カスタム保持オプションは、ご要望に応じてご利用いただけます。保持ポリシーは、すべての イベントの種類 に適用されます。
イベントのデータ保持ポリシーは、2025 年 4 月 15 日から有効になります。
新しい保持ポリシーは、円滑な移行を確実にするために、2025 年 5 月 15 日から段階的に適用されます。
猶予期間の保護: 猶予期間は 2025 年 5 月 15 日までです。この期間中は、保持期間を過ぎた予定は削除されないため、確認と調整を行う時間が与えられます。
段階的な施行: このポリシーは、5 月 15 日から一斉にではなく、段階的に実施されます。
実装後に完全なコンプライアンスが必要: ポリシーが完全にロールアウトされると、データ保持設定が自動的に適用されます。
このセクションでは、データ保持ポリシーが、セグメント、レポート、フロートリガー、および計算属性での People イベントの使用方法にどのように影響するかについて説明します。
詳細については、データ保持ポリシーを参照してください。
データ保持のしくみ [#data-retention-how-it-works]
イベント条件を使用して検索結果をフィルタリングしたり、セグメントをクエリしたり、計算属性を計算したりする場合、システムはNTT CPaaSアカウントのイベントデータ保持期間内にあるイベントにのみアクセス可能です。イベント条件がこの期間を超えると、警告メッセージが表示されます。この場合、保持期間内に収まるように条件を調整することをご検討ください。
場合によっては、イベント条件の期間を長くすることは意図的なものです。例外 セクションを参照してください。
例外
アクティブなフローおよびイベントベースの計算属性(プロファイルスコアとイベント集計)のセグメントまたはトリガーで使用されるイベントフィルターと条件は、データ保持の影響を受けません。システムは、一致するイベントに関する必要な情報を一時的に保存し、元のイベントが保持ポリシーに従って削除された場合でも、これらのフィルタを機能させ続けます。
例: フローは 9 か月間に 3 つの製品注文を待機しています。3 番目の注文が到着するまでに、データ保持のために一部のイベントが削除されている可能性があります。ただし、必要なイベント情報が一時的に保存されるため、トリガーは引き続き機能します。
保存されたイベント データは、フローが停止するか、計算済み属性が非アクティブ化されると失われます。
この例外は、セグメント対象ユーザー エレメントには適用されません。このエレメントでは、計算時に利用可能なイベントに基づいてオーディエンスがリアルタイムで計算されるため、イベント情報は保存されません。