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

SynonymDictionary

シノニムグループ (ユーザの検索で同義とされる語または句の集合) のセットを表します。シノニムグループを定義して、頭字語、商品名のバリエーション、および組織に固有のその他の用語の検索結果を最適化できます。

シノニムは、Salesforce ナレッジなどの Service Cloud 機能で使用できます。Metadata メタデータ型を拡張し、その fullName 項目を継承します。

ファイルのサフィックスおよびディレクトリの場所

SynonymDictionary コンポーネントのサフィックスは .synonymDictionary であり、synonymDictionaries フォルダに保存されます。

バージョン

SynonymDictionary コンポーネントは、API バージョン 29.0 以降で使用できます。

特別なアクセスルール

シノニムが組織で有効になっている必要があります。「シノニムの管理」権限を持つユーザのみがこのオブジェクトにアクセスできます。

項目

項目名	項目の型	説明
groups	SynonymGroup	この辞書で定義されているシノニムグループです。
isProtected	boolean	このコンポーネントが保護されるか (`true`)、否か (`false`) を示します。保護コンポーネントは、インストールする組織で作成されたコンポーネントによってリンク設定したり参照したりすることはできません。
label	string	必須。シノニム辞書の表示名を指定します。

SynonymGroup

同義の単語または語句のグループを表します。

項目名	項目の型	説明
languages	Language	必須。シノニムグループを適用する言語を指定します。シノニムが 1 つの言語に固有である場合は、その言語のみを指定します。シノニムを複数の言語に適用する場合は、1 つのシノニムグループに複数の言語を指定します。
terms	string	必須。グループの他の用語と同義の単語または語句です。最大 50 文字です。グループごとに terms は最小 2 語です。シノニムグループには対称性があります。つまり、oranges と apples がシノニムグループで定義されている場合、`oranges` を検索すると、`apples` との一致が返され、`apples` を検索するとその逆が返されます。

宣言的なメタデータの定義のサンプル

次に、SynonymDictionary コンポーネントの例を示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<SynonymDictionary xmlns="http://soap.sforce.com/2006/04/metadata">
3    <groups>
4        <languages>en_US</languages>
5        <terms>Salesforce</terms>
6        <terms>salesforce.com</terms>
7        <terms>The Customer Company</terms>
8        <terms>SFDC</terms>
9    </groups>
10    <groups>
11        <languages>fr</languages>
12        <terms>renault</terms>
13        <terms>clio</terms>
14    </groups>
15    <label>Sample Dictionary</label>
16</SynonymDictionary>

SynonymDictionary コンポーネントを参照する package.xml の例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>Sample Dictionary</members>
5        <name>SynonymDictionary</name>
6    </types>
7    <version>46.0</version>
8</Package>

使用方法

API バージョン 29.0 より前に定義された既存のシノニムグループがある場合、既存のグループは _Default というデフォルトの辞書に関連付けられます。

頻繁な更新を必要とするシノニムのセットがある場合、シノニムグループまたはグループを少数のグループを持つ専用の辞書に割り当てることをお勧めします。既存の辞書をリリースするたびに、すべてのシノニムグループが上書きされます。辞書内の単一のシノニムグループのみの更新のリリースはサポートしていません。

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。

メタデータ API 開発者ガイド