メンバー生成コンテンツをモデレートするためにコミュニティで使用されるルールを表します。各ルールには、ルールの適用対象となるメンバー生成コンテンツ、ルールを適用する条件、および実行するモデレーションアクションを指定します。モデレーションルールは、コミュニティをスパム、ボット、攻撃的または不適切なコンテンツから保護します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。
メタデータ API で作成されたコミュニティモデレーションルールは、[コミュニティ管理] の UI で設定されたモデレーションルールよりも強力です。たとえば、UI では、投稿およびコメントをモデレートするルールを作成できます。メタデータ API では、リンクフィード種別のリンク名のみをモデレートするルールを作成できます。複雑なモデレーションルールを表現するには、メタデータ API を使用します。
メタデータ API を使用して作成したモデレーションルールを [コミュニティ管理] の UI で更新しないでください。これを行うと、関連するメタデータ API 項目が上書きされるか、項目が無視されます。
モデレーションルールを作成する場合は、次の点に注意してください。
- 組織では、最大 30 個のルールを設定できます。これは、コミュニティ単位ではなく組織単位の制限です。この制限には、コンテンツルールと処理数ルールの両方が含まれます。
- 各ルールには最大 3 つのキーワード条件を含めることができます。
- コンテンツをブロックするルールが最初に実行され、続いてコンテンツを確認し承認するルール、コンテンツを置き換えるルール、コンテンツにフラグを設定するルールの順に実行されます。複数のルールが同じアクションを実行する場合、ルールが作成された日付を基準にして、古い順に実行されます。コンテンツを置き換えるルールは、コンテンツが確認ルールにも適用される場合は実行されません。つまり、コミュニティマネージャが元のコンテンツを確認するようにします。
ファイルのサフィックスおよびディレクトリの場��
ModerationRule コンポーネントのサフィックスは .rule で、このコンポーネントは対応するパッケージディレクトリの moderation ディレクトリに保存されます。ファイル名の形式は、community_name.moderation_rule_developer_name.rule のようになります。
バージョン
ModerationRule コンポーネントは、API バージョン 36.0 以降で使用できます。
特別なアクセスルール
モデレーションルールの参照、作成、編集、削除を行うには、「コミュニティの管理」または「コミュニティの作成および設定」権限が必要です。Spring '20 以降は、モデレーションルールを編集するための権限を持つユーザのみがこのオブジェクトにアクセスできます。
項目
| action |
ModerationRuleAction (string 型の列挙) |
必須。実行するモデレーションアクションを示します。有効な値は、次のとおりです。
- Block
- Review
- Replace
- Flag
-
FreezeAndNotify (将来の使用のために予約)。
|
| actionLimit |
int |
モデレーションアクションの制限を示します。API 39.0 以降で使用できます。 |
| active |
boolean |
必須。モデレーションルールが有効か (true)、無効か (false) を示します。 |
| description |
string |
モデレーションルールの説明。 |
| entitiesAndFields |
ModerateEntityField[] |
このモデレーションルールを適用するユーザ生成コンテンツのタイプを示します。 |
| masterLabel |
string |
必須。モデレーションルールの表示ラベル。 |
| notifyLimit |
int |
モデレーションルールの通知制限を示します。API 39.0 以降で使用できます。 |
| userCriteria |
string |
コミュニティのモデレーションルールで使用するメンバー条件を表します。API 39.0 以降で使用できます。 |
| userMessage |
string |
コンテンツがブロックされたときにコミュニティメンバーに表示されるメッセージ。%BLOCKED_KEYWORD% 変数を使用して、ブロックされた語を 5 個までユーザメッセージに表示できます。メッセージを指定しないと、メンバーには標準メッセージ「このコミュニティでは、%BLOCKED_KEYWORD% やその他の不適切な語を使用できません。コンテンツを確認してもう一度お試しください。」が表示されます。 |
ModeratedEntityField
モデレートする項目およびエンティティ。
| entityName |
string |
必須。モデレーションルールを適用するユーザ生成コンテンツのタイプを示します。投稿とコメントは、グループおよびユーザプロファイルで作成されたコンテンツにのみ適用されます。すべてのフィード種別 (アンケートやリンクなど) がサポートされています。 |
| fieldName |
string |
モデレーションルールを適用する項目を示します。フィード投稿をモデレートするには、entityName FeedItem と fieldName RawBody を使用します。フィードコメントをモデレートするには、entityName FeedComment と fieldName RawCommentBody を使用します。RawBody および RawCommentBody 項目は、他の API では使用できません。 |
| keywordList |
KeywordList string |
モデレートの対象となるキーワードリストを示します。 |
ModerationRuleType
必須。ユーザが生成したコンテンツを実行するためのルールのタイプを示します。
| type |
(string 型の列挙) |
必須。ユーザが生成したコンテンツを実行するためのルールのタイプを示します。 有効な値は、次のとおりです。
API 39.0 以降で使用できます。 |
RateLimitTimePeriod
必須。処理数制限に適用される期間を示します。
| timePeriod |
(string 型の列挙) |
必須。処理数制限に適用される期間を示します。有効な値は、次のとおりです。
API 39.0 以降で使用できます。 |
宣言的なメタデータの定義のサンプル
ModerationRule コンポーネントの例を次に示します。
前の定義を参照する package.xml の例を次に示します。
マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。
j