Search Suggested Article Title Matches

構文

URI

/vXX.X/search/suggestTitleMatches?q=search string&language=article language&publishStatus=article publication status

適用開始バージョン

30.0

形式

JSON、XML

HTTP メソッド

GET

認証

Authorization: Bearer token

リクエストボディ

不要

要求パラメータ

パラメータ	説明
articleTypes	省略可能。目的の記事タイプを示す 3 文字の ID プレフィックス。値ごとにパラメータ名を繰り返すことで、1 回の REST コールでこのパラメータに複数の値を指定できます。たとえば、articleTypes=ka0&articleTypes=ka1 です。
categories	省略可能。JSON の対応付けとして表現された、目的の記事のデータカテゴリグループの名前とデータカテゴリの名前。このパラメータには複数のデータカテゴリグループとデータカテゴリのペアを指定できます。たとえば、categories={"Regions":"Asia","Products":"Laptops"} のようにします。URL 内の文字を符号化する必要がある場合があります。この例の場合、categories=%7B%22Regions%22%3A%22Asia​%22%2C%22Products%22%3A%22Laptops%22%7D です。
channel	省略可能。一致する記事を参照できるチャネル。有効な値は次のとおりです。 AllChannels – ユーザがアクセス権を持つすべてのチャネルで参照可能 App – 内部 Salesforce ナレッジアプリケーションで参照可能 Pkb – 公開知識ベースで参照可能 Csp – カスタマーポータルで参照可能 Prm – パートナーポータルで参照可能 channel が指定されていない場合、ユーザの種別によってデフォルト値が決まります。 ゲストユーザの Pkb カスタマーポータルユーザの Csp パートナーポータルユーザの Prm 他の種別のユーザの App channel が指定されている場合、特定の要件により、指定された値が要求した実際の値にならないことがあります。 ゲストユーザ、カスタマーポータルユーザ、パートナーポータルユーザの場合、指定された値は各ユーザ種別のデフォルト値と一致する必要があります。値が一致しないか、AllChannels が指定されていると、指定された値が App に置き換えられます。 ゲストユーザ、カスタマーポータルユーザ、パートナーポータルユーザ以外のすべてのユーザの場合は、次のようになります。 Pkb、Csp、Prm、または App が指定されていると、指定された値が使用されます。 AllChannels が指定されていると、指定された値が App に置き換えられます。
language	必須。ユーザのクエリの言語。一致する記事が作成された言語を指定します。
limit	省略可能。返される記事の最大数を指定します。指定された制限を超える推奨記事が存在すると、レスポンスボディの hasMoreResults プロパティが true になります。
publishStatus	必須。記事の公開状況。有効な値は次のとおりです。 Draft – Salesforce ナレッジに公開されていない記事。 Online – Salesforce ナレッジに公開されている記事。 Archived – [アーカイブ済み記事] ビューで参照可能な公開されていない記事。
q	必須。適切に URL 符号化された、ユーザの検索クエリ文字列。ユーザの検索クエリ文字列が最小長要件 (中国語、日本語、韓国語の場合は 1 文字、その他の言語の場合は 3 文字) を満たしている場合にのみ、推奨クエリが返されます。クエリ文字列が最大長である 250 文字を超えると、エラーが返されます。
topics	省略可能。返される記事のトピック。たとえば、topics=outlook&topics=email です。
validationStatus	省略可能。返される記事の検証状況。

タイトルが一致する推奨記事を取得する場合の例

1curl https://yourInstance.salesforce.com/services/data/v30.0/search/suggestTitleMatches?
2q=orange+banana&language=en_US&publishStatus=Online -H "Authorization: Bearer token"

JSON レスポンスボディの例

1{
2  "autoSuggestResults" : [ {
3    "attributes" : {
4    "type" : "KnowledgeArticleVersion",
5    "url" : "/services/data/v30.0/sobjects/KnowledgeArticleVersion/ka0D00000004CcQ"
6    },
7  "Id" : "ka0D00000004CcQ",
8  "UrlName" : "orange-banana",
9  "Title" : "orange banana",
10  "KnowledgeArticleId" : "kA0D00000004Cfz"
11  } ],
12  "hasMoreResults" : false
13}

使用方法

Salesforce ナレッジが組織で有効になっている必要があります。ユーザの「記事の参照」権限が有効化されている必要があります。ユーザが参照する権限を持つデータカテゴリおよび記事タイプに基づいて、ユーザがアクセスできる記事のみが推奨記事に含まれます。

Suggest Article Title Matches リソースは、関係する可能性のある記事に関して表示準備のできたデータを返すように設計されています。「a」、「for」、「the」などのストップワードを除いたクエリ文字列全体がタイトル��含まれる記事も推奨されます。

返される推奨クエリの数が要求で指定された制限を超えると、hasMoreResults という項目が応答の最後に含まれます。返される推奨クエリが使用可能な推奨クエリのサブセットのみの場合は値が true になり、そうでない場合は false になります。