メタデータ API 開発者ガイド
jKeywordList
Experience Cloud サイトモデレーションで使用されるキーワードのリストを表します。このキーワードリストは、サイトでの使用を禁止する攻撃的な表現や不適切なコンテンツを定義するモデレーション条件の一種です。
Metadata メタデータ型を拡張し、その fullName 項目を継承します。
キーワードリスト条件を作成する場合は、次の点に注意してください。
- 組織では、最大 30 個のキーワードリスト条件を設定できます。これは、Experience Cloud サイト単位ではなく組織単位の制限です。
- 各キーワードリストには、最大 2,000 個のキーワードを指定できます。
- キーワードとユーザが生成したコンテンツを照合するとき、大文字と小文字の違いと末尾の句読点は無視されます。たとえば、条件に「BadWord」が含まれている場合、ユーザが「BADWORD」または「badword.」と入力すると一致します。
ファイルのサフィックスおよびディレクトリの場所
KeywordList コンポーネントのサフィックスは .keywords で、このコンポーネントは対応するパッケージディレクトリの moderation ディレクトリに保存されます。ファイル名の形式は、site_name.keyword_list_developer_name.keywords のようになります。
バージョン
KeywordList コンポーネントは、API バージョン 36.0 以降で使用できます。
特別なアクセスルール
キーワードリストの参照、作成、編集、削除を行うには、「エクスペリエンスの管理」または「エクスペリエンスの作成および設定」権限が必要です。Spring '20 以降は、モデレーションルールを編集するための権限を持つユーザのみがこのオブジェクトにアクセスできます。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| Description | string | キーワードリストの説明。 |
| keywords | Keyword[] | Experience Cloud サイトでモデレートするキーワード。 |
| masterLabel | string | 必須。キーワードリストの表示ラベル。 |
キーワード
キーワードリストのキーワード。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| keyword | string | 必須。モデレートするキーワード。
|
宣言的なメタデータの定義のサンプル
KeywordList コンポーネントの例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<KeywordList xmlns="http://soap.sforce.com/2006/04/metadata">
3 <masterLabel>Bad Word List</masterLabel>
4 <description>List of bad words updated by Joe in Nov 2015.</description>
5 <keywords>
6 <keyword>bad-word</keyword>
7 </keywords>
8 <keywords>
9 <keyword>b a d w o r d</keyword>
10 </keywords>
11 <keywords>
12 <keyword>b@dword</keyword>
13 </keywords>
14</KeywordList>前の定義を参照する package.xml の例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <name>KeywordList</name>
5 <members>site1.badword_list</members>
6 </types>
7 <version>36.0</version>
8</Package>マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。