REST API 開発者ガイド
jオートコンプリートの結果とインスタント結果により推奨されたレコードの検索
名前がユーザーの検索文字列と一致した推奨レコードのリストを返します。この推奨リソースは、ユーザーが全文検索を実行する前に、関連する可能性のあるレコードに直接移動するためのオートコンプリートの結果とインスタント結果を提供します。このリソースは REST API バージョン 32.0 以降で使用できます。
この推奨リソースは、レコード名項目が検索文字列と一致するテキストを含む場合にレコードを返します。検索文字列内の最後の文字と、単語の先頭の一致も検出されます。1 語内に検索文字列が含まれるレコードは、一致とは見なされません。
テキスト文字列 national u は national u* として扱われ、「National Utility」、「National Urban Company」、「First National University」が返されます。
この推奨リソースは、関連する可能性があり、ユーザーがアクセス可能なレコードに関する、表示可能な状態のデータを返します。関連性アルゴリズムは結果の順序を決定します。結果内の各推奨レコードには、次の要素が含まれます。
| 要素 | 説明 |
|---|---|
| Attributes | レコードのオブジェクト種別とレコードにアクセスするための URL。 要求された参照項目の値も含まれます。たとえば、fields=Id,Name を要求した場合、結果には ID と名前が含まれます。 |
| Name (または Title) | レコードの名前項目。標準の名前項目がない場合、次のオブジェクトには標準のタイトル項目が使用されます。
|
| Id | レコードの一意の識別子。 |
この推奨リソースでは、次を除くすべての検索可能オブジェクトがサポートされます。
- ContentNote
- Event
- 外部オブジェクト
- FeedComment
- FeedPost
- IdeaComment
- Pricebook2
- Reply
- TagDefinition
- Task
構文
- URI
- /services/data/vXX.X/search/suggestions?q=searchString&sobject=objectTypes
- 形式
- JSON、XML
- HTTP のメソッド
- GET
- 認証
- Authorization: Bearer token
- リクエストボディ
- 不要
- 要求パラメーター
-
パラメーター 説明 fields 省略可能。ルックアップクエリの作成に使用します。カンマ区切りのリストを使用して複数の項目を指定します。応答で返される参照項目を指定します。 dynamicFields 省略可能。API バージョン 48.0 以降で使用できます。追加の動的項目を返すために使用されます。複数のオプションを指定するには、カンマ区切りのリストを使用します。たとえば、dynamicFields=secondaryField の場合、検索レイアウトの次の対象項目に基づいて、Id および Name (または Title) 以外の項目が結果の各推奨レコードに追加されます。 groupId 省略可能。返される質問が投稿されたグループの一意の識別子を指定します。カンマ区切りのリストを使用して複数のグループを指定します。このパラメーターは、パラメーターの type が question の場合にのみ適用されます。userId と併せて使用しないでください。 ignoreUnsupportedSObjects 省略可能。要求にサポート対象外のオブジェクトが含まれている場合、このパラメーターは、実行するアクションを指定します。false に設定した場合は、エラーが返されます。true に設定した場合は、オブジェクトが無視され、エラーは返されません。「サポート対象外のオブジェクト」セクションを参照してください。デフォルトは、false です。 limit 省略可能。返される推奨レコードの最大数を指定します。制限が指定されていない場合、デフォルトで 5 レコードが返されます。指定された制限を超える推奨レコードが存在すると、レスポンスボディの hasMoreResults プロパティが true になります。 networkId 省略可能。質問が返される Experience Cloud サイトの一意の識別子を 1 つ以上指定します。カンマ区切りのリストを使用して複数のサイトを指定します。このパラメーターは、パラメーターの type が question の場合、またはパラメーターの sobject が user の場合にのみ適用されます。 q 必須。適切に URL 符号化された、ユーザーの検索クエリ文字列。ユーザーの検索クエリ文字列が最小長要件 (中国語、日本語、韓国語、タイ語の場合は 1 文字、その他の言語の場合は 3 文字) を満たしている場合にのみ、推奨クエリが返されます。クエリ文字列が最大長である 255 文字 (または区切りの空白なしの連続した 200 文字) を超えると、エラーが返されます。 sobject 必須。Account や offer__c など、検索の範囲となるオブジェクト。 sobject の値が feedItem の場合は、type パラメーターが必須となり、その値として question を設定する必要があります。
カンマ区切りのリストを使用して最大 10 個のオブジェクトを指定します。たとえば、sobject=Account,Contact,Lead のように記述します。この機能を利用するには、[CrossObjectTypeahead] 権限を有効にします。
オブジェクトごとに返す特定の項目を指定するには、次の構文を使用します。複数の項目にはカンマ区切りのリストを使用します。sobject は小文字です。次に例を示します。
topicId 省略可能。返される質問がタグ付けされた単一のトピックの一意の識別子を指定します。このパラメーターは、パラメーターの type が question の場合にのみ適用されます。 type sobject の値が feedItem である場合は必須です。sobject のその他すべての値に対してこのパラメーターを含めると、クエリには影響しません。フィードの種別が質問であることを指定します。有効な値: question。 userId 省略可能。返される質問を作成したユーザーの一意の識別子を指定します。カンマ区切りのリストを使用して複数のユーザーを指定します。このパラメーターは、パラメーターの type が question の場合にのみ適用されます。groupId と併せて使用しないでください。 useSearchScope 省略可能。API バージョン 40.0 以降で使用できます。デフォルト値は、false です。false の場合、要求で指定されたオブジェクトを使用してレコードが提案されます。true の場合、要求で指定されたオブジェクトのほかに、ユーザーの検索範囲を使用してレコードが提案されます。検索範囲は、ユーザーが最も頻繁に使用するオブジェクトのリストです。 - 要求でオブジェクトが指定されない場合は、useSearchScope=true が使用されます。
- useSearchScope=true でユーザーの検索範囲が空白の場合、デフォルトの検索範囲を使用してレコードが提案されます。
- 通常は、最初の 10 個のオブジェクトのみがレコードの提案に使用されます。ただし、システム管理者は、結果が返されるときに常に考慮されるオブジェクトを割り当てることができます。設定すれば、最大 15 個のオブジェクトがレコードの提案に使用されます。オブジェクトの割り当てについての詳細は、「Assign Search Results Objects to Users (Beta) (検索結果オブジェクトのユーザーへの割り当て (ベータ))」を参照してください。
- sobject パラメーターで指定されたオブジェクトは、ユーザーの検索範囲内のオブジェクトよりも優先されます。
- ignoreUnsupportedSObjects パラメーターの値は検索範囲内のオブジェクトには適用されません。
この例では、検索範囲のみを使用します。この例では、検索範囲と Account オブジェクトを使用します。where 省略可能。SOQL の WHERE 句と同じ構文に従う検索条件。URL は式を符号化します。 オブジェクトの句を使用するか、互換性のあるすべてのオブジェクトの句をグローバルに使用します。オブジェクト固有の句の例: account.where=name%20LIKE%20%27Smith%25%27。グローバルな句の例: where=name%20LIKE%20%27Smith%25%27。パラメーターは小文字である必要があります。オブジェクト固有の where 句は、グローバルな where 句よりも優先されます。このパラメーターは Question オブジェクトには使用できません。
複数のエンティティを指定する場合は、以下の例を参照してください。この機能はバージョン 38.0 以降で使用できます。
例
- レスポンスボディの例
-
- 複数オブジェクト要求のレスポンスボディの例
-
- XML レスポンスボディの例
-