Moments APIについて | モーメンツ API |Tealiumドキュメント

アカウントマネージャーに連絡して、アカウントでMoments APIを有効にしてください。

Moments APIは、リアルタイムの訪問パーソナライゼーションのための高性能データを取得することができるAudienceStream APIです。Moments APIをTealiumのクライアントサイドアプリケーション、utag.jsがインストールされている場所、またはTealium for Mobileに統合します。

仕組み

Moments APIは、_エンジン_と呼ばれる構成を使用して、現在の訪問のデータのみを取得するためのAPIレスポンスをカスタマイズします。例えば、訪問プロファイル全体を取得する代わりに、Moments APIはエンジン構成で選択したオーディエンス、バッジ、属性データのみを取得します。

エンジンを構成した後、Moments APIはワークフローに統合できるユニークなエンドポイントを作成します。

ユースケース

Moments APIは、パーソナライズされた顧客体験のためのリアルタイムの訪問データが必要な場合にいつでも使用できます。これには以下のようなものが含まれます：

パーソナライゼーション（最初のページ以降）
データエンリッチメントロジックと組み合わせた次の最善のアクション
エンタープライズグレードのAPI管理とコンプライアンス

例えば、顧客があなたのウェブサイトやアプリに戻ってきたとき、訪問データのためのユニークなMoments APIエンドポイントへのリクエストが行われます。Moments APIは必要なデータのみを提供するように最適化されているため、APIはリアルタイムでストリーム化されたレスポンスをあなたのアプリに送信します。その重要なデータを活用して、顧客に対するパーソナライズされた体験をトリガーする追加のロジックを活性化できます。

エンジン

Moments APIのエンジンは、各ユニークなエンドポイントに保存する訪問データを構成し、それらのエンドポイントにアクセスを許可するドメインを構成することができます。

エンジンを構成するとき、ユースケースに必要なオーディエンス、バッジ、属性のみを選択します。Moments APIエンジンは、リクエストの精度と範囲を確認できるように、JSONレスポンスを表示します。

訪問のデータは、エンジンを有効にし、訪問がアクティブなセッションをログし、システム内でイベントを生成した後に利用可能になります。例えば、顧客があなたのサイトを訪れたとき、Moments APIは新しい訪問イベントがエンジン構成で定義されたオーディエンス、バッジ、属性に影響を与えるかどうかを判断します。訪問データが更新される必要があるときのみ、データは各エンジンのユニークなデータストアに書き込まれます。

エンジンはリアルタイムでデータストアを更新するため、APIエンドポイントのデータは訪問があなたのブランドと交流するにつれて最新の状態を保ちます。

デフォルトでは、プロファイルごとに最大10のエンジンを有効にすることができます。これにより、特定のビジネスケースごとにカスタマイズされたエンジンを作成することができます。追加のエンジンを有効にする必要がある場合は、Tealiumのアカウントマネージャーに連絡してください。

エンドポイント

Moments APIは、各エンジンに対してユニークなエンドポイントを作成します。訪問データはJSONオブジェクトとして返されます。

Tealiumは、ペイロードサイズが1kB以下の場合の平均Moments APIエンドポイントのパフォーマンスを60msでベンチマークしました。

訪問データを取得するために、Tealium iQ Advanced JavaScript Code Extensionを構成して、Moments API endpointへのリクエストを行います。

エンジンをオンにしてからアクティブなセッションを持っていない訪問のデータは利用できません。

制限

Moments APIには以下のデフォルトの制限があります：

プロファイル全体でのエンジンごとの読み取りレート制限：200リクエスト/秒/プロファイル
プロファイルごとに有効にできるエンジンの最大数：10
エンジンごとの訪問ごとに保存できるMoments APIデータの最大サイズ：1kB
訪問の属性データがデータストアの制限を超える場合、その訪問のデータは保存されません。
Moments APIエンドポイントで利用可能なデータ：新しいイベントが処理されない場合の30日間の保持

ユースケースにより高い制限が必要な場合は、Tealiumのアカウントマネージャーに連絡してください。

データのパージ

Moments APIでは、パージデータ機能を使用してエンドポイントから古いデータを削除することができます。

以下の例は、エンドポイントからデータをパージしたい状況を説明しています：

エンジン構成に含まれるオーディエンス、バッジ、属性の名前を変更したり、削除したりする。
属性の個人識別情報（PII）ステータスを変更する。属性のPIIステータスを変更すると、制限された情報がAPIエンドポイントに公開されたままになる可能性があります。
エンジン構成からオーディエンス、バッジ、属性を削除する。

エンジンで使用されるオーディエンス、バッジ、属性がAudienceStreamまたはエンジン構成から削除されると、その項目は今後エンドポイントに表示されなくなります。削除された属性を含むエンジンデータは変更されません。一般的に、依存関係の削除がエンドポイント統合で破壊的な変更を引き起こす場合、エンジンデータをパージすることを検討するかもしれません。

データをパージすると、Moments APIエンジンのデータのみが削除されます。AudienceStreamの訪問レコードは影響を受けません。

エンジンデータのパージについての詳細は、Manage Moments API engines > Purge dataを参照してください。

ドメイン許可リスト

APIエンドポイントのテストが完了した後に、ドメイン許可リストを作成することをお勧めします。

許可リストは、信頼できないドメインからMoments APIエンドポイントへのリクエストを防ぎます。エンジンを構成するときに特定のドメインを許可リストに追加することができます。

Moments APIは、Referer HTTPリクエストヘッダーのドメインとMoments APIエンジンで定義された許可リストを比較して、エンドポイントへの呼び出しを許可または制限します：

ドメインが一致：リクエストは処理されます。
ドメインが一致しない：リクエストは処理されず、403エラーが返されます。

ドメインをリストに追加しない場合、すべてのドメインが許可されます。

サブドメイン

ドメインを許可リストに追加すると、そのすべてのサブドメインが自動的に含まれます。例えば、example.comを許可すると、*.example.comに一致するすべてのサブドメインが含まれます。

権限

Moments APIの機能は、以下の権限レベルを通じて管理されます：

エンジンの作成、編集、削除、エンジンデータのパージ
- エディターまたはパブリッシャーのレガシー権限
- プラットフォーム権限での書き込みまたは削除アクセス
エンジンリストの表示
- 閲覧者のレガシー権限またはプラットフォーム権限での読み取りアクセス

Moments APIとData Layer Enrichment APIの比較

Moments APIとData Layer Enrichment APIの両方でライブ訪問データを取得することができますが、ユースケース、構成、実装は異なります。以下の比較を参照して、これら2つの訪問プロファイルデータ取得方法の違いを理解してください。

	Moments API	Data Layer Enrichment API
ユースケース	最初のページのパーソナライゼーションとそれ以降のための現在の訪問データへのリアルタイムアクセス。	初期の処理イベントの後にリアルタイムからほぼリアルタイムで利用可能なライブ訪問データ。
レート	200リクエスト/秒	-
アクティブな訪問セッションが必要	いいえ	はい
利用可能なデータ	オーディエンス、バッジ、またはsupported attribute data types。オーディエンスとバッジの名前とIDが利用可能。	訪問ID、ファネル、タイムライン以外の属性、属性IDによってリスト化されたもの。バッジとオーディエンスの場合、名前が利用可能。バッジ名の場合、Profile Definition APIと組み合わせる。
訪問IDのタイプ	Tealium匿名ID	Tealium匿名ID
Lookup IDがサポートされている	いいえ	いいえ
認証されたエンドポイント	いいえ	いいえ
PIIへのアクセス	いいえ	いいえ
カスタムレスポンスオブジェクト	はい	いいえ
実装	API	APIまたはTealium Collectタグ

はじめに

Moments APIを使用したワークフローには、以下のステップが含まれます：

パーソナライズされた体験を作り出すために必要な視聴者、バッジ、属性を考えてみてください。
Moments APIエンジンを作成し、必要な訪問データでカスタマイズしたエンドポイントを充実させます。
Tealiumのクライアントサイドアプリケーション、utag.jsがインストールされている場所、またはTealium for Mobileにエンドポイントを統合します。
データを収集し、活用します。