配信 API を使用したRecommendationsの取得
Adobe Target API とAdobe Target Recommendations API を使用すると、web ページへの応答を配信できますが、アプリ、画面、コンソール、メール、キオスクなどのディスプレイデバイスなど、HTMLー以外のエクスペリエンスでも使用できます。 つまり、Target ライブラリとJavaScriptを使用できない場合でも、Target 配信 API を使用すれば、引き続き Target の全機能にアクセスして、パーソナライズされたエクスペリエンスを提供できます。
レコメンデーションを取得するには、適切なコンテキスト情報を含んだAdobe Target Delivery API POST呼び出しを送信します。この情報には、ユーザー ID (最近閲覧したユーザーの項目などのプロファイル固有のレコメンデーションで使用する)、関連する mbox 名、mbox パラメーター、プロファイルパラメーター、その他の属性などが含まれます。 このレスポンスには、推奨される entity.ids (および他のエンティティデータを含む)が JSON 形式またはHTML形式で含まれ、デバイスに表示できます。
Adobe Target用 配信 API は、標準の Target リクエストが提供する既存の機能をすべて公開します。
配信 API:
- を使用すると、場所およびオーディエンスのエクスペリエンスやオファーを RESTful な方法で取得できます。
- 認証は必要ありません。
- POST のみ。
- は、Cookie の処理や呼び出しのリダイレクトを行いません。
- 「ユーザーの役割」を必要としない、または認識しない。 コンテンツを取得したり、イベントを Target エッジサーバーにレポートしたりするだけです。
配信 API を使用して、レコメンデーションを含む Target エクスペリエンスを配信するには、次の手順に従います。
- Visual Experience Composer ではなくフォームベースのコンポーザーを使用して、Target アクティビティ(A/B、XT、AP またはRecommendations)を作成します。
- 配信 API を使用して、作成した Target アクティビティによって生成されたリクエストに対する応答を取得します。
<!— Q:この方法にはなぜ両方のステップが必要なのでしょうか。 mbox に対してフォームベースのレコメンデーションを定義した場合、の配信 API ステップを使用して結果を取得する利点は何ですか? フォームベースの Rec を使用して宛先デバイスに結果を配信するだけでは、なぜできないのでしょうか…?? A:以下のユースケースを参照してください。結果を表示する前にさらに作業をおこなうために、保留中の結果を「インターセプト」する場合です。 在庫レベルに対するリアルタイム比較などがあります。 —>
フォームベースの Experience Composer を使用したレコメンデーションの作成
配信 API で使用できるレコメンデーションを作成するには、 フォームベースのコンポーザーを使用します。
-
まず、レコメンデーションで使用する JSON ベースのデザインを作成して保存します。 JSON のサンプルと、フォームベースのアクティビティを設定する際に JSON 応答を返す方法に関する背景情報については、 レコメンデーションデザインの作成に関するドキュメントを参照してください。 この例では、デザイン名は Simple JSON. です
-
Target で、Activities/Create Activity/Recommendations に移動し、「Form」を選択します。
-
プロパティを選択し、[Next] をクリックします。
-
レコメンデーションの応答をユーザーに受信させる場所を定義します。 次の例では、api_charter という名前の場所を使用しています。 以前に作成した「Simple JSON.」という名前の JSON ベースのデザインを選択します。
-
レコメンデーションを保存して有効化します。 結果が生成されます。 結果の準備が整ったら、配信 API を使用して結果を取得できます。
配信 API の使用
配信 API の構文を以下に示します。
POST https://{{CLIENT_CODE}}.tt.omtrdc.net/rest/v1/delivery
-
クライアントコードは必須であることに注意してください。 お使いのクライアントコードは、Recommendations/Settings に移動してAdobe Targetにある場合があります。 Recommendation API トークン セクションの クライアントコード 値に注意してください。
-
クライアントコードを取得したら、配信 API 呼び出しを作成します。 次の例は、Delivery API Postman コレクションで提供された Web Batched Mboxes Delivery API Call から始まり、適切な変更を行います。 次に例を示します。
-
browser および address オブジェクトは、HTML以外のユースケースでは必要ないので、Body から削除されました
-
この例では、api_charter を場所名としてリストしています
-
このレコメンデーションは、現在のアイテムキーを Target に渡す必要があるコンテンツの類似性に基づいているので、entity.id が指定されています。
クエリパラメーターを正しく設定することを忘れないでください。 例えば、必要に応じて{{CLIENT_CODE}}
を指定します。 <!— Q:更新された呼び出し構文では、以前のバージョンのように、entity.id が mboxParameter ではなく profileParameter としてリストされています。 —> <!— Q:古い画像 古い付随するテキスト:「この推奨事項は、mboxParameters を介して送信された entity.id に基づくコンテンツ類似製品に基づいています。」 – >
-
-
リクエストを送信します。 これは、アクティブなレコメンデーションが実行されている api_charter の場所に対して実行されます。この場所は、推奨されるエンティティのリストを出力する JSON デザインで定義されています。
-
JSON デザインに基づいて応答を受け取ります。
この応答には、キー ID と推奨エンティティのエンティティ ID が含まれます。
この方法で配信 API をRecommendationsと共に使用すると、HTML以外のデバイスで訪問者にレコメンデーションを表示する前に、さらに手順を実行できます。 例えば、配信 API から応答を受け取って、最終結果を表示する前に別のシステム(CMS、PIM、e コマースプラットフォームなど)からエンティティ属性の詳細(在庫、価格、評価など)を追加でリアルタイムに参照できます。
このガイドで概要を説明しているアプローチを使用すると、任意のアプリケーションを取得して、Target からの応答を活用し、パーソナライズされたレコメンデーションを提供できます。
実装例
以下のリソースでは、HTMLに焦点を当てていない様々な実装例を示しています。 関係するシステムとデバイスにより、すべての実装は一意であることに注意してください。
API を使用したRecommendations設定の管理
ほとんどの場合、レコメンデーションはAdobe Target UI で設定され、前述のような理由で、Target API を介して使用またはアクセスされます。 この UI と API の調整は共通です。 ただし、ユーザーは、設定と結果の使用の両方で、API を使用してすべてのアクションを実行したい場合があります。 それほど一般的ではありませんが、ユーザーは API を使用して、レコメンデーションの結果を完全に設定、実行 および 活用できます。
Adobe Target Recommendations エンティティを管理し、サーバーサイドで配信する方法について 🔗 前の節 で説明しました。 同様に、Adobe Developer Console を使用すると、Adobe Targetにログインしなくても、条件、プロモーション、コレクション、デザインテンプレートを管理できます。 すべてのRecommendations API の完全なリストは こちら見つかりますが、参照用の概要を以下に示します。
リファレンスドキュメント
概要とレビュー
おめでとうございます。 このガイドでは、次の方法について説明します。