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

拡張分析フォルダの共有設定を表します。レポートまたはダッシュボードを含むフォルダへの閲覧者、エディタまたはマネージャアクセス権を他のユーザに付与することにより、レポートまたはダッシュボードへのアクセスを制御できます。

ファイルのサフィックスおよびディレクトリの場所

FolderShare オブジェクトは、reports ディレクトリと dashboards ディレクトリに保存されます。ディレクトリに含まれるレポートフォルダまたはダッシュボードフォルダごとに、FolderName-meta.xml という名前のメタデータファイルがあります。FolderName-meta.xml メタデータファイルには、accessLevel など、そのフォルダのメタデータ情報が含まれます。たとえば、reports ディレクトリに myReportsFolder というレポートフォルダがある場合、myReportsFolder と同じレベルに myReportsFolder-meta.xml ファイルもあります。

バージョン

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

項目

項目名	項目の型	説明
accessLevel	FolderShareAccessLevel (string 型の列挙)	必須。フォルダで実行できるアクションの組み合わせを指定します。有効な値は、次のとおりです。 `View`。レポートの実行やダッシュボードの更新はできますが、それらを編集することはできません。すべてのユーザは、共有されているレポートフォルダまたはダッシュボードフォルダについて少なくとも閲覧者としてのアクセス権を持っています (ユーザによっては、より幅広いアクセスが可能なシステム管理者権限を持っている場合もあります)。 `EditAllContents`。ユーザは、フォルダ内のレポートまたはダッシュボードを表示および変更でき、同等のアクセス権を持つ他のフォルダとの間を移動させることもできます。 `Manage`。閲覧者とエディタに許可されたすべての操作を実行でき、フォルダへの他のユーザからのアクセスも制御できます。
sharedTo	string	必須。フォルダに対して指定されたアクセス権を持つユーザ、グループ、またはロールを指定します。
sharedToType	FolderSharedToType (string 型の列挙)	必須。フォルダを共有するエンティティの種別を指定します。有効な値は、次のとおりです。 `Group`。指定された公開グループに属するユーザに、フォルダに指定されたアクセス権が付与されます。 `Manager`。 API バージョン 29.0 以降で利用できます。 `ManagerAndSubordinatesInternal`。 API バージョン 29.0 以降で利用できます。 `Role`。指定されたロールを持つユーザに、フォルダに指定されたアクセス権が付与されます。 `RoleAndSubordinates`。指定されたロール持つユーザと、その下位ロールを持つユーザに、フォルダに指定されたアクセス権が付与されます。 `RoleAndSubordinatesInternal`。公開ポータルユーザである場合を除き、指定されたロール持つユーザと、その下位ロールを持つユーザに、フォルダに指定されたアクセス権が付与されます。 `Organization`。すべての内部ユーザに、フォルダに指定されたアクセス権が付与されます。 `Territory`。指定されたテリトリーに属するユーザに、フォルダに指定されたアクセス権が付与されます。 `TerritoryAndSubordinates`。指定されたテリトリーに属するユーザと、その下位テリトリーに属するユーザに、フォルダに指定されたアクセス権が付与されます。 `AllPrmUsers`。すべての PRM ポータルユーザに、フォルダに指定されたアクセス権が付与されます。 `User`。指定された個々のユーザに、フォルダに指定されたアクセス権が付与されます。 `PartnerUser`。パートナーポータルの指定された個々のユーザに、フォルダに指定されたアクセス権が付与されます。 `AllCspUsers`。すべてのカスタマーサクセスポータルユーザに、フォルダに指定されたアクセス権が付与されます。 `CustomerPortalUser`。カスタマーポータルの指定された個々のユーザに、フォルダに指定されたアクセス権が付与されます。 `PortalRole`。指定されたロールを持つポータルユーザに、フォルダに指定されたアクセス権が付与されます。 `PortalRoleAndSubordinates`。指定されたロール持つポータルユーザと、その下位ロールを持つポータルユーザに、フォルダに指定されたアクセス権が付与されます。

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

次に、ダッシュボードフォルダの FolderShare コンポーネントの例を示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<DashboardFolder xmlns="http://soap.sforce.com/2006/04/metadata">
3  <folderShares>
4        <accessLevel>View</accessLevel>
5        <sharedTo>R1</sharedTo>
6        <sharedToType>Role</sharedToType>
7    </folderShares>
8</DashboardFolder>

次に、レポートフォルダの FolderShare コンポーネントの例を示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<ReportFolder xmlns="http://soap.sforce.com/2006/04/metadata">
3  <folderShares>
4       <accessLevel>View</accessLevel>
5        <sharedTo>R1</sharedTo>
6        <sharedToType>Role</sharedToType>
7    </folderShares>
8</ReportFolder>

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

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