SOQL および SOSL リファレンス
jWITH HIGHLIGHT
WITH HIGHLIGHT 句 (省略可能) を法人取引先、キャンペーン、取引先責任者、カスタムオブジェクト、リード、商談、見積、およびユーザー検索の SOSL クエリに追加できます。これにより、検索結果内で検索クエリに一致する語が強調表示されるため、関連するコンテンツを容易に特定できます。WITH HIGHLIGHT 句は、API バージョン 39.0 以降で使用できます。カスタム項目およびオブジェクトの WITH HIGHLIGHT 句は、API バージョン 40.0 以降で使用できます。
強調表示される検索語は、次の標準およびカスタム項目種別から生成されます。
- 自動採番
- メール
- テキスト
- テキストエリア
- ロングテキストエリア
強調表示される検索語は、次の項目種別からは生成されません。
- チェックボックス
- 複合項目
- 通貨
- 日付
- 日付/時間
- ファイル
- 数式
- 参照関係
- 数値
- パーセント
- 電話
- 選択リスト
- 選択リスト (複数選択)
- リッチテキストエリア
- URL
例
次の SOSL ステートメントでは、検索語「salesforce」を強調表示した検索結果が返されます。
1FIND {salesforce} IN ALL FIELDS RETURNING Account(Name,Description) WITH HIGHLIGHT一致する語は <mark> タグによって強調表示されます。スペルミスにより元の検索語では結果が生成されない場合、検索語の修正されたスペルが結果内で強調表示されます。
例
1{
2 "searchRecords" : [ {
3 "attributes" : {
4 "type" : "Account",
5 "url" : "/services/data/v39.0/sobjects/Account/001xx000003DpxkAAC"
6 },
7 "Name" : "salesforce",
8 "Description" : "Salesforce.com",
9 "highlight.Description" : "<mark>salesforce</mark>.com",
10 "highlight.Name" :
11 "<mark>salesforce</mark>"
12 } ]
13}例
次の SOSL ステートメントでは、カスタムオブジェクト Building のカスタム項目 BuildingDescription について、検索語「salesforce west」を強調表示した検索結果が返されます。
1FIND {Salesforce West} IN ALL FIELDS RETURNING Building__c(Name, BuildingDescription__c) WITH HIGHLIGHT使用方法
ワイルドカードを含む検索語は強調表示されません。
WITH HIGHLIGHT 付きの検索に含まれるその他のオブジェクトは、強調表示された検索語を返しません。
1 つの SOSL クエリの 1 エンティティあたり最大 25 のレコードが強調表示されます。
サポートされる API
SOSL 内の WITH HIGHLIGHT 句は、SOAP API および REST API でサポートされます。