メタデータ API 開発者ガイド
jContentAsset
アセットファイルを作成するためのメタデータを表します。アセットファイルにより、Salesforce ファイルを組織の設定および定義のために使用できるようになります。MetadataWithContent メタデータ型を拡張し、その content 項目と fullName 項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
ContentAsset コンポーネントのサフィックスは .asset で、contentassets フォルダに保存されます。
バージョン
ContentAsset コンポーネントは、API バージョン 38.0 以降で使用できます。
特別なアクセスルール
アセットファイルの内容の合計サイズが 30 MB を超える場合、メタデータは取得されません。アセットファイルには、パッケージ化に関する既存のすべての制限が適用されます。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| format | ContentAssetFormat (string 型の列挙) | アセットファイルの形式を表します。有効な値は、次のとおりです。
|
| isVisibleByExternalUsers | boolean | 認証されていないユーザがアセットファイルを表示できるか (true)、否か (false) を示します。指定されていない場合、デフォルト値は false です。この項目は、API バージョン 44.0 以降で使用できます。 |
| language | string | 必須。アセットファイルの表示ラベルの言語。 |
| masterLabel | string | 必須。[設定] に表示されるアセットファイルレコードの表示ラベル。 |
| originNetwork | string | リリースの場合、作成時にファイルが割り当てられる Experience Cloud サイトの名前。取得の場合、ファイルの割り当て先の Experience Cloud サイトの名前が項目値に表示されます。null の場合、ファイルは Experience Cloud サイトに割り当てられていません。 |
| relationships | ContentAssetRelationships | アセットファイルを組織で共有可能かどうかを表す ContentAssetLinks のリスト。 |
| versions | ContentAssetVersions | 必須。アセットメタデータに含まれるファイルバージョンに関する基本情報を取得します。通常、ファイルには 1 つのバージョンのみが含まれます。 |
ContentAssetRelationships
アセットファイルと、アセットファイルがリンクされている場所間のリレーションを表します。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| emailTemplate | ContentAssetLink[] | コンテンツアセットが関連付けられているメールテンプレートの配列。この項目は、API バージョン 51.0 以降で使用できます。 |
| insightsApplication | ContentAssetLink[] | コンテンツアセットを使用するインサイトアプリケーションの配列。この項目は、API バージョン 39.0 以降で使用できます。 |
| Network | ContentAssetLink[] | コンテンツアセットを使用するネットワークの配列。この項目は、API バージョン 39.0 以降で使用できます。 |
| organization | ContentAssetLink | 組織とのアセットファイルの共有に関する情報が格納されます。ContentDocumentLink に対応付けられます。この項目は、API バージョン 39.0 以降で使用できます。 |
| workspace | ContentAssetLink[] | コンテンツアセットを所有または共有するワークスペースとライブラリの配列。この項目は、API バージョン 39.0 以降で使用できます。 |
ContentAssetLink
アセットファイルのリレーションリンクを表し、リンクのアクセスレベルに関する詳細が含まれます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| access | ContentAssetAccess (string 型の列挙) | 必須。共有ファイルのユーザに付与される権限で、ユーザがすでに持っている権限によって決まります。有効な値は、次のとおりです。
|
| isManagingWorkspace | boolean | コンテンツアセットがワークスペース内に存在するかどうかを示します。true の場合、コンテンツアセットはワークスペース内に存在します。指定されていない場合、デフォルト値は false です。この項目は、API バージョン 39.0 以降で使用できます。 |
| name | string | 将来の使用のために予約されています。 |
ContentAssetVersions
アセットメタデータに含まれるすべてのファイルバージョンに関する情報を表します。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| version | ContentAssetVersion[] | アセットのファイルバージョンのリスト。 |
ContentAssetVersion
アセットメタデータに含まれる 1 つのファイルバージョンに関する情報を表します。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| number | string | 必須。バージョン番号。この項目は ContentVersion に基づいていたり、この項目で ContentVersion を設定したりします。 |
| pathOnClient | string | 必須。元のファイル名を表します。この項目は、ContentVersion.PathOnClient に対応付けられます。また、ContentVersion のタイトル項目のデータを提供します。 |
| zipEntry | string | アセットファイルに複数のバージョンがある場合、format は ZippedVersions になります。この場合、zipEntry は zip 内のファイルの名前です。アセットファイルに 1 つのバージョンのみがある場合、この項目は空になります。 |
宣言的なメタデータの定義のサンプル
ContentAsset コンポーネントの例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<ContentAsset xmlns="http://soap.sforce.com/2006/04/metadata">
3 <masterLabel>some asset</masterLabel>
4 <relationships>
5 <organization>
6 <access>VIEWER</access>
7 </organization>
8 </relationships>
9 <versions>
10 <version>
11 <number>1</number>
12 <pathOnClient>some asset.txt</pathOnClient>
13 </version>
14 </versions>
15</ContentAsset>1 つのバージョンのみが含まれるアセットの場合、format 項目は省略されたり、Original として値が指定されたりします。複数のバージョンが含まれるファイルアセットの場合、zip ファイルでバージョンがラップされます。
前の定義を参照する package.xml の例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>MyAsset</members>
5 <name>ContentAsset</name>
6 </types>
7 <version>57.0</version>
8</Package>マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。