メタデータ API 開発者ガイド
jSharingRules
Metadata メタデータ型を拡張し、その fullName 項目を継承します。詳細は、Salesforce オンラインヘルプの「共有ルール」を参照してください。
API バージョン 33.0 以降では、組織内のすべての共有ルールの取得、削除、またはリリースが可能です。ワイルドカードもサポートされます。手動共有ルールの取得、削除、リリース、および種別 (所有者、条件、テリトリー) ごとの共有ルールの取得、削除、リリースはできません。
宣言的なメタデータファイルのサフィックスおよびディレクトリの場所
API バージョン 33.0 以降、コンポーネントは sharingRules フォルダに保存され、それらのファイル名は、オブジェクト名にサフィックス .sharingRules を加えた名前と同じになります。条件に基づく共有ルール、所有者に基づく共有ルール、およびテリトリーに基づく共有ルールはすべて object.sharingRule ファイルに含まれます。
API バージョン 33.0 より前では、SharingRules コンポーネントは、対応するオブジェクトディレクトリに保存され、ファイル名はオブジェクト名と同じになります。たとえば、accountSharingRules ディレクトリには取引先共有ルールの Account.sharingRules ファイルが含まれます。カスタムオブジェクトの SharingRules は、customObjectSharingRules ディレクトリに保存されます。このディレクトリには、ObjA__c.sharingRules など、拡張子が .sharingRules のファイルが含まれます。ObjA はカスタムオブジェクト種別の開発者名を指します。
バージョン
SharingRules コンポーネントは API バージョン 24.0 以降で使用できますが、API バージョン 33.0 以降、AccountSharingRules、CampaignSharingRules、CaseSharingRules、ContactSharingRules、LeadSharingRules、OpportunitySharingRules、AccountTerritorySharingRules、CustomObjectSharingRules、および UserSharingRules コンポーネントを使用できなくなります。
API バージョン 33.0 以降は、SharingCriteriaRule、SharingOwnerRule、および SharingTerritoryRule を使用してください。
項目
次の情報は、標準オブジェクトとカスタムオブジェクトの共有ルールの実装を理解していることを前提としています。これらの項目についての詳細は、Salesforce オンラインヘルプの「共有設定」を参照してください。
| 項目 | データ型 | 説明 |
|---|---|---|
| sharingCriteriaRules | SharingCriteriaRule[] | 条件に基づく共有ルールの配列。API バージョン 33.0 以降で利用できます。 |
| sharingOwnerRules | SharingOwnerRule[] | 所有権に基づく共有ルールの配列。API バージョン 33.0 以降で利用できます。 |
| sharingTerritoryRules | SharingTerritoryRule[] | テリトリーに基づく共有ルールの配列。API バージョン 33.0 以降で利用できます。 |
SharingCriteriaRule
条件に基づく共有ルールを定義します。SharingBaseRule を拡張し、そのすべての項目を継承します。API バージョン 33.0 以降で利用できます。
| 項目 | データ型 | 説明 |
|---|---|---|
| booleanFilter | string | 共有ルールに指定されている高度な絞り込み条件。 |
| criteriaItems | FilterItem[] | この共有ルールの Boolean 条件の配列。 |
SharingOwnerRule
所有権に基づく共有ルールを定義します。SharingBaseRule を拡張し、そのすべての項目を継承します。API バージョン 33.0 以降で利用できます。
| 項目 | データ型 | 説明 |
|---|---|---|
| sharedFrom | SharedTo | 必須。レコードの所有者を指定します。 |
SharingTerritoryRule
テリトリーに基づく共有ルール��定義します。SharingOwnerRule を拡張し、そのすべての項目を継承します。API バージョン 33.0 以降で利用できます。
AccountSharingRules
取引先の共有ルールを表します。SharingRules メタデータ型を拡張し、その fullName 項目を継承します。API バージョン 32.0 以前でのみ利用できます。
| 項目 | データ型 | 説明 |
|---|---|---|
| criteriaBasedRules | AccountCriteriaBasedSharingRule[] | ユーザの条件に基づくルールを定義するリスト。 |
| ownerRules | AccountOwnerSharingRule[] | ユーザのメンバーシップに基づくルールを定義するリスト。 |
CampaignSharingRules
キャンペーンの共有ルールを表します。SharingRules メタデータ型を拡張し、その fullName 項目を継承します。API バージョン 32.0 以前でのみ利用できます。
| 項目 | データ型 | 説明 |
|---|---|---|
| criteriaBasedRules | CampaignCriteriaBasedSharingRule[] | ユーザの条件に基づくルールを定義するリスト。 |
| ownerRules | CampaignOwnerSharingRule[] | ユーザのメンバーシップに基づくルールを定義するリスト。 |
CaseSharingRules
ケースの共有ルールを表します。SharingRules メタデータ型を拡張し、その fullName 項目を継承します。API バージョン 32.0 以前でのみ利用できます。
| 項目 | データ型 | 説明 |
|---|---|---|
| criteriaBasedRules | CaseCriteriaBasedSharingRule[] | ユーザの条件に基づくルールを定義するリスト。 |
| ownerRules | CaseOwnerSharingRule[] | ユーザのメンバーシップに基づくルールを定義するリスト。 |
ContactSharingRules
取引先責任者の共有ルールを表します。SharingRules メタデータ型を拡張し、その fullName 項目を継承します。API バージョン 32.0 以前でのみ利用できます。
| 項目 | データ型 | 説明 |
|---|---|---|
| criteriaBasedRules | ContactCriteriaBasedSharingRule[] | ユーザの条件に基づくルールを定義するリスト。 |
| ownerRules | ContactOwnerSharingRule[] | ユーザのメンバーシップに基づくルールを定義するリスト。 |
LeadSharingRules
リードの共有ルールを表します。SharingRules メタデータ型を拡張し、その fullName 項目を継承します。API バージョン 32.0 以前でのみ利用できます。
| 項目 | データ型 | 説明 |
|---|---|---|
| criteriaBasedRules | LeadCriteriaBasedSharingRule[] | ユーザの条件に基づくルールを定義するリスト。 |
| ownerRules | LeadOwnerSharingRule[] | ユーザのメンバーシップに基づくルールを定義するリスト。 |
OpportunitySharingRules
商談の共有ルールを表します。SharingRules メタデータ型を拡張し、その fullName 項目を継承します。API バージョン 32.0 以前でのみ利用できます。
| 項目 | データ型 | 説明 |
|---|---|---|
| criteriaBasedRules | OpportunityCriteriaBasedSharingRule[] | ユーザの条件に基づくルールを定義するリスト。 |
| ownerRules | OpportunityOwnerSharingRule[] | ユーザのメンバーシップに基づくルールを定義するリスト。 |
AccountTerritorySharingRules
取引先テリトリーの共有ルールを表します。SharingRules メタデータ型を拡張し、その fullName 項目を継承します。API バージョン 32.0 以前でのみ利用できます。
| 項目 | データ型 | 説明 |
|---|---|---|
| rules | AccountTerritorySharingRule[] | ユーザのメンバーシップに基づくルールを定義するリスト。sharedFrom 項目の許容値のリストは次のとおりです。
|
CustomObjectSharingRules
カスタムオブジェクトの共有ルールを表します。SharingRules メタデータ型を拡張し、その fullName 項目を継承します。API バージョン 32.0 以前でのみ利用できます。
| 項目 | データ型 | 説明 |
|---|---|---|
| criteriaBasedRules | CustomObjectCriteriaBasedSharingRule[] | ユーザの条件に基づくルールを定義するリスト。 |
| ownerRules | CustomObjectOwnerSharingRule[] | ユーザのメンバーシップに基づくルールを定義するリスト。 |
UserSharingRules
ユーザの共有ルールを表します。ユーザの共有ルールでは、グループのメンバーを別のグループのメンバーと共有できます。SharingRules メタデータ型を拡張し、その fullName 項目を継承します。API バージョン 32.0 以前でのみ利用できます。
| 項目 | データ型 | 説明 |
|---|---|---|
| criteriaBasedRules | UserCriteriaBasedSharingRule[] | ユーザの条件に基づくルールを定義するリスト。 |
| membershipRules | UserMembershipSharingRule[] | ユーザのメンバーシップに基づくル��ルを定義するリスト。 |
宣言的なメタデータの定義のサンプル
共有ルールの取得については、「共有ルール」の package.xml サンプルを参照してください。
次の XML 定義サンプルは、API バージョン 33.0 の条件に基づく共有ルールを表します。
次の XML 定義サンプルは、API バージョン 33.0 の所有権に基づく共有ルールを表します。
次の XML 定義サンプルは、API バージョン 33.0 のテリトリーに基づく共有ルールを表します。
API バージョン 32.0 以前の 2 つの取引先所有者に基づく共有ルールの定義を次に示します。ファイル名は、accountSharingRules ディレクトリ下の Account.sharingRules に対応します。この定義では、ownerRules が AccountOwnerSharingRule に対応します。
API バージョン 32.0 以前の、ユーザの条件に基づく共有ルールとユーザのメンバーシップに基づく共有ルールの定義を次に示します。ファイル名は、userSharingRules ディレクトリ下の User.sharingRules に対応します。
package.xml ファイルのサンプルを次に示します。