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

BaseSharingRule メタデータ型を拡張し、その sharedTo 項目を継承します。詳細は、Salesforce オンラインヘルプの「条件に基づく共有ルールの概要」を参照してください。

CriteriaBasedSharingRule コンポーネントを直接作成することはできません。代わりに子コンポーネントを使用してください。

メモ

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所

CriteriaBasedSharingRule コンポーネントは、criteriaBasedRules 項目の SharingRules コンポーネント内に保存されます。

バージョン

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

特別なアクセスルール

Spring ’20 以降、このオブジェクトにアクセスできるのは、「設定・定義を参照する」権限を持つユーザのみとなります。また、このオブジェクトを編集できるのは、「共有の管理」権限を持つユーザのみとなります。

項目

次の情報は、標準オブジェクトとカスタムオブジェクトの共有ルールの実装を理解していることを前提としています。これらの項目についての詳細は、Salesforce オンラインヘルプの「共有設定」を参照してください。

項目	項目の型	説明
criteriaItems	FilterItem[]	共有ルールの条件を表すリスト。値は次のとおりです。 `field` `operation` `value`

AccountCriteriaBasedSharingRule

取引先の条件に基づく共有ルールを表します。CriteriaBasedSharingRule メタデータ型を拡張し、その criteriaItems 項目を継承します。

AccountCriteriaBasedSharingRule は、AccountSharingRules の criteriaBasedRules 項目によって使用されます。

項目	項目の型	説明
accountAccessLevel	`ShareAccessLevelNoNone` (string 型の列挙)	必須。ユーザまたはグループが取引先に対して持つアクセスレベルを表す値。値は次のとおりです。 `Read` `Edit` `All`
booleanFilter	string	共有ルールの検索条件ロジックを表します。
caseAccessLevel	`ShareAccessLevelNoAll` (string 型の列挙)	必須。ユーザまたはグループが取引先に関連付けられたケースに対して持つアクセスレベルを表す値。値は次のとおりです。 `None` `Read` `Edit`
contactAccessLevel	`ShareAccessLevelNoAll` (string 型の列挙)	必須。ユーザまたはグループが取引先に関連付けられた取引先責任者に対して持つアクセスレベルを表す値。値は次のとおりです。 `None` `Read` `Edit`
description	string	共有ルールの説明を表します。最大 1000 文字です。この項目は、API バージョン 29.0 以降で使用できます。
name	string	必須。共有ルールの名前。ユーザインターフェースの [表示ラベル] に対応します。
opportunityAccessLevel	`ShareAccessLevelNoAll` (string 型の列挙)	必須。対象グループに許可される、関連付けられた商談に対するアクセスレベルを表す値。値は次のとおりです。 `None` `Read` `Edit`

CampaignCriteriaBasedSharingRule

キャンペーンの条件に基づく共有ルールを表します。CriteriaBasedSharingRule メタデータ型を拡張し、その criteriaItems 項目を継承します。

CampaignCriteriaBasedSharingRule は、CampaignSharingRules の criteriaBasedRules 項目によって使用されます。

項目	項目の型	説明
booleanFilter	string	共有ルールの検索条件ロジックを表します。
description	string	共有ルールの説明を表します。最大 1000 文字です。この項目は、API バージョン 29.0 以降で使用できます。
campaignAccessLevel	`ShareAccessLevelNoNone` (string 型の列挙)	必須。対象グループに許可される、キャンペーンに対するアクセスレベルを表す値。値は次のとおりです。 `Read` `Edit` `All`
name	string	必須。共有ルールの名前。ユーザインターフェースの [表示ラベル] に対応します。

CaseCriteriaBasedSharingRule

ケースの条件に基づく共有ルールを表します。CriteriaBasedSharingRule メタデータ型を拡張し、その criteriaItems 項目を継承します。

CaseCriteriaBasedSharingRule は、CaseSharingRules の criteriaBasedRules 項目によって使用されます。

項目	項目の型	説明
booleanFilter	string	共有ルールの検索条件ロジックを表します。
description	string	共有ルールの説明を表します。最大 1000 文字です。この項目は、API バージョン 29.0 以降で使用できます。
caseAccessLevel	`ShareAccessLevelReadEdit` (string 型の列挙)	必須。許可されるケースに対するアクセスレベルを表す値。値は次のとおりです。 `Read` `Edit`
name	string	必須。共有ルールの名前。ユーザインターフェースの [表示ラベル] に対応します。

ContactCriteriaBasedSharingRule

取引先責任者の条件に基づく共有ルールを表します。CriteriaBasedSharingRule メタデータ型を拡張し、その criteriaItems 項目を継承します。

ContactCriteriaBasedSharingRule は、ContactSharingRules の criteriaBasedRules 項目によって使用されます。

項目	項目の型	説明
booleanFilter	string	共有ルールの検索条件ロジックを表します。
description	string	共有ルールの説明を表します。最大 1000 文字です。この項目は、API バージョン 29.0 以降で使用できます。
contactAccessLevel	`ShareAccessLevelReadEdit` (string 型の列挙)	必須。対象グループ、ロール、またはユーザに許可される取引先責任者に対するアクセスレベルを表す値。値は次のとおりです。 `Read` `Edit`
name	string	必須。共有ルールの名前。ユーザインターフェースの [表示ラベル] に対応します。

LeadCriteriaBasedSharingRule

リードの条件に基づく共有ルールを表します。CriteriaBasedSharingRule メタデータ型を拡張し、その criteriaItems 項目を継承します。

LeadCriteriaBasedSharingRule は、LeadSharingRules の criteriaBasedRules 項目によって使用されます。

項目	項目の型	説明
booleanFilter	string	共有ルールの検索条件ロジックを表します。
description	string	共有ルールの説明を表します。最大 1000 文字です。この項目は、API バージョン 29.0 以降で使用できます。
leadAccessLevel	`ShareAccessLevelReadEdit` (string 型の列挙)	必須。許可されるアクセスのレベルを表す値。状況には次のものがあります。 `Read` `Edit`
name	string	必須。共有ルールの名前。ユーザインターフェースの [表示ラベル] に対応します。

OpportunityCriteriaBasedSharingRule

商談の条件に基づく共有ルールを表します。CriteriaBasedSharingRule メタデータ型を拡張し、その criteriaItems 項目を継承します。

OpportunityCriteriaBasedSharingRule は、OpportunitySharingRules の criteriaBasedRules 項目によって使用されます。

項目	項目の型	説明
booleanFilter	string	共有ルールの検索条件ロジックを表します。
description	string	共有ルールの説明を表します。最大 1000 文字です。この項目は、API バージョン 29.0 以降で使用できます。
opportunityAccessLevel	`ShareAccessLevelReadEdit` (string 型の列挙)	必須。許可されるアクセスのレベルを表す値。状況には次のものがあります。 `Read` `Edit`
name	string	必須。共有ルールの名前。ユーザインターフェースの [表示ラベル] に対応します。

CustomObjectCriteriaBasedSharingRule

カスタムオブジェクトの条件に基づく共有ルールを表します。CriteriaBasedSharingRule メタデータ型を拡張し、その criteriaItems 項目を継承します。

CustomObjectCriteriaBasedSharingRule は、CustomObjectSharingRules の criteriaBasedRules 項目によって使用されます。

項目	項目の型	説明
accessLevel	string	必須。許可された共有の種別を表す値。値は次のとおりです。 `Read` `Edit` `All`
booleanFilter	string	共有ルールの検索条件ロジックを表します。
description	string	共有ルールの説明を表します。最大 1000 文字です。この項目は、API バージョン 29.0 以降で使用できます。
name	string	必須。共有ルールの名前。ユーザインターフェースの [表示ラベル] に対応します。

UserCriteriaBasedSharingRule

ユーザの条件に基づく共有ルールを表します。CriteriaBasedSharingRule メタデータ型を拡張し、その criteriaItems 項目を継承します。

UserCriteriaBasedSharingRule は、UserSharingRules の criteriaBasedRules 項目によって使用されます。

項目	項目の型	説明
booleanFilter	string	共有ルールの検索条件ロジックを表します。
description	string	共有ルールの説明を表します。最大 1000 文字です。この項目は、API バージョン 29.0 以降で使用できます。
name	string	必須。共有ルールの名前。ユーザインターフェースの [表示ラベル] に対応します。
userAccessLevel	`ShareAccessLevelReadEdit` (string 型の列挙)	必須。許可された共有の種別を表す値。値は次のとおりです。 `Read` `Edit`

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

2 つの所有者に基づく共有ルールと、2 つの条件項目を含む 1 つの条件に基づく共有ルールの定義を次に示します。ファイル名は、accountSharingRules ディレクトリの下の Account.sharingRules ファイルに対応します。

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

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