Ver2:

変更コード(商品タグ追加)/ Modified Code (Add Product Tags)

[JP]

  1. ビジネスプランを選択
  2. テーマ編集画面の アプリを埋め込む 画面で PeecAI SDK をONにします。
  3. SDKのドキュメントは次の通りとなります。

[EN]

  1. Choose a business plan
  2. Turn on the PeecAI SDK on the screen where you embed the app in the theme editing interface.
  3. The SDK documentation is as follows.

[JP]

/**
* PeecAiSdkのオブジェクト
*/
window.PeecAiSdk = {
  /**
  *  PeecAiのレコメンド取得
 */
  async getRecommends(params?: RecommendParam): Promise<Response>
}
/**
 * レコメンドリクエストパラメータ
 * @property tags タグでレコメンド商品フィルター
 */
export type RecommendParam = {
    readonly tags?: string[]
}
/**
* レコメンドのレスポンス
*/
type Response = {
    items: Item[]
}

/**
* レコメンドのレスポンスのアイテム
*/
type Item = {
   /**
     * レコメンド種別
    * - 1: 同時に購入
    * - 2: 関連商品
    * - 3: トレンド商品(全体)
    * - 4: トレンド商品(カテゴリー別)
     */
    readonly model: RecommendModelValue
    /**
     * 商品Id
     */
    readonly product_id: string

    /**
     * 商品タイプ
     */
    readonly product_type?: string

    /**
     * 商品名
     */
    readonly title: string
    /**
     * 商品画像のURLリスト
     */
    readonly images: string[]
    /**
     * 最低値段
     */
    readonly min_price: string
    /**
     * 最高値段
     */
    readonly max_price?: string
    /**
     * 値引き前の最低値段
     */
    readonly min_compare_at_price?: string
    /**
     * 値引き前の最高値段
     */
    readonly max_compare_at_price?: string
    /**
     * 商品の説明(html)
     */
    readonly body_html?: string
    /**
     * 商品のhandle (URL)
     */
    readonly handle: string
    /**
     * peec-aiでセットされていえるバッジに表示するテキスト
     */
    readonly padge_text?: string
    /**
     * 詳細ページのURL
     */
    readonly url: string
}

[EN]

/**
* PeecAiSdk object
*/
window.PeecAiSdk = {
  /**
  *  Get recommendations from PeecAi
  */
  async getRecommends(params?: RecommendParam): Promise<Response>
}
/**
 * Recommendation request parameters
 * @property tags Filter recommended products by tags
 */
export type RecommendParam = {
    readonly tags?: string[]
}

/**
* Response for recommendations
*/
type Response = {
    items: Item[]
}

/**
* Item in the response for recommendations
*/
type Item = {
   /**
     * Recommendation type
    * - 1: Simultaneous purchase
    * - 2: Related products
    * - 3: Trending products (overall)
    * - 4: Trending products (by category)
     */
    readonly model: RecommendModelValue
    /**
     * Product ID
     */
    readonly product_id: string

    /**
     * Product type
     */
    readonly product_type?: string

    /**
     * Product name
     */
    readonly title: string
    /**
     * URL list of product images
     */
    readonly images: string[]
    /**
     * Minimum price
     */
    readonly min_price: string
    /**
     * Maximum price
     */
    readonly max_price?: string
    /**
     * Minimum compare-at price
     */
    readonly min_compare_at_price?: string
    /**
     * Maximum compare-at price
     */
    readonly max_compare_at_price?: string
    /**
     * Description of the product (html)
     */
    readonly body_html?: string
    /**
     * Product handle (URL)
     */
    readonly handle: string
    /**
     * Text to display on badge set by peec-ai
     */
    readonly padge_text?: string
    /**
     * URL of detail page
     */
    readonly url: string
}