Moments APIについて

あなたのアカウントで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エンドポイントのデータは訪問者があなたのブランドと交流するにつれて最新の状態を保ちます。

エンドポイント

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

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

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

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

制限

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

• プロフィール全体のエンジンに対する読み取りレート制限：200リクエスト/秒/プロフィール
• プロフィールあたりの最大エンジン数：1
• エンジンごとの書き込みリクエストごとの最大書き込みサイズ：1kB
• Moments APIエンドポイントで利用可能なデータ：新しいイベントが処理されない場合の30日間の保持

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

データのパージ

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

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

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

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

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

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

ドメイン許可リスト

許可リストは、信頼できないドメインからあなたのMoments APIエンドポイントへのリクエストを防ぎます。Moments APIエンジンのために許可リストを作成する必要があります。

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の両方でライブ訪問者データを取得することができますが、ユースケース、設定、実装は異なります。これら二つの訪問者プロファイルデータ取得方法の違いを理解するために、以下の比較を参照してください。

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

はじめに

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

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