この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

CommerceSearchConnectFamily クラス

Web ストアの商品を検索語またはカテゴリで検索します。

名前空間

ConnectApi

CommerceSearchConnectFamily のメソッド

CommerceSearchConnectFamily のメソッドは次のとおりです。すべてのメソッドが静的です。

searchProducts(webstoreId, searchTerm, categoryId, sortRuleId, grouping, fields, refinements, pageParam, pageSize, effectiveAccountId, includeQuantityRule)

Web ストアの商品を検索語またはカテゴリで検索します。

API バージョン

58.0

ゲストユーザーが使用可能

58.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.CommerceProductSearchResults searchProducts(String webstoreId, String searchTerm, String categoryId, String sortRuleId, String grouping, List<String> fields, String refinements, Integer pageParam, Integer pageSize, String effectiveAccountId, Boolean includeQuantityRule)

パラメーター

webstoreId: 型: String; WebStore の ID。
searchTerm: 型: String; スペースで区切られた最大 32 個の検索語のリスト。
categoryId: 型: String; カテゴリ ID は、このカテゴリまたはそのサブカテゴリの商品の結果を返します。
sortRuleId: 型: String; 検索結果の商品の順序を指定する並べ替えルールの ID。指定されていない場合、デフォルトの並べ替え種別は関連性です。
grouping: 型: String; 検索結果のグルーピングオプション。指定しない場合、デフォルトは [検索] | [結果表示設定] | [結果のグループ化] で指定した値です。
fields: 型: List<String>; 検索結果で返される商品項目。検索結果には、アクセス権のある項目が含まれます。
refinements: 型: String; 検索結果の絞り込み (ファセット) を最大 9 項目表示するリスト。バイヤーや買い物客は、絞り込みごとに最大 20 個の値を選択できます。refinements パラメーターは、JSON 表現の ConnectApi.DistinctValueRefinementInput から Base64 文字列としてエンコードされます。
pageParam: 型: Integer; 返すページの数。0 から開始します。null または 0 を渡すと、最初のページが返されます。
pageSize: 型: Integer; ページあたりの項目数を指定します。有効な値は 1 ～ 200 です。指定しない場合は、デフォルトの 20 になります。
effectiveAccountId: 型: String; 要求が行われたバイヤー取引先またはゲストバイヤープロファイルの ID。指定されていない場合、デフォルト値はコンテキストから決定されます。
includeQuantityRule: 型: Boolean; 検索結果に商品の購入数量ルール情報を含めるか (true)、否か (false) を指定します。指定しない場合は、デフォルトの false になります。

戻り値

型: ConnectApi.CommerceProductSearchResults

使用方法

商品の検索ではバイヤーの「商品を表示」エンタイトルメントが適用され、商品データを表示する資格があるユーザーのみがこのリソースにアクセスできます。

Apex リファレンスガイド