他のユーザが Salesforce ナレッジで実行した検索に一致するユーザのクエリ文字列テキストに基づいて、提案する検索のリストを返します。ユーザが検索を実行する前に、検索の有効性を高める手段を提供します。
構文
- URI
- vXX.X/search/suggestSearchQueries?q=検索文字列&language=クエリの言語
- 適用開始バージョン
- 30.0
- 形式
- JSON、XML
- HTTP メソッド
- GET
- 認証
- Authorization: Bearer token
- リクエストボディ
- 不要
- 要求パラメータ
-
| channel |
省略可能。記事を参照できる Salesforce ナレッジチャネルを指定します。有効な値は次のとおりです。
-
AllChannels – ユーザがアクセス権を持つすべてのチャネルで参照可能
-
App – 内部 Salesforce ナレッジアプリケーションで参照可能
-
Pkb – 公開知識ベースで参照可能
-
Csp – カスタマーポータルで参照可能
-
Prm – パートナーポータルで参照可能
channel が指定されていない場合、ユーザの種別によってデフォルト値が決まります。
- ゲストユーザの Pkb
- カスタマーポータルユーザの Csp
- パートナーポータルユーザの Prm
- 他の種別のユーザの App
channel が指定されている場合、特定の要件により、指定された値が要求した実際の値にならないことがあります。
- ゲストユーザ、カスタマーポータルユーザ、パートナーポータルユーザの場合、指定された値は各ユーザ種別のデフォルト値と一致する必要があります。値が一致しないか、AllChannels が指定されていると、指定された値が App に置き換えられます。
- ゲストユー��、カスタマーポータルユーザ、パートナーポータルユーザ以外のすべてのユーザの場合は、次のようになります。
-
Pkb、Csp、Prm、または App が指定されていると、指定された値が使用されます。
- AllChannels が指定されていると、指定された値が App に置き換えられます。
|
| language |
必須。ユーザのクエリの言語。
|
| limit |
省略可能。返される推奨検索の最大数を指定します。指定された制限を超える推奨クエリが存在すると、レスポンスボディの hasMoreResults プロパティが true になります。 |
| q |
必須。適切に URL 符号化された、ユーザの検索クエリ文字列。ユーザの検索クエリ文字列が最小長要件 (中国語、日本語、韓国語の場合は 1 文字、その他の言語の場合は 3 文字) を満たしている場合にのみ、推奨クエリが返されます。クエリ文字列が最大長である 250 文字を超えると、エラーが返されます。
|
使用方法
Salesforce ナレッジが組織で有効になっている必要があります。
クエリ文字列テキストと正確に一致する場合にのみ、クエリが推奨されます。クエリ内では、テキスト文字列がプレフィックスである必要があります。テキスト文字列が単語に含まれる場合は、一致とみなされません。たとえば、テキスト文字列が app の場合、apple banana および banana apples という推奨クエリは返されますが、pineapple は返されません。
返される推奨クエリの数が要求で指定された制限を超えると、hasMoreResults という項目が応答の最後に含まれます。返される推奨クエリが使用可能な推奨クエリのサブセットのみの場合は値が true になり、そうでない場合は false になります。
ユーザの検索クエリに疑問符またはワイルドカードが含まれている場合、それらの記号は URI でクエリ文字列から自動的に削除されます。
j