SearchResult
search() コールが返す SearchResult オブジェクトには次のプロパティがあります。
| 名前 | 型 | 説明 |
|---|---|---|
| queryId | string | SOSL 検索の一意の識別子。 |
| searchRecords | SearchRecord[] | SearchRecord オブジェクトの配列。sObject をそれぞれ含んでいます。 |
| searchResultsMetadata | SearchResultsMetadata | SearchRecords のメタデータ。 |
SearchRecord
検索から返される個々のレコードを表します。
| 名前 | 型 | 説明 |
|---|---|---|
| record | sObject | 検索で返される個々のレコード。 |
| searchRecordMetadata | SearchRecordMetadata | searchRecords のメタデータ。 |
| snippet | SearchSnippet | 検索結果ページに、周囲のテキスト内で検索文字列に一致する語が強調表示されます。 |
SearchRecordMetadata
レコードレベルでの検索結果のメタデータ。
| 名前 | 型 | 説明 |
|---|---|---|
| spellCorrected | boolean | レコードが、スペル修正された検索語と一致することを示します。true の場合にのみ応答に表示されます。 |
SearchSnippet
記事、ケース、フィード、アイデア検索の検索結果ページに表示される抜粋。
| 名前 | 型 | 説明 |
|---|---|---|
| text | string | 検索語の一致を含む抜粋。 |
| wholeFields | WholeFields | 強調表示された項目のリスト。 |
WholeFields
検索クエリに一致する語の強調表示を含む、各項目の完全なテキストが含まれます。強調表示された語は <mark> タグで囲まれます。
| 名前 | 型 | 説明 |
|---|---|---|
| name | string | 強調表示された項目の名前。 |
| value | string | 強調表示されたテキスト。 |
SearchResultsMetadata
検索結果のグローバルメタデータ。
| 名前 | 型 | 説明 |
|---|---|---|
| entityMetadata | EntitySearchMetadata | オブジェクトレベルでの検索結果のメタデータ。 |
EntitySearchMetadata
オブジェクトレベルでの検索結果のメタデータ。
| 名前 | 型 | 説明 |
|---|---|---|
| fieldMetadata | FieldLevelSearchMetadata | 項目レベルでの検索結果のメタデータ。 |
| spellCorrectionMetadata | EntitySpellCorrectionMetadata | オブジェクトレベルでのスペル修正のメタデータ。 |
| entityName | string | オブジェクトを特定します。 |