Context APIとCloudStreamの統合ガイド

動作原理

Context APIはCloudStreamとの直接統合をサポートしており、データクラウドから直接データを使用してリアルタイムのパーソナライゼーションを作成できます。SnowflakeやDatabricksなどのクラウドデータソースを基にしたCloudStreamセグメントから訪問データを取得します。

この統合は、データクラウドとリアルタイムAPIレスポンスの間に橋をかけ、データウェアハウスのスケールとContext APIの低遅延パフォーマンスを組み合わせたパーソナライゼーションシナリオを実現します。

統合には、CloudStreamプロファイルとContext APIの両方で構成が必要です。

前提条件

• 少なくとも1つのクラウドデータソースが構成されたCloudStreamプロファイル
• クラウド属性を使用して作成されたCloudStreamセグメント
• アカウントで有効になっているContext API

ステップ1: クラウドデータソースの構成

CloudStreamプロファイルで、Context APIと連携する各クラウドデータソースを構成します：

1. CloudStreamプロファイルで接続 > データソースに移動します。
2. 新しいクラウドデータソースを作成するか、既存のものを編集します。
3. データソース構成のContext API統合セクションに移動します。
4. Context API統合を有効にします。
5. 各レコードに対して一意の識別子を含むクラウドデータソースの列を選択します。
   • この識別子は訪問またはエンティティごとに一意である必要があります（例：訪問ID、顧客ID、またはメールアドレス）。
   • 文字列または数値データ型の列のみがサポートされています。
   • この列の値はContext APIエンドポイントのmomentsApiIdパラメーターで使用されます。
6. データソース構成の残りの部分を完了して変更を保存します。

クラウドデータソースは、Context APIエンジンのソースとして利用可能になりました。

ステップ2: CloudStreamセグメントの作成

Context APIを通じて利用可能にしたいオーディエンスを定義するCloudStreamセグメントを作成します：

1. CloudStreamプロファイルでオーディエンスに移動します。
2. データソースのクラウド属性を使用してセグメントを作成します。
3. Context APIで使用したいセグメントを保存して有効にします。

これらのセグメントは、Context APIエンジンを構成する際に選択可能です。

ステップ3: Context APIエンジンの構成

Context API構成で、APIレスポンスに含めたいCloudStreamデータソースとセグメントを追加します：

1. CloudStreamプロファイルでCloudStream > Context APIに移動します。
2. 新しいエンジンを作成するか、既存のものを編集します。
3. 詳細画面で、エンジン名、有効状態、ドメイン許可リストを構成します。
4. 次へをクリックします。
5. クラウドデータソース画面で：
   • データソースを追加をクリックしてクラウドデータソースを追加します。
   • 追加する各クラウドデータソースについて、エンジン構成で使用するCloudStreamセグメントを選択します。
   • 選択したすべてのセグメントのレコードがエンジン構成に事前に構成されます。
6. 次へをクリックします。
7. レスポンス画面で、CloudStreamセグメントが例示レスポンスのオーディエンスとして表示されることを確認します。
   • 必要に応じて追加のCloudStream属性を選択できます。サポートされるデータタイプ：数値、文字列、ブール値、日付。
   • レスポンスペイロードの属性でIDまたは名前を使用するか選択します。
8. 例示レスポンスパネルを確認して構成を確認します。
9. 次へをクリックし、エンジンの概要を確認します。
10. 完了をクリックしてエンジンを保存します。

ステップ4: Context APIエンドポイントの呼び出し

momentsApiIdパラメータを使用してCloudStreamセグメントから訪問データを取得します。

Context APIエンドポイント

GET https://personalization-api.{REGION}.prod.tealiumapis.com/personalization/accounts/{ACCOUNT}/profiles/{PROFILE}/engines/{ENGINE_ID}/visitors/{momentsApiId}?suppressNotFound={SUPPRESS_NOT_FOUND}

パラメータ

例示リクエスト

GET https://personalization-api.us-west.prod.tealiumapis.com/personalization/accounts/example-account/profiles/cloudstream-profile/engines/abc123/visitors/user%40example.com?suppressNotFound=true

この例では：

• user%40example.comはクラウドデータソース構成でマッピングされたクラウド属性の値です。

レスポンス形式

レスポンスは標準のContext APIレスポンス形式に従い、CloudStreamセグメントのオーディエンスが含まれます：

{
    "audiences": [
        "30 Days Since Last Login"
    ],
    "metrics": {
        "Total direct visits": 1
    },
    "properties": {
        "Company Name": "<attr_value>"
    },
    "flags": {
        "Returning visitor": false
    },
    "dates": {
        "First visit": 1491233145706
    }
}

ベストプラクティス

• 安定した識別子を選択する：セッション間で持続する安定した、一意の識別子を含む列を選択します（例：顧客IDまたはメールハッシュ）。
• suppressNotFoundでテストする：テスト中はsuppressNotFound=trueを使用して、データソースに訪問が見つからない場合のHTTP 404レスポンスを避けます。
• セグメントメンバーシップを監視する：Context APIレスポンスで期待する訪問集団を捉えるようにCloudStreamセグメントが構成されていることを確認します。
• 更新を調整する：クラウドデータソースの構成変更がContext APIレスポンスに影響を与える可能性があります。両システム間で更新を調整します。

関連ドキュメント

• CloudStreamについて
• クラウドデータソースについて
• クラウドデータソースの管理
• コンテキストAPIについて（旧モーメンツAPI）
• コンテキストAPIエンドポイント
• Context APIエンジンの管理