Apex リファレンスガイド
jCommerceSearch クラス
ライブ検索インデックスの並べ替えルールを取得します。商品検索の推奨結果を取得します。商品を検索します。
名前空間
CommerceSearch のメソッド
次に、CommerceSearch 用のメソッドを示します。すべてのメソッドが静的です。
getSortRules(webstoreId)
API バージョン
52.0
ゲストユーザーが使用可能
52.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.SortRulesCollection getSortRules(String webstoreId)
パラメーター
- webstoreId
- 型: String
- WebStore の ID。
getSuggestions(webstoreId, effectiveAccountId, searchTerm, maxResults)
API バージョン
52.0
ゲストユーザーが使用可能
52.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.ProductSearchSuggestionsResults getSuggestions(String webstoreId, String effectiveAccountId, String searchTerm, Integer maxResults)
パラメーター
- webstoreId
- 型: String
- WebStore の ID。
- effectiveAccountId
- 型: String
- 要求が行われたバイヤー取引先またはゲストバイヤープロファイルの ID。null の場合、デフォルト値はコンテキストから決定されます。
- searchTerm
- 型: String
- 10 文字以下の検索語。指定した場合、ユーザーの最近の検索からオートコンプリートで提案が返されます。指定しない場合、ユーザーの最近の検索から提案が返されます。
- maxResults
- 型: Integer
- 提案の最大数。値の範囲は 1 ～ 10 です。指定しない場合は、デフォルトの 10 になります。
getSuggestions(webstoreId, effectiveAccountId, searchTerm, maxResults, includeSuggestedProducts, maxSuggestedProducts)
API バージョン
58.0
ゲストユーザーが使用可能
58.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.ProductSearchSuggestionsResults getSuggestions(String webstoreId, String effectiveAccountId, String searchTerm, Integer maxResults, Boolean includeSuggestedProducts, Integer maxSuggestedProducts)
パラメーター
- webstoreId
- 型: String
- WebStore の ID。
- effectiveAccountId
- 型: String
- 要求が行われたバイヤー取引先またはゲストバイヤープロファイルの ID。null の場合、デフォルト値はコンテキストから決定されます。
- searchTerm
- 型: String
- 10 文字以下の検索語。指定した場合、ユーザーの最近の検索からオートコンプリートで提案が返されます。指定しない場合、ユーザーの最近の検索から提案が返されます。
- maxResults
- 型: Integer
- 提案の最大数。値の範囲は 1 ～ 10 です。指定しない場合は、デフォルトの 10 になります。
- includeSuggestedProducts
- 型: Boolean
- 検索語で商品の提案が返されるか (true)、否か (false) を示します。指定しない場合は、デフォルトの false になります。true の場合、提案された商品の ID が返されます。
- maxSuggestedProducts
- 型: String
- 商品提案の最大数。値の範囲は 1 ～ 10 です。指定しない場合は、デフォルトの 4 になります。
searchProducts(webstoreId, effectiveAccountId, productSearchInput)
API バージョン
52.0
ゲストユーザーが使用可能
52.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.ProductSearchResults searchProducts(String webstoreId, String effectiveAccountId, ConnectApi.ProductSearchInput productSearchInput)
パラメーター
- webstoreId
- 型: String
- WebStore の ID。
- effectiveAccountId
- 型: String
- 要求が行われたバイヤー取引先またはゲストバイヤープロファイルの ID。null の場合、デフォルト値はコンテキストから決定されます。
- productSearchInput
- 型: ConnectApi.ProductSearchInput
- カテゴリ ID または検索語が含まれる ConnectApi.ProductSearchInput のボディ。
使用方法
商品の検索ではバイヤーの「商品を表示」エンタイトルメントが適用され、商品データを表示する資格があるユーザーのみがこのリソースにアクセスできます。