Events エクスポート
外部システムまたはアプリケーションのすべてのイベントから顧客アクティビティを使用する場合は、Events Export API を使用してイベントデータを抽出できます。エクスポートは 3 つの簡単な手順で設定できます。書き出されたイベントは、データ保持ポリシー(/customer-profiles/events/data-retention-for-events)の対象となります。
Amazon S3 バケットを設定する
Events Export API は、イベントデータを圧縮ファイルとして Amazon S3 クラウドストレージにアップロードします。
S3 バケットを設定するには:
- エクスポート用の Amazon Web Services S3 バケットを作成します。
- 次のステップのために、バケット名とリージョンをメモします。
詳細な手順については、 Amazon AWS のドキュメントを参照してください。
アクセス許可を構成する
S3 バケットを設定したら、AWS Identity and Access Management (IAM) を使用して、Events Export アプリケーションが S3 バケットにアクセスするためのロールを作成します。
このロールには、次の 2 つのポリシーが必要です。
- S3 アクセスポリシー - S3 バケットへのアクセスを許可する
- 信頼ポリシー - Events Export アプリケーションユーザーが AWS Security Token Service を使用して一時セッションを取得できるようにします
信頼ポリシー JSON:
適切なアクセス許可を設定すると、S3 バケットは NTT CPaaS からエクスポートされたファイルを受け入れる準備が整います。
イベントをエクスポートする
Events Export API ドキュメントで定義されているスキーマに従って、イベントをエクスポートするリクエストを送信します。
Events Export API は、要求を非同期的に処理します。 リクエストのステータスをチェックし て、完了したかどうかを確認できます。
ステータスがCOMPLETED_SUCCESSFULLYになると、イベントを含むエクスポートファイルが指定された S3 バケットにアップロードされます。
エクスポートファイル形式
エクスポートされたイベントファイルには、次の特性があります。
- フォーマット:圧縮された
.gzipファイル - ファイル名: '
-events- -.json.gz' - コンテンツ: ファイルあたり最大 50,000 行、各行には JSON 形式の 1 つのイベントが含まれます
ファイルが保存される S3 バケットのディレクトリパスを指定できます。
イベントスキーマ
エクスポートされた各イベントには、必須フィールドとオプションのイベント固有のプロパティが含まれています。
必須フィールド [#mandatory-fields-event-schema]
| フィールド名 | 値の形式 | 説明 |
|---|---|---|
definitionId | 文字列 | イベントの定義(タイプ)。「 イベント定義のリストの取得」を参照してください。 |
personId | 文字列 | ユーザープロファイルの一意の識別子。 |
externalPersonId | 文字列 | ユーザープロファイルの外部識別子。 |
| 「タイムスタンプ」 | ISO8601認証取得 | イベントが発生した時刻。 |
| 'プロパティ' | オブジェクト | イベントに定義されているイベント固有のイベント プロパティ。 |