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

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

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

メモ

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

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

バージョン

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

特別なアクセスルール

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

項目

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

項目	項目の型	説明
sharedFrom	SharedTo	必須。レコードの所有者を指定します。
sharedTo	SharedTo	必須。レコードを共有するユーザを指定します。
fullName	string	API アクセスの一意の識別子。fullName には、アンダースコアと英数字のみを使用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、Metadata コンポーネントから継承されています。

AccountOwnerSharingRule

所有者以外のユーザと取引先を共有するためのルールを表します。これは、OwnerSharingRule メタデータ型を拡張し、その fullName 項目、sharedFrom 項目、および sharedTo 項目を継承します。

AccountOwnerSharingRule は AccountSharingRules の ownerRules 項目で使用されます。

項目	項目の型	説明
accountAccessLevel	`ShareAccessLevelNoNone` (string 型の列挙)	必須。グループまたはロールが取引先に対して持つアクセス権のレベルを表す値。値は次のとおりです。 `Read` `Edit` `All`
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`

CampaignOwnerSharingRule

所有者以外のユーザとキャンペーンを共有するためのルールを表します。これは、OwnerSharingRule メタデータ型を拡張し、その fullName 項目、sharedFrom 項目、および sharedTo 項目を継承します。

CampaignOwnerSharingRule は CampaignSharingRules の ownerRules 項目で使用されます。

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

CaseOwnerSharingRule

所有者以外のユーザとケースを共有するためのルールを表します。これは、OwnerSharingRule メタデータ型を拡張し、その fullName 項目、sharedFrom 項目、および sharedTo 項目を継承します。

CaseOwnerSharingRule は CaseSharingRules の ownerRules 項目によって使用されます。次の項目はすべて必須項目です。

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

ContactOwnerSharingRule

所有者以外のユーザと取引先責任者を共有するためのルールを表します。これは、OwnerSharingRule メタデータ型を拡張し、その fullName 項目、sharedFrom 項目、および sharedTo 項目を継承します。

ContactOwnerSharingRule は ContactSharingRules の ownerRules 項目で使用されます。

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

LeadOwnerSharingRule

所有者以外のユーザとリードを共有するためのルールを表します。これは、OwnerSharingRule メタデータ型を拡張し、その fullName 項目、sharedFrom 項目、および sharedTo 項目を継承します。

LeadOwnerSharingRule は LeadSharingRules の ownerRules 項目で使用されます。

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

OpportunityOwnerSharingRule

所有者以外のユーザと商談を共有するためのルールを表します。これは、OwnerSharingRule メタデータ型を拡張し、その fullName 項目、sharedFrom 項目、および sharedTo 項目を継承します。

OpportunityOwnerSharingRule は OpportunitySharingRules の ownerRules 項目で使用されます。

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

AccountTerritorySharingRule

テリトリー内の取引先を共有するためのルールを表します。これは、OwnerSharingRule メタデータ型を拡張し、その fullName 項目、sharedFrom 項目、および sharedTo 項目を継承します。

AccountTerritorySharingRule は AccountTerritorySharingRules の ownerRules 項目で使用されます。

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

CustomObjectOwnerSharingRule

カスタムオブジェクトの共有ルールを表します。これは、OwnerSharingRule メタデータ型を拡張し、その fullName 項目、sharedFrom 項目、および sharedTo 項目を継承します。

CustomObjectOwnerSharingRule は CustomObjectSharingRules の ownerRules 項目で使用されます。

項目	項目の型	説明
accessLevel	string	必須。カスタムオブジェクトに対してグループまたはロールに許可されているアクセス権のレベルを表す値。値は次のとおりです。 `Read` `Edit` `All`
description	string	共有ルールの説明を表します。最大 1000 文字です。この項目は、API バージョン 29.0 以降で使用できます。
name	string	必須。共有ルールの名前。ユーザインターフェースの [表示ラベル] に対応します。

UserMembershipSharingRule

グループのメンバーを別のグループのユーザと共有するための共有ルールを表します。これは、OwnerSharingRule メタデータ型を拡張し、その fullName 項目、sharedFrom 項目、および sharedTo 項目を継承します。

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

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

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

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