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

SearchResult

search() コールが返す SearchResult オブジェクトには次のプロパティがあります。
名前 説明
queryId string SOSL 検索の一意の識別子。
searchRecords SearchRecord[] SearchRecord オブジェクトの配列。sObject をそれぞれ含んでいます。
searchResultsMetadata SearchResultsMetadata SearchRecords のメタデータ。

SearchRecord

検索から返される個別のレコードを表します。

名前 説明
record sObject 検索によって返される個別のレコード。
searchRecordMetadata SearchRecordMetadata searchRecords のメタデータ。
snippet SearchSnippet 検索結果ページで、検索文字列に一致する語が周囲のテキスト内で強調表示されます。

SearchRecordMetadata

レコードレベルの検索結果のメタデータ。

名前 説明
searchPromoted boolean 記事が昇格されたことを検索結果に示します。システム管理者は、昇格済み用語をナレッジ記事に追加して昇格済み検索語を定義します。このようなキーワードを検索するユーザには、関連付けられた記事が検索結果で最初に表示されます。API バージョン 42.0 以降で利用できます。
spellCorrected boolean スペル修正された検索語にレコードが一致することを示します。true の場合にのみ応答に表示されます。

SearchSnippet

記事、ケース、フィード、およびアイデアの検索の検索結果ページに表示される抜粋。

名前 説明
テキスト 文字列型 検索語の一致を含む抜粋。
wholeFields WholeFields 強調表示された項目のリスト。

WholeFields

検索クエリに一致する語の強調表示を含む、各項目の完全なテキストが含まれます。強調表示された語は <mark> タグで囲まれます。

名前 説明
name 文字列型 強調表示された項目の名前。
value 文字列型 強調表示されたテキスト。

SearchResultsMetadata

検索結果のグローバルメタデータ。

名前 説明
entityMetadata EntitySearchMetadata オブジェクトレベルの検索結果のメタデータ。

EntitySearchMetadata

オブジェクトレベルの検索結果のメタデータ。

名前 説明
fieldMetadata FieldLevelSearchMetadata 項目レベルの検索結果のメタデータ。
searchPromotedMetadata EntitySearchPromotionMetadata オブジェクトレベルでの検索語の昇格のメタデータ。API バージョン 42.0 以降で利用できます。
spellCorrectionMetadata EntitySpellCorrectionMetadata オブジェクトレベルのスペル修正のメタデータ。
entityName 文字列型 オブジェクトを識別します。

FieldLevelSearchMetadata

項目レベルの検索結果のメタデータ。

名前 説明
name 文字列型 項目名。
表示ラベル 文字列型 項目の表示ラベル。
種別 文字列型 項目のデータ型。

EntitySearchPromotionMetadata

オブジェクトレベルでの検索語の昇格のメタデータ。オブジェクトの少なくとも 1 つの記事が昇格済み結果の場合にのみ応答に表示されます。API バージョン 42.0 以降で利用できます。

名前 説明
promotedResultCount int オブジェクトレベルでの昇格済み記事の結果の数。

EntitySpellCorrectionMetadata

オブジェクトレベルのスペル修正のメタデータ。オブジェクトの 1 つ以上のレコードが、スペル修正された検索語と一致する場合にのみ応答に表示されます。

名前 説明
correctedQuery 文字列型 スペル修正された検索語。
hasNonCorrectedResults boolean true の場合、スペル修正されていない検索語と一致する 1 つ以上のレコードにユーザがアクセスできることを示します。各オブジェクトが異なる値を返すことがあります。