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

Search Suggested Records

名前がユーザの検索文字列と一致した推奨レコードのリストを返します。この推奨リソースは、ユーザが検索を実行する前に、関連する可能性のあるレコードに直接移動するためのショートカットを提供します。

構文

URI

vXX.X/search/suggestions?q=検索文字列&sobject=オブジェクト種別

適用開始バージョン

32.0

形式

JSON、XML

HTTP メソッド

GET

認証

Authorization: Bearer token

リクエストボディ

不要

要求パラメータ

パラメータ	説明
limit	省略可能。返される推奨レコードの最大数を指定します。制限が指定されていない場合、デフォルトで 5 レコードが返されます。指定された制限を超える推奨レコードが存在すると、レスポンスボディの hasMoreResults プロパティが `true` になります。
q	必須。適切に URL 符号化された、ユーザの検索クエリ文字列。ユーザのクエリ文字列が最小長要件 (中国語、日本語、韓国語の場合は 2 文字、その他のすべての言語の場合は 3 文字) を満たしている場合にのみ、推奨が返されます。クエリ文字列が最大長である 255 文字を超えると、エラーが返されます。
sobject	必須。account や offer__c など、検索の範囲となるオブジェクト。

使用方法

検索文字列がレコードの名前項目内のテキストと完全に一致する場合にのみ、レコードが推奨されます。1 語内に検索文字列が含まれるレコードは、一致とは見なされません。この推奨リソースは、検索文字列の最後に自動的にアスタリスクワイルドカードを付加します。

ユーザの検索クエリに疑問符またはワイルドカードが含まれている場合、それらの記号は URI でクエリ文字列から自動的に削除されます。

メモ

レコードは、レコード内に検索文字列全体が見つかった場合に、検索文字列内での指定と同じ並びで推奨されます。

例

たとえば、テキスト文字列 national u は national u* として扱われ、「National Utility」と「National Urban Company」は返されますが、「National Company Utility」や「Urban National Company」は返されません。

推奨レコード応答

この推奨リソースは、関連する可能性があるレコード (ユーザがアクセス可能なもの) についての表示可能なデータを返します。このリソースは、表示用のデータを取得するために ID を使用する他のサービスと併用できます。

結果の順序は、関連性アルゴリズムによって決まります。

結果内の各推奨レコードには、次の要素が含まれます。

要素	説明
Attributes	レコードのオブジェクト種別とレコードにアクセスするための URL。
Name (または Title)	レコードの名前項目。標準の名前項目がない場合、次のオブジェクトには標準のタイトル項目が使用されます。 Dashboard Idea IdeaTheme Note Question
Id	レコードの一意の識別子。
DisambiguationField	名前項目とタイトル項目を除き、検索結果レイアウトで各オブジェクトに指定された最初の項目の名前。デフォルトでは、カスタムオブジェクトにこの項目は含まれません。表示される項目を設定するには、各オブジェクトの検索結果レイアウトをカスタマイズします。レコードの名前項目またはタイトル項目は一意ではない可能性があるため、同じ名前を持つレコードが返された場合にユーザが区別しやすいように、この曖昧さ回避項目が提供されます。曖昧さ回避項目は、返される項目へのアクセス権が応答を開始したユーザにある場合にのみ、検索結果レイアウトに表示されるオブジェクトについて表示されます。
DisambiguationFieldValue	DisambiguationField の値。ユーザにこの項目へのアクセス権がある場合にのみ表示されます。

JSON レスポンスボディの例

1[ {
2  "attributes" : {
3    "type" : "Account",
4    "url" : "/services/data/v32.0/sobjects/Account/001xx000003DH6WAAW"
5  },
6  "Id" : "001xx000003DH6WAAW"
7  "Name" : "National Utility Service"
8  "DisambiguationField" : "Contact"
9  "DisambiguationFieldValue" : "Jane Doe"
10}, { 
11{
12  "attributes" : {
13    "type" : "Account",
14    "url" : "/services/data/v32.0/sobjects/Account/001xx000003DHJ4AAO"
15  },
16  "Id" : "001xx000003DHJ4AAO"
17  "Name" : "National Utility Service"
18  "DisambiguationField" : "Contact"
19  "DisambiguationFieldValue" : "John Smith"
20}, {
21{
22  "attributes" : {
23    "type" : "Account",
24    "url" : "/services/data/v32.0/sobjects/Account/001xx000003DHscAAG"
25  },
26  "Id" : "001xx000003DHscAAG"
27  "Name" : "National Urban Technology Center"
28  "DisambiguationField" : "Contact"
29  "DisambiguationFieldValue" : "John Smith"
30} ]

XML レスポンスボディの例

1<?xml version=”1.0” encoding=”UTF-8”?
2<suggestions>
3  <autoSuggestResults type="Account" url="/services/data/v32.0/sobjects/Account/001xx000003DH6WAAW">  
4    <Id>001xx000003DH6WAAW</Id>
5    <Name>National Utility Service</Name>
6    <DisambiguationField>Contact</Name>
7    <DisambiguationFieldValue>Jane Doe</Name>
8  </autoSuggestResults>
9  <autoSuggestResults type="Account" url="/services/data/v32.0/sobjects/Account/001xx000003DHJ4AAO">
10    <Id>001xx000003DHJ4AAO</Id>
11    <Name>National Utility Service</Name>
12    <DisambiguationField>Contact</Name>
13    <DisambiguationFieldValue>John Smith</Name>
14  </autoSuggestResults> 
15  <autoSuggestResults type="Account" url="/services/data/v32.0/sobjects/Account/001xx000003DHscAAG"> 
16    <Id>001xx000003DHscAAG</Id> 
17    <Name>National Urban Technology Center</Name> 
18    <DisambiguationField>Contact</Name>
19    <DisambiguationFieldValue>Jane Doe</Name>
20  </autoSuggestResults>
21  <hasMoreResults>true</hasMoreResults> 
22</suggestions>

サポートされるオブジェクト

この推奨リソースでは、次を除くすべてのオブジェクトがサポートされます。

ActionEmail
ActionTask
Article
ContentVersion
Document
Event
FeedComment
FeedPost
IdeaComment
Pricebook2
Product2
Reply
Solution
TagDefinition
Task
WorkflowRule

Force.com REST API 開発者ガイド

No Results