メタデータ API 開発者ガイド
jFlexiPage
- Salesforce モバイルアプリケーションでは、Lightning ページはナビゲーションメニューに表示されるアプリケーションのホームページです。
- Lightning Experience では、Lightning ページを次の目的で使用できます。
- レコードページ、Salesforce ホームページ、Outlook および Gmail インテグレーションのメールアプリケーションペインのレイアウトをカスタマイズする。
- アプリケーションのホームページとして。
- Lightning アプリケーションのユーティリティバーとして。
Lightning ページについての詳細は、Salesforce ヘルプを参照してください。
ファイルのサフィックスおよびディレクトリの場所
FlexiPage コンポーネントのサフィックスは .flexipage で、flexipages フォルダに保存されます。
バージョン
FlexiPage コンポーネントは、API バージョン 29.0 以降で使用できます。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| description | string | Lightning ページの説明テキスト (省略可能)。 |
| events | FlexiPageEvent[] | Lightning ページに関連付けられているイベントのリスト。 この項目は、API バージョン 53.0 以降で使用できます。 |
| flexiPageRegions | FlexiPageRegion[] | ページの領域のリスト。 |
| masterLabel | string | 必須。[設定] に表示される Lightning ページの表示ラベル。 |
| pageTemplate | string | 非推奨。この項目は API バージョン 33.0 から 38.0 でのみ使用してください。それ以降のバージョンでは、template を使用してください。 |
| parentFlexiPage | string | このページが動作を継承する元となる Lightning ページの名前。 この項目は、API バージョン 37.0 以降で使用できます。 |
| platformActionlist | PlatformActionList | Lightning アプリケーションページに表示されるすべてのアクションとその順序のリスト。Salesforce モバイルアプリケーションの場合、アクションはアクションバーに表示されます。 この項目は、API バージョン 34.0 以降で使用できます。 |
| quickActionList | QuickActionList | Lightning ページに関連付けられたクイックアクションのリスト。 |
| sobjectType | string |
Lightning ページが関連付けられているオブジェクト。種別が AppPage または HomePage の Lightning ページでは、この項目は null です。 この項目の値を設定すると、変更はできません。 この項目は、API バージョン 37.0 以降で使用できます。 |
| template | FlexiPageTemplateInstance |
必須。Lightning ページに関連付けられているテンプレート。 この項目は、API バージョン 39.0 以降で使用できます。 |
| type | FlexiPageType (string 型の列挙) |
必須。ページの種別。API バージョン 32.0 ～ 36.0 では、この項目には値 AppPage しか設定できません。 有効な値は、次のとおりです。
この項目は、API バージョン 32.0 以降で使用できます。 |
FlexiPageEvent
Lightning ページに関連付けられているイベント。API バージョン 53.0 以降で利用できます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| sourceName | string | 必須。イベント取得元項目の名前。取得元がカスタム Lightning Web コンポーネントである場合、この項目は、そのコンポーネントの名前です。 API 53.0 の場合、取得元として設定できるのは、Lightning Web コンポーネントのみです。 |
| sourceProperties | FlexiPageEventSourceProperty[] | イベント取得元に関連付けられているプロパティのリスト。 |
| sourceType | FlexipageEventSourceTypeEnum (string 型の列挙) | 必須。イベント取得元として割り当てられた項目の種別。 API バージョン 53.0 では、この項目には値 Component しか設定できません。 |
| targets | FlexiPageEventTarget[] | イベント取得元に関連付けられている取得先のリスト。 |
FlexiPageEventSourceProperty
イベントに関連付けられているプロパティ。API バージョン 53.0 以降で利用できます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| name | string | 必須。API バージョン 53.0 以降、この項目の値として設定できるのは、eventName のみです。 |
| value | string | 必須。name 項目の値が eventName の場合、この項目はイベントの名前です。 イベント取得元が Lightning Web コンポーネントである場合、この値は、取得元コンポーネントの js-meta.xml ファイルに定義されているイベント名と同じにする必要があります。 |
FlexiPageEventTarget
Lightning ページのイベント取得元に関連付けられている取得先。API バージョン 53.0 以降で利用できます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| mappings | FlexiPageEventPropertyMapping[] | イベントの取得元と取得先をバインドするためのキーと値のペアのリスト。 |
| method | string | 必須。 有効な値は updateProperties のみです。 |
| name | string | 必須。イベント取得先の名前。 有効な値は、次のとおりです。
|
| properties | FlexiPageEventTargetProperty[] | イベント取得先のプロパティのリスト。 |
| type | FlexiPageEventTargetTypeEnum (string 型の列挙) | 必須。イベント取得先として割り当てられた項目の種別。 有効な値は、次のとおりです。
|
FlexiPageEventPropertyMapping
イベントの取得元と取得先をバインドするためのキーと値のペア。API バージョン 53.0 以降で利用できます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| name | string | 必須。イベントがトリガされたときに変化する取得先プロパティの名前。 |
| value | string | イベントが発生したときの取得先プロパティの値。 文字列型、整数型、ブール型のプロパティでは、式を使用してその値を定義できます。有効な式の形式は、{!Event.eventPropertyName} です。イベントは、インタラクションの式でサポートされる唯一のコンテキストです。 |
FlexiPageEventTargetProperty
キーと値のペアとして表現されるイベント取得元の取得先のプロパティ。API バージョン 53.0 以降で利用できます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| name | string | 必須。API バージョン 53.0 以降、この項目の値として設定できるのは、componentIdentifier のみです。 |
| value | string | 必須。コンポーネントの ComponentInstance identifier 値。 |
FlexiPageRegion
FlexiPageRegion は、ページ領域のプロパティを表します。範囲には、エンティティセットを範囲とすることができる、レコードリストコンポーネントまたは最近使ったデータコンポーネントを含めることができます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| appendable | RegionFlagStatus (string 型の列挙) | この値はデジタルエクスペリエンスにおいて API バージョン 45.0 以降で使用できますが、他のすべての領域では将来の使用のために予約されています。 有効な値は、次のとおりです。
この項目は、replaceable および prependable と組み合わせて評価されます。
この項目は、API バージョン 35.0 以降で使用できます。 |
| componentInstances | ComponentInstance[] |
コンポーネントインスタンスのプロパティと名前。 この項目は API バージョン 49.0 で削除されました。API バージョン 49.0 以降では、itemInstances 項目を使用してください。 |
| itemInstances | ItemInstance[] | コンポーネントと項目を格納できる項目のインスタンスの配列。 この項目は、API バージョン 49.0 以降で使用できます。 |
| mode | FlexiPageRegionMode (string 型の列挙) | この項目は、将来の使用のために予約されています。 有効な値は、次のとおりです。
この項目は、API バージョン 35.0 以降で使用できます。 |
| name | string | 必須。FlexiPage 範囲の一意の名前。 |
| prependable | RegionFlagStatus (string 型の列挙) | この値はデジタルエクスペリエンスにおいて API バージョン 45.0 以降で使用できますが、他のすべての領域では将来の使用のために予約されています。 有効な値は、次のとおりです。
この項目は、appendable および replaceable と組み合わせて評価されます。
この項目は、API バージョン 35.0 以降で使用できます。 |
| replaceable | RegionFlagStatus (string 型の列挙) | この値はデジタルエクスペリエンスにおいて API バージョン 45.0 以降で使用できますが、他のすべての領域では将来の使用のために予約されています。 有効な値は、次のとおりです。
この項目は、appendable および prependable と組み合わせて評価されます。
この項目は、API バージョン 35.0 以降で使用できます。 |
| type | FlexiPageRegionType (string 型の列挙) | 必須。FlexiPage 範囲の種別。 有効な値は、次のとおりです。
この項目は、API バージョン 35.0 以降で使用できます。 |
ItemInstance
Lightning ページ上のコンポーネントまたは項目のインスタンス。API バージョン 49.0 以降で使用できます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| componentInstance | ComponentInstance | コンポーネントインスタンスのプロパティと名前。 |
| fieldInstance | FieldInstance | 組織で動的フォームが有効になっている場合の項目コンポーネントの API 名、表示ラベル、表示ルール情報。 |
ComponentInstance
フィルタリストなど、ページ内のコンポーネントのインスタンス。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| componentInstanceProperties | ComponentInstanceProperty[] | コンポーネントインスタンスの単一プロパティの値。 |
| componentName | string | 必須。コンポーネントの単一インスタンスの名前。 |
| identifier | string | 必須。ComponentInstance の一意の名前。Lightning ページのコンポーネントの個々のインスタンスを一意に識別できます。この項目は、最大 120 文字に制限されています。 この項目は、API バージョン 53.0 以降で使用できます。 |
| visibilityRule | UiFormulaRule |
コンポーネントをページ上に表示する条件を定義する 1 つ以上の条件のセット。 ルールが true と評価されると、コンポーネントがページに表示されます。false の場合は表示されません。この項目が null の場合、デフォルトではコンポーネントが表示されます。 この項目は、API バージョン 41.0 以降で使用できます。 |
ComponentInstanceProperty
コンポーネントインスタンスの単一プロパティの値。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| name | string | コンポーネントインスタンス内で一意のプロパティ名。Lightning コンポーネントでは、この値は .cmp ファイルで定義される <aura:attribute> です。 |
| type | ComponentInstancePropertyTypeEnum (string 型の列挙) |
この項目値が null の場合、ComponentInstanceProperty の値が Lightning コンポーネントに適用されます。この項目値が decorator の場合、ComponentInstanceProperty の値が Lightning コンポーネントのコンポーネントデコレータに適用されます。 コンポーネントデコレータは、Lightning コンポーネントを囲むラッパーです。このデコレータでは、Lightning Experience に特定のページを表示するときに、他の機能をコンポーネントに適用できます。たとえば、Lightning Experience ユーティリティバー上のコンポーネントを囲むコンポーネントデコレータを設定して、開いたときのコンポーネントの高さや幅を設定できます。UtilityBar は、コンポーネントデコレータをサポートする唯一のページ種別です。 この項目は、API バージョン 38.0 以降で使用できます。 |
| value | string | プロパティの参照または値。 [関連リスト] コンポーネントを定義する場合、親レコードを使用するには、parentFieldApiName 値を object.field_name に設定します。親レコードを使用しない場合は、値を object.Id に設定します。 |
| valueList | ComponentInstancePropertyList | コンポーネントインスタンスの値の配列。API バージョン 49.0 以降で利用できます。 |
- Standard.Tab.activity
- Standard.Tab.collaborate
- Standard.Tab.detail
- Standard.Tab.feed
- Standard.Tab.preview
- Standard.Tab.relatedLists
ComponentInstancePropertyList
コンポーネントインスタンスの配列内の要素の値。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| valueListItems | ComponentInstancePropertyListItem[] | コンポーネントインスタンスの要素の配列。 |
ComponentInstancePropertyListItem
コンポーネントインスタンスの配列内の要素の名前。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| value | string | コンポーネントインスタンスの配列内の要素の名前。 |
API バージョン 49.0 以降の場合、FlexiPage の配列は valueList として表されます。各配列要素は valueListItem で表し、要素名は value で表します。
UiFormulaRule
コンポーネントを Lightning ページ上に表示する条件を定義する 1 つ以上の条件のセット。たとえば、[金額] が $1,000,000 よりも大きいとき、商談ページにリッチテキストコンポーネントを表示する条件を作成できます。API バージョン 41.0 以降で利用できます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| booleanFilter | string | 高度な検索条件を指定します (1 AND 2 など)。 |
| criteria | UiFormulaCriterion[] | 評価時にコンポーネントの表示を決定する 1 つ以上の条件のリスト。 |
UiFormulaCriterion
評価時に Lightning ページのコンポーネントの表示を定義する 1 つの条件。API バージョン 41.0 以降で利用できます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| leftValue | string | 必須。条件のベースとなる項目。たとえば、AMOUNT のようになります。 |
| operator | string | 必須。データを絞り込むために使用される演算子を定義します。有効な値は、次のとおりです。
|
| rightValue | string | コンポーネントの表示を評価する値。たとえば、1000000 です。 |
- {!$Client.FormFactor} — ページを表示するデバイスに基づいてコンポーネントの表示を制御するには、この式を使用します。有効な値は Small (電話)、Medium (タブレット)、Large (Lightning Experience デスクトップ) です。新しい Salesforce モバイルアプリケーションが有効になっている組織でのみ、この値をレコードページに対して Small に設定できます。この式は API バージョン 41.0 以降のアプリケーションページと API バージョン 47.0 以降のレコードページでサポートされます。
- {!$Permission.CustomPermission.permissionName} — Lightning ページを参照しているユーザのカスタム権限に基づいてコンポーネントの表示を制御するには、この式を使用します。アプリケーション、ホーム、およびレコードページでのみサポートされます。
- {!$Permission.StandardPermission.permissionName} — Lightning ページを参照しているユーザの標準権限に基づいてコンポーネントの表示を制御するには、この式を使用します。アプリケーション、ホーム、およびレコードページでのみサポートされます。
- {!Record.field} — レコードページでのみサポートされます。
- {!$User.field} — アプリケーション、ホーム、およびレコードページでのみサポートされます。
たとえば、電話に表示する場合にのみコンポーネントを表示するには、条件 {!$Client.FormFactor} EQUAL "SMALL" を追加します。また、システム管理者にのみコンポーネントを表示するには、{!$User.Profile.Name} EQUAL "System Administrator" を使用します。
コンポーネントの表示ルール内の式は 5 個の項目までまたがることができます。たとえば、{!Record.Account.Owner.Manager.Manager.Manager.LastName} は、6 個の項目にまたがっているためサポートされません。
FieldInstance
Lightning ページに存在する単一の項目コンポーネントを表します。API バージョン 49.0 以降で利用できます。このサブタイプは、動的フォームが有効になっている組織でのみ表示できます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| fieldInstanceProperties | FieldInstanceProperty[] | 項目インスタンスのプロパティ。項目に関連付けられている各プロパティの名前と値のペアが含まれます。 |
| fieldItem | string | コンテキストのプレフィックスが付けられた項目の API 名。たとえば、レコードの項目は Record. の接頭辞が付けられます。 |
| identifier | string | 必須。FieldInstance の一意の名前。動的フォーム対応 Lightning ページの項目の個々のインスタンスを一意に識別できます。この項目は、最大 120 文字に制限されています。 この項目は、API バージョン 53.0 以降で使用できます。 |
| visibilityRule | UiFormulaRule | コンポーネントをページ上に表示する条件を定義する 1 つ以上の条件のセット。ルールが true と評価されると、コンポーネントがページに表示されます。false の場合は表示されません。この項目が null の場合、デフォルトではコンポーネントが表示されます。 |
FieldInstanceProperty
項目インスタンスの単一プロパティを表します。API バージョン 49.0 以降で利用できます。このサブタイプは、動的フォームが有効になっている組織でのみ表示できます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| name | string | 項目インスタンス内で一意のプロパティ名。 API バージョン 49.0 では、この項目の有効な値は uiBehavior のみです。 |
| value | string | プロパティの参照または値。 API バージョン 49.0 でのこの項目の有効な値は次のとおりです。
|
FlexiPageTemplateInstance
FlexiPageTemplateInstance は Lightning ページテンプレートのインスタンスを表します。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| name | string | 必須。テンプレートの単一インスタンスの名前。 |
| properties | ComponentInstanceProperty[] |
テンプレートインスタンスの単一プロパティの値。 CommThemeLayoutPage でのみ有効。ページテンプレートに関連付けられている各テーマレイアウトプロパティの名前と値のペアが含まれます。エクスペリエンスビルダーでは、テーマレイアウトとそのプロパティは [テーマ] 領域に表示されます。 |
PlatformActionList
Lightning アプリケーションページに表示されるアクションとその順序のリストを表す PlatformActionList。API バージョン 34.0 以降で利用できます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| actionListContext | PlatformActionListContext (string 型の列挙) | 必須。アクションリストのコンテキスト。有効な値は、次のとおりです。
|
| platformActionListItems | PlatformActionListItem[] | PlatformActionList のアクション。 |
| relatedSourceEntity | string | ActionListContext が RelatedList または RelatedListRecord の場合、この項目はアクションが属する関連リストの API 名を表します。 |
PlatformActionListItem
PlatformActionListItem は PlatformActionList のアクションを表します。API バージョン 34.0 以降で利用できます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| actionName | string | 必須。リストのアクションの API 参照名。 |
| actionType | PlatformActionType (string 型の列挙) | 必須。アクションの種別。有効な値は、次のとおりです。
|
| sortOrder | int | 必須。リスト内のアクションの位置。 |
| subtype | string | アクションのサブタイプ。クイックアクションの場合、サブタイプは QuickActionType になります。カスタムボタンの場合、サブタイプは WebLinkTypeEnum になります。アクションリンクの場合、サブタイプは Api、ApiAsync、Download、Ui になります。標準ボタンおよび生産性アクションには、サブタイプはありません。 |
宣言的なメタデータの定義のサンプル
FlexiPage コンポーネント定義を参照するサンプルの package.xml ファイルを次に示します。
マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。