Einstein Recommendations

Einstein Recommendations API には 2 つの主要な機能があります。ひとつはアクティビティを受け取る機能、もうひとつは推奨を出力する機能です。また、顧客はゾーンコンポーネントを使用すればコードを変更せずに柔軟に Recommender を切り替えることができます。

この API ドキュメントは、主に Salesforce Commerce Cloud の顧客を対象としています。

Einstein Recommendations API へのアクセスを有効にするには、Einstein Configurator にアクセスし、API ページに Commerce Cloud Account Manager のクライアント ID を入力します。サイト管理者のアクセス権を使用して、Account Manager ページで必要なクライアント ID を作成できます。詳細については、API クライアント ID の追加を参照してください。

この機能を有効にすると、正しいクライアント ID が渡される限り、Production (本番)、Staging (ステージング)、Development (開発)、Sandbox (サンドボックス) のインスタンスを含むすべての環境で API を利用できるようになります。

各 API 呼び出しは、API キー認証のための x-cq-client-id ヘッダーを渡す必要があります。

クライアント側やサーバー側への API 実装には、負の側面があります。クライアント ID のシークレットを守るため、サーバー側に API を実装してセキュリティを高めることを推奨します。クライアント側に実装すると、クライアント ID が悪意のある攻撃者に漏洩するリスクがあります。

推奨商品取得のリクエストや、viewProduct、viewReco、clickReco などの特定のユーザーアクティビティをサーバー側で実装する場合、キャッシングを考慮する必要があります。たとえば、ユーザーがキャッシュされた商品ページを表示している場合でも、viewProduct アクティビティは送信されます。Einstein がすべてのイベントを受信し、推奨がキャッシュされないようにすることは重要です。

この Einstein Recommendations API は、E メールによる推奨ユースケース用には設計されていません。Einstein recommendations を E メールに埋め込むことはできません。

当社のサービスはグローバルに行き渡っており、水平方向に拡張可能で、トラフィックに応じて自動的に伸縮するようにできるため、負荷テストは必要ありません。推奨の結果に影響するため、負荷テストはできるだけ行わないでください。

各買い物客に関連する商品の推奨項目を生成するために、Einstein Recommendations API は買い物客を識別するためのパラメーターを提供します。

• cookieId (必須) - 匿名買い物客の一意の識別子。通常、cookieId はファーストパーティー Cookie の値です。
  • 従来の Commerce Cloud ストアフロントから API リクエストを行う場合、従来のストアフロントでの自動アクティビティ追跡と一致するように cqcid Cookie 値を渡します。詳細については、ブラウザーベースのローカルデータストレージを参照してください。
  • Salesforce Commerce API を使用する際には、トークン取得プロセスの一環として利用可能な USID 値を渡します。詳細については、「Shopper Login and API Access Service」のドキュメントを参照してください。
  • OCAPI を使用する場合、ゲストログインレスポンスから visit_id 値を渡して自動アクティビティを一致させます。詳細については、OCAPI Customer ドキュメントを参照してください。
• userId (推奨) - ログインしている買い物客の一意の識別子。このパラメーターを使用すると、Einstein は複数のデバイスで同じログインユーザーをリンクできます。
  • 従来の Commerce Cloud ストアフロントから API リクエストを行う場合、従来のストアフロントでの自動アクティビティ追跡と一致するように cquid Cookie 値を渡します。詳細については、ブラウザーベースのローカルデータストレージを参照してください。
  • Salesforce Commerce API を使用する場合、登録済みログインレスポンスから hashed_login 値を渡して自動アクティビティを一致させます。詳細については、「Shopper Login and API Access Service」のドキュメントを参照してください。
  • OCAPI を使用する場合、登録済みログインレスポンスから hashed_login 値を渡して自動アクティビティを一致させます。詳細については、OCAPI Customer ドキュメントを参照してください。

Einstein API を通して使用される Recommender の標準的なパフォーマンスレポートは、デジタルサイトで使用される他の Recommender のレポートと同じです。Einstein Reports & Dashboards でレポートを表示できます (Einstein Reports & Dashboards の詳細については、このドキュメントを参照してください)。

個別のレポート作成やトラブルシューティングを簡単に行えるようにするために、Einstein API 用の個別の Recommender を作成することが推奨されます。たとえば、Recommender の名前を「pdp-mobile-API」とすると、その Recommender がモバイルアプリの商品詳細ページで利用されることを示します。

Rights of ALBERT EINSTEIN are used with permission of The Hebrew University of Jerusalem. Represented exclusively by Greenlight.