ExperienceBundle

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

ExperienceBundle コンポーネントのサフィックスは .json で、取得時に experiences フォルダに保存されます。各コミュニティには、独自のフォルダがあります。これらのフォルダにはそれぞれ、サポートしているプロパティ用の別フォルダが含まれています。

ExperienceBundle には、experiences フォルダに 1 つ以上のコミュニティ定義を含めることができます。各コミュニティ定義には、brandingSets、config、routes、themes、variations、views ��リソースフォルダがあり、それぞれのフォルダに JSON ファイルで関連する追加の設定情報が保存されています。次に、リソースフォルダを表示する、コミュニティ定義の例を示します。

バージョン

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

特別なアクセスルール

Lightning コミュニティで ExperienceBundle メタデータ型を使用するには、[設定] から、[クイック検索] ボックスに「コミュニティ設定」と入力し、[コミュニティ設定] を選択します。[ExperienceBundle メタデータ API を有効化] を選択して、変更を保存します。

項目

項目名	項目の型	説明
experienceResources	ExperienceResources[]	この ExperienceBundle のリソースのリスト。各リソースは、brandingSets、config、routes、themes、variations、views などのコミュニティのアイテムを表します。
label	string	必須。ExperienceBundle の名前を表します。
type	SiteType (string 型の列挙)	必須。サイトの種別を識別します。`ChatterNetworkPicasso` の値を使用する Lightning コミュニティのみがサポートされます。

ExperienceResources

バンドル内のコミュニティのリストを表します。

項目名	項目の型	説明
experienceResource	ExperienceResource[]	この ExperienceBundle のリソースのリスト。各リソースは、brandingSets、config、routes、themes、views などのコミュニティのプロパティを表します。

ExperienceResource

ExperienceBundle に含まれる特定のコミュニティ情報を表します。

構造内には、種別ごとにフォルダがあります。各フォルダには、その種別とサイトに関する情報を提供する 1 つ以上のファイルが含まれています。それぞれが ExperienceBundle の特定のフォルダとファイルに対応しています。

項目名	項目の型	説明
fileName	string	必須。リソースファイルの名前。
format	string	必須。`JSON` のみが使用可能です。
source	base64	各ファイルの `JSON` コンテンツ。
type	string	必須。リソースの種別。有効な値は、次のとおりです。 `brandingSets` `config` `routes` `themes` `views`

フォルダおよびバンドルの定義

各 ExperienceBundle には、JSON ファイルに含まれるフォルダと関連データがあります。

brandingSets フォルダ

このフォルダには、ブランドセットごとに brandingSets_name.json という名前の 1 つの JSON ファイルが含まれています。各ファイルは同一の構造で、同じプロパティを持ちます。

<brandingSets_name>.json

プロパティ	型	説明
definitionName	string	必須。テーマでブランドセットをグループ化するのに使用されるブランドセットの名前を表します。「`テーマ`:branding-`テーマ`」のように定義します。たとえば、コミュニティのテーマが Stella の場合、definitionName は `stella:branding-stella` になります。さらに、いくつかの標準テンプレートには一意の名前が付けられています。カスタマー取引先ポータルは、`cpt:branding-cpt` を使用します。カスタマーサービスは `service:branding-service` を使用します。ヘルプセンターは `helpCenter:branding-helpCenter` を使用します。 Partner Central は `prm:branding-prm` を使用します。 Build Your Own は `starter:branding-starter` を使用します。 definitionName + label の組み合わせは組織内で一意である必要があります。メモ
id	UUID	コンポーネントの GUID を表します。
label	string	ブランドセットの名前を表します。 definitionName + label の組み合わせは組織内で一意である必要があります。メモ
type	string	コンポーネントの種類を表します。サポートされている値は、`brandingSet` のみです。
values	map	必須。コミュニティに適用可能なブランドの対応付けを表します。

config フォルダ

config フォルダには、いくつかの JSON ファイルがあります。

sitename.json
languages.json
page_name.json
サイト内の単一ページアプリケーションごとに 1 つ: loginAppPage.json および mainAppPage.json
メモ

sitename.json ファイルプロパティ

プロパティ	型	説明
forgotPasswordRouteId	UUID	ユーザがパスワードを忘れた場合に使用するルートの ID を表します。コミュニティの有効なテンプレートがログインをサポートしていない場合 (ヘルプセンターなど) は、サポートされません。メモ
isAvailableToGuests	boolean	公開ユーザにサイトへのアクセス権があるか (`true`)、否か (`false`) を示します。デフォルト値は `false` です。コミュニティの有効なテンプレートがログインをサポートしていない場合 (ヘルプセンターなど) は、サポートされません。メモ
isFilteredComponentsView	boolean	コンポーネントのリストが現在のページ種別に基づいて条件設定されているか (`true`)、否か (`false`) を示します。一部のコンポーネントは、ページの特定のパラメータを必要とし、そのパラメータを手動で設定しない限り機能しません。デフォルト値は `false` です。
isProgressiveRenderingEnabled	boolean	ページコンポーネントの表示順序が優先されるか (`true`)、否か (`false`) を示します。デフォルト値は `false` です。
loginAppPageId	UUID	ログインページの ID を表します。コミュニティの有効なテンプレートがログインをサポートしていない場合 (ヘルプセンターなど) は、サポートされません。メモ
mainAppPageId	UUID	必須。メインページの ID を表します。
preferredDomain	string	コミュニティのページにインデックスを付けるために使用するドメインの名前を表します。検索エンジンの結果を改善します。 API バージョン 48.0 以降で利用できます。
preferredDomainId	string	コミュニティのページにインデックスを付けるために使用するドメインを表します。検索エンジンの結果を改善します。 API バージョン 48.0 で削除されました。代わりに、preferredDomain を使用します。
selfRegistrationRouteId	UUID	セルフ登録に使用するログインルートの ID を表します。コミュニティの有効なテンプレートがログインをサポートしていない場合 (ヘルプセンターなど) は、サポートされません。メモ
type	string	コンポーネントの種類を表します。サポートされている値は、`site` のみです。

trustedSitesForScript コンテナ

実装すると、sitename.json に trustedSitesForScript コンテナが 1 つ作成されます。

プロパティ	型	説明
id	UUID	コンポーネントの GUID を表します。
isActive	boolean	許可リストに登録された項目が、有効 (`true`) であり優先する必要があるか、無効 (`false`) であり、許可リストに登録された取得元として処理する必要がないことを示します。デフォルトは `false` です。
trustedSiteName	string	UI に表示する、許可リストに登録された取得元の名前。
trustedSiteUrl	string	許可リストに登録された取得元の完全修飾 URL。
type	string	コンポーネントの種類を表します。サポートされている値は、`trustedSitesForScripts` のみです。

languages.json ファイルプロパティ

プロパティ	型	説明
defaultCode	string	必須。使用する基本言語コードと国コードを表します。
defaultLabel	string	必須。言語の表示ラベルを定義します。
id	UUID	コンポーネントの GUID を表します。
type	string	コンポーネントの種類を表します。サポートされている値は、`languageContainer` のみです。

サポートされる言語ごとに、languages.json のコンテナとして 1 つのセクションがあります

言語コンテナ

プロパティ	型	説明
countryCode	string	選択した言語の国コード。この文字列は空のままにできます。このプロパティは、選択した言語がアラビア語 (アルジェリア) やアラビア語 (バーレーン) のように国ごとに変異形がある場合にのみ適用されます。この場合は、`countryCode` を使用してそれらを区別します。例: `{ languageCode" : "ar", "CountryCode" : "DZ", "Label" : "Arabic (Algeria) (DZ)",}, { "Code" : "ar", "CountryCode" : "BH", "Label" : "Arabic (Bahrain) (BH)",}`
fallbackLanguageId	UUID	選択した言語に合った正しいコンテンツを追加するように注意してください。たとえば、コミュニティ訪問者が言語セレクタから日本語を選択したが、そのページに日本語のコンテンツがないとします。この場合、コンテンツが代替言語で表示されます。
id	UUID	コンポーネントの GUID を表します。
isActive	boolean	コミュニティ訪問者が、特定の言語を言語セレクタで使用できるか (`true`)、否か (`false`) を示します。デフォルト値は `true` です。
label	string	言語の表示ラベルを定義します。表示ラベルは、コミュニティに追加する言語セレクタコンポーネントとエクスペリエンスビルダーの言語セレクタに表示されます。
languageCode	string	選択した言語の国コードを表します。
type	string	コンポーネントの種類を表します。サポートされている値は、`language` のみです。

ページファイルは、コミュニティの単一ページアプリケーションを表します。ページごとに、page_name.json と命名された 1 つのファイルが存在します。

各 Lightning コミュニティは、実際には単一ページアプリケーションであり、1 つの HTML ページを読み込む Web アプリケーションです。単一ページアプリケーションは、複数のビューを使用して、ユーザが操作するたびにページを動的に更新します。

メモ

page_name.json ファイルプロパティ

プロパティ	型	説明
cmsSettings	map	CMS Connect ヘッダーおよびフッターの設定。有効な値は次のとおりです。 `headerName` `headerUrl` `headerPersonalization` `footerName` `footerUrl` `footerPersonalization` 設定を取得するには、取得元組織と取得先組織の両方で CMSConnect と CMSPersonalization の組織権限が有効になっている必要があります。
currentThemeId	UUID	必須。サイトの現在のテーマの UUID を表します。この項目は、mainAppPage.json と loginAppPage.json (該当する場合) で使用可能です。
headMarkup	string	必須。コミュニティのメインページの `<head>` タグにカスタムマークアップを追加することを許可します。[エクスペリエンスビルダー] \| [設定] \| [詳細] \| [ヘッドマークアップ] を使用した場合と同様です。Salesforce ヘルプのマークアップの説明を参照してください。
id	UUID	必須。コンポーネントの GUID を表します。
isRelaxedCSPLevel	boolean	スクリプトを実行する機能とサードパーティホストへのスクリプトアクセスを制御します。デフォルトは `false` です。この項目は、mainAppPage.json と loginAppPage.json (該当する場合) で使用可能です。
label	string	必須。ページの名前を表します。
templateName	string	必須。テンプレートページの一意の開発者名を表します。有効な値は、次のとおりです。ヘルプセンターカスタマー取引先ポータルコミュニティテンプレートカスタマーサービス Build Your Own Partner Central `Custom template` (テンプレートの作成で使用された名前)
type	string	必須。コンポーネントの種類を表します。サポートされている値は、`appPage` のみです。

routes フォルダ

routes フォルダには、ページごとに <page_name>.json という名前の 1 つの JSON ファイルが含まれています。

<page_name>.json

プロパティ	型	説明
activeViewId	UUID	必須。ルートのデフォルトビューを表します。定義された利用者がないか、ユーザが利用者に一致しない場合に使用されます。 API バージョン 48.0 以降で利用できます。
appPageId	UUID	必須。ルートの単一ページアプリケーション (SPA) ページを表します。これは、main.json または login.json のいずれかを参照します。
id	UUID	必須。コンポーネントの GUID を表します。コンポーネントから継承されます。
label	string	必須。ルートの名前を表します。コンポーネントから継承されます。
objectApiName	string	必須。カスタムオブジェクト API の名前。(標準オブジェクトでは使用できません)。
pageAccess	string	必須。ルートの状況が公開か非公開かを示します。デフォルト値の `UseParent` に設定した場合、サイトの状況によってルートの状況が決定します。常に非公開のルートはユーザインターフェースから編集できません。有効な値は、`UseParent`、`Public`、`RequiresLogin` です。
routeType	string	必須。ルートの種別を識別します。値は、同じ SPA ページを共有するすべてのルートの間で一意です。viewType の値が一致する必要があります。
type	string	必須。コンポーネントの種類を表します。サポートされている値は、`route` のみです。
urlPrefix	string	必須。ルートのベース URL を表します。

themes フォルダ

themes フォルダには、テーマごとに theme_name.json という名前の 1 つの JSON ファイルが含まれています。

theme_name.json

プロパティ	型	説明
activeBrandingSetId	UUID	現在の使用中のブランドセットの ID。ブランディングセットの `definitionName` は、テーマの `brandingSetReference` と一致する必要があります。
customCSS	string	Lightning コミュニティテンプレートから作成したページのカスタム CSS。
developerName	string	必須。テーマの一意の開発者名。ほとんどのテーマは自身の名前を直接派生させます。たとえば、Jepson はその developerName に `jespon` を使用します。標準テンプレートには次の固有の値応答画面があります。 `cpt`: カスタマー取引先ポータル `service`: カスタマーサービス `helpCenter`: ヘルプセンター `prm`: Partner Central `starter`: Build Your Own
id	UUID	必須。コンポーネントの GUID を表します。
label	string	テーマの名前を表します。
layouts	map	必須。`ThemeLayoutType` を UUID に対応付け、ThemeLayout の定義を含みます。Login と Inner テーマレイアウトが常に必須です。
type	string	必須。コンポーネントの種類を表します。サポートされている値は、`theme` のみです。

ビューはテーマの子にすることができます。それらの子のビューは、views フォルダのビューと同じように構造化できます。

メモ

variations フォルダ

環境のバリエーションを使用すると、利用者に基づいて Lightning コミュニティのデフォルトの動作を変更できます。variations フォルダには、環境のバリエーションごとに 1 つの JSON ファイルが含まれています。このファイルは、experienceVariation_name.json と命名されます。

環境のバリエーションは、API バージョン 47.0 以降で使用できます。
コミュニティを複数回リリ��スするときの問題を回避するために、JSON ファイルの名前は、バリエーションの developerName に一致する必要があります。

メモ

ブランドセット、ページバリエーション、コンポーネントの表示、およびコンポーネント属性の 4 つの異なるバリエーションの種別がサポートされます。異なるバリエーションは、componentVariant コンテナによって示されます。

たとえば、ユーザが特定の利用者条件を満たしたときに、コミュニティにホームページのページバリエーションを表示できます。これを実現するには、利用者を作成した後、環境のバリエーション定義ファイルの componentVariant コンテナの targetId を使用してその利用者を環境のバリエーションの対象にします。

experienceVariation_name.json

プロパティ	型	説明
componentVariants	list	必須。この環境のバリエーションに属するコンポーネントのバリエーションのリスト。環境のバリエーションごとに 1 つのコンポーネントのバリエーションのみが許可されます。メモ
developerName	string	必須。環境のバリエーションの一意の開発者名。この名前は Personalization API の対象の `targetValue` 項目で使用され、設定後は更新できません。詳細は、「利用者」を参照してください。メモ
id	UUID	必須。コンポーネントの GUID を表します。
type	string	必須。コンポーネントの種別を表します。サポートされている値は、`experienceVariation` のみです。

実装すると、バリエーションを記述する experienceVariation_name.json ファイルにそれぞれコンテナが 1 つ作成されます。

componentVariant コンテナ

プロパティ	型	説明
id	UUID	必須。コンポーネントの GUID を表します。
propertyOverrides	map	必須。指定されたテーマ、ルート、またはコンポーネントの targetId へのプロパティの上書きを定義します。たとえば、targetId がテーマを指している場合、この環境のバリエーションで異なるブランドセットを使用するように、テーマの defaultBrandingSet プロパティを上書きできます。上書きがサポートされているプロパティは次のとおりです。 `activeBrandingSetId` targetId がテーマの場合に使用するブランドセットを定義します。次の形式を使用します。 `activeViewId` targetId がルートの場合に使用するページバリエーションを定義します。次の形式を使用します。 `componentAttributes` CMS コレクションコンポーネントおよびナビゲーションコンポーネント (ナビゲーションメニュー、タイルメニューなど) でのみサポートされます。コンポーネントはヘッダーおよびフッター領域のほか、ビューのボディにも配置できます。 targetId がナビゲーションコンポーネントの場合に表示するナビゲーションリンクセットを定義します。プロパティの値は、属性と属性値を示す 1 つのキー-値ペアを含む JSON コンテナです。サポートされる属性は `NavigationMenuEditorRefresh` のみです。次の形式を使用します。 targetId が CMS コレクションコンポーネントの場合に表示するコンテンツコレクションを定義します。プロパティの値は、属性と属性値へのパスを示す 1 つのキー-値ペアを含む JSON コンテナです。サポートされる属性は `config/dataProviderDefinition/attributes/dataProviderInfo/apiName` のみです。次の形式を使用します。 `isVisible` targetId がコンポーネントの場合に利用者にコンポーネントを表示するかどうかを定義します。ヘッダーまたはフッター領域のコンポーネントではサポートされません。次の形式を使用します。対応付けの 1 つのエントリのみが許可されます。コンポーネントの場合、表示または属性のいずれかを変更できますが、両方を同時に変更することはできません。メモ
targetId	UUID	必須。プロパティを上書きする項目の UUID。テーマ、ルートまたはコンポーネントの ID である必要があります。
type	string	必須。コンポーネントの種別を表します。サポートされている値は、`experienceVariation` のみです。

ブランドセットの環境のバリエーションの例

ページバリエーションの環境のバリエーションの例

コンポーネントの表示の環境のバリエーションの例

CMS コレクションコンポーネントのコンポーネントのバリエーションの例

ナビゲーションメニューコンポーネントのコンポーネントのバリエーションの例

views フォルダ

views フォルダには、いくつかの JSON ファイルがあり、それぞれがビューを定義しています。各 Lightning コミュニティは、単一ページアプリケーションで構成されています。それらは、単一の HTML ページを読み込む Web アプリケーションです。単一ページアプリケーションは、複数のビューで構成されており、それらのビューによりユーザが操作するたびにページが動的に更新されます。

ビューは領域で構成され、領域には他の領域や、ユーザのためにレンダリングされたページのコンポーネントが含まれています。views フォルダ内には、ビューごとに view_name.json という名前のファイルが 1 つあります。

コミュニティの単一ページアプリケーションは、config フォルダのページファイルで定義されます。

メモ

view_name.json

プロパティ	型	説明
appPageId	UUID	必須。ビューの単一ページアプリケーション (SPA) のページ ID。これは、main.json または login.json のいずれかを参照します。
componentName	string	必須。レイアウトコンポーネントの FQN。コンポーネントは、`forceCommunity:layout` を実装する必要があり、テーマレイアウトの場合は `forceCommunity:themeLayout` を実装する必要があります。
id	UUID	必須。コンポーネントの GUID を表します。
label	string	必須。[エクスペリエンスビルダー] \| [設定] \| [テーマ] \| [設定] に表示される名前。
themeLayoutType	string	ビューのテーマレイアウト種別 (ビューに対してのみ公開)。
type	string	必須。コンポーネントの種別を表します。サポートされている値は、`view` のみです。
viewType	string	必須。ルートの routeType に一致します。

各 <view_name>.json には、コンテナとして 1 つ以上の領域が含まれています。

region コンテナ

プロパティ	型	説明
id	UUID	必須。コンポーネントの GUID を表します。
regionLabel	string	タブの領域表示ラベルを指定します。このプロパティは、コンポーネントの子であるタブ領域にのみ存在します。メモ
regionName	string	必須。レイアウトコンポーネントのデザインファイルのデザイン属性と一致します。
type	string	必須。コンポーネントの種類を表します。サポートされている値は、`region` のみです。

各 <view_name>.json の region セクションには、コンテナとして 1 つ以上のコンポーネントが含まれています。

component コンテナ

プロパティ	型	説明
componentAttributes	HashMap	必須。コンポーネントのデザイン属性値。
componentName	string	必須。コンポーネントの FQN。この項目で使用できるのは、Experience Builder のコンポーネントパネルで使用できるコンポーネントのみです。
id	UUID	必須。コンポーネントの GUID を表します。コンポーネントの UUID はリリース時にシステムにより自動的に生成されるため、コンポーネントを ExperienceBundle に追加する場合は任意の値を入力できます。メモ
renderPriority	enums.priority	コンポーネントの順次表示の優先度の値を設定します。使用可能な値: `HIGHEST`、`HIGH`、`NEUTRAL` コミュニティの順次表示が [エクスペリエンスビルダー] \| [設定] \| [詳細] で有効になっている場合にのみ評価されます。メモ
renditionMap	HashMap	RenditionComponents の UUID への異なる変換キーの対応付け。
type	string	必須。コンポーネントの種類を表します。サポートされている値は、`component` のみです。

各 <view_name>.json には、コンポーネントごとに変換コンテナが 1 つ作成されます。

rendition コンテナ

プロパティ	型	説明
id	UUID	必須。コンポーネントの GUID を表します。
renditionValue	map	テキスト内の異なる言語など、コンポーネントの異なるバリエーションの対応付け。
type	string	必須。コンポーネントの種類を表します。サポートされている値は、`renditionComponent` のみです。

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

次に、ExperienceBundle 宣言の例を示します。個々のフォルダやバンドルされたコードのファイルの例については、brandingSets、config、routes、themes、variations、および views を参照してください。

使用方法

Lightning コミュニティの .json ファイルを更新する前に、バックアップとしてコミュニティのフォルダをコピーすることをお勧めします。

ヒント

コンポーネントの UUID はリリース時にシステムにより自動的に生成されるため、コンポーネントを ExperienceBundle に追加する場合は id に任意の値を入力できます。

ExperienceBundle を使用して Lightning コミュニティをリリースする場合、SiteDotCom 型がマニフェストファイルに含まれていないことを確認します。

ExperienceBundle では、異なる API バージョンでの取得およびリリースはサポートされません。ExperienceBundle メタデータを古い API バージョンから新しいバージョン (API バージョン 48.0 から 49.0 など) にアップグレードする場合は、次の手順を実行します。

package.xml マニフェストファイルの API バージョンを 48.0 に設定して、パッケージをリリースします。
次に、package.xml の API バージョンを 49.0 に設定します。
パッケージを取得して、ExperienceBundle の最新の更新を取得します。

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

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

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