init(options)
リターン Promise<SpreeAISDK | null>。成功すると、オブジェクトは次の情報を公開します。 renderTryOnButton(options): Promise<void>。レンダリング前に null をチェックします。
| オプション | タイプ | デフォルト | 目的 |
|---|---|---|---|
clientId | string | 必須 | 発行されたブラウザクライアント識別子。 |
baseApiURL | string | https://api.spreeai.com | 承認された API オリジン。発行された環境に対してのみ変更します。 |
baseURL | string | https://vton.spreeai.com | 承認されたホスト型試着室の起源。 |
partnerId v3 では init オプションではありません。パートナーは認証されたクライアントから解決されます。スタンドアロンのサイジング レンダー メソッドは返されません。
renderTryOnButton(options)
| オプション | タイプ | デフォルト/要件 | 目的 |
|---|---|---|---|
elementId | string | 必須 | 既存のホスト要素の ID。 |
garments | GarmentInput[] | 必須の選択 | 推奨される衣服の入力。空ではない配列を使用してください。 |
garmentId | string | 非推奨の代替案 | レガシーのシングルガーメント入力。衣服を好みます。 |
variant | VariantOptions | 廃止されました | garmentId を備えたレガシー フィルター。アイテムごとのバリエーションを好みます。 |
className | string | オプション | 追加のボタンクラス。 |
button | { text?: string } | オプション | ボタンラベル。 features.tryOnButton.text によってオーバーライドされます。 |
features | TryOnFeatures | オプション | ボタンのスタイル設定。 |
events | TryOnButtonEvents | オプション | クリックしてカートに追加するハンドラー。 |
enableAddToCart | boolean | false | カートに追加機能を表示します。ハンドラーを実装します。 |
enableSizingRecommendation | boolean | false | 試着時に推奨サイズをリクエストしてください。 |
showSizes | boolean | false | 付属のavailableSizesを表示します。 |
showPrices | boolean | false | 供給価格を表示します。 |
defaultUnits | "metric" | "imperial" | オプション | プロファイル測定の開始単位系。 |
GarmentInput
| フィールド | タイプ | 目的 |
|---|---|---|
garmentId | string | 必須の SPREEAI 衣服識別子。 |
variant | VariantOptions | オプションの色、フィット感、性別、またはスタイルフィルター。 |
availableSizes | string[] | オプションの現在の表示サイズのラベル。 |
price | string | オプションの表示価格は、供給された状態で表示されます。 |
検証とフォールバック
単一の衣服の場合、レンダリング前に適格性とピン留めされたバリアントがチェックされます。複数の服装のリクエストでは、利用可能な一致する服装を探します。何も見つからない場合、SDK は代わりに最初のガーメントを検証してレンダリングします。検証が失敗した場合、ボタンは表示されず、その理由がコンソールに記録されます。
コールバック
| コールバック | ペイロード |
|---|---|
onTryOnButtonClick | name: "spreeai-try-on-button-clicked" |
onAddToCartClicked | name: "spreeai-add-to-cart-clicked"、衣類、setIsLoading、closePopUp、onError |
カートに必要な衣類が含まれています id, partner_id, available そして name、プラスオプション description およびその他のデータ。カートにマッピングする前に検証してください。参照 カートの実装 そして ボタンのスタイル たとえば。
この表面の一部ではありません
返された v3.0.0 SDK では、ビューごとのスイッチ、スタンドアロンの比較ランチャー、またはスタンドアロンのサイジング メソッドが公開されていません。 features.loadingScreen は削除されました。残りのエクスポートされた型や古いコメントから呼び出し可能なメソッドを推測しないでください。