Skip to main content
Product Recommendation APIは、商品カタログを Kameleoon にインポートし、パーソナライズされた商品レコメンデーションと検索結果を独自のコードに返す REST API です。このAPIは、Product Recommendation および Search Personalization アドオンを使用しているプロジェクト向けです。各商品の表示方法は独自のコードで制御でき、各呼び出しは独自のツールでログに記録してデバッグできます。

​
APIの機能

このAPIには 4 つのエンドポイントグループがあります。各グループは、連携の 1 つの部分を担当します。
  • 初期化: レコメンデーションと検索のリクエストで使用するデバイス ID とセッション ID を取得するために、セッションを開始します。
  • インポート: カテゴリ、商品、注文をアップロードし、商品の在庫状況を更新し、商品を削除します。
  • おすすめ: レコメンダーブロックのパーソナライズされたレコメンデーションを取得したり、商品コレクションを取得したり、絞り込んだ商品リストをリクエストしたりします。
  • 検索: 訪問者のクエリに対する即時検索結果または完全な検索結果を取得します。

​
始める前に

  • アドオン: このAPIは、Product Recommendation および Search Personalization アドオンを使用しているプロジェクト向けです。
  • Store Key: Kameleoon アプリの Recommendations > Settings > Store settings で確認できます。リクエストではshop_idとして送信します。
  • Secret Key: 同じ場所で確認できます。インポートのリクエストではshop_secretとして送信します。
必要に応じて、いずれかのキーについてカスタマーサクセスマネージャーにお問い合わせください。

​
カタログをインポートする

レコメンデーションは商品カタログ内の商品から生成されるため、レコメンデーションをリクエストする前に、データをインポートしてください。商品のインポートで最新のカテゴリを使用できるよう、商品をアップロードする前にカテゴリをインポートします。 商品数が 50,000 件を超えるカタログでは Import and update products エンドポイントを使用し、カタログ全体を毎日再インポートしないようにしてください。軽い変更の場合は、Update available products エンドポイントを使用して既存商品の在庫状況を変更します。 インポートのリクエストには本文に Secret Keyが含まれるため、インポートのリクエストはブラウザやアプリからではなく、バックエンドから送信してください。 インポートの全手順については、商品カタログのインポートチュートリアルを参照してください。

​
レコメンデーションリクエストの仕組み

レコメンデーションと検索のリクエストでは、2 つの ID を使用します。デバイス ID(did)とセッション ID(sid)です。他のエンドポイントを呼び出す前に、Initialize session を呼び出して両方の ID を取得してください。

​
セッションを初期化する

他のリクエストで必要なデバイス ID とセッション ID を取得するために、セッションを開始します。https://api.products.kameleoon.com/init にGETリクエストを送信し、Store Keyをshop_idのクエリパラメータとして指定します。 Initialize session を呼び出すタイミングは、プラットフォームごとに次のとおりです。
  • cURL: サーバーがページをレンダリングするたびに。
  • Web: シングルページアプリケーションを含め、ユーザーがページを開くたびに。
  • iOS and Android: アプリを起動するたびに。
新しいデバイスで初めて起動するときは、デバイス IDを指定せずに Initialize session を呼び出します。APIがデバイス IDを生成するので、以降のすべてのリクエストでそれを使用します。 Web Experimentationと組み合わせてバックエンドからAPIを呼び出す場合は、セッション IDをKameleoonProducts_session_codeクッキーに、デバイス IDをKameleoonProducts_device_idクッキーに保存してください。

​
Postman で API を試す

Postman の Kameleoon Product Recommendation API コレクションを使用すると、コードを書かずに Product Recommendation APIのリクエストをテストできます。コレクションには、エンドポイントごとに 1 つのリクエストが含まれています。
  1. Kameleoon Product Recommendation API コレクションを ZIP アーカイブとしてダウンロードし、JSON ファイルを展開して Postman にインポートします。
  2. コレクションの Variables タブで、shopIdにStore Keyを、shopSecretにSecret Keyを設定します。どちらも Kameleoon アプリの Recommendations > Settings > Store settings で確認できます。
  3. Initialize session を送信します。このリクエストは、デバイス ID とセッション ID をdidとsid変数に保存します。他のリクエストは、didとsid変数を使用します。
  4. テストするリクエストにrecommenderCodeまたはcollectionIdを設定してから送信します。
インポートのリクエストは商品カタログを変更するため、送信する前にリクエストボディを確認してください。

​
APIリファレンス

各エンドポイントには、パラメータと例を記載したリファレンスページがあります。

​
ガイド

各ガイドでは、これらのエンドポイントを使用する 1 つのタスクを順を追って説明します。