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

Metadata メタデータ型を拡張し、その fullName 項目を継承します。

アイデアレイアウトを編集するには、package.xml ファイルでこのアイデアレイアウトを名前で指定します。package.xml では、次のコードを使用してアイデアレイアウトを取得します。

1<types>
2    <members>Idea-Idea Layout</members>
3    <name>Layout</name>
4</types>

メモ

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

レイアウトは、対応するパッケージディレクトリの layouts ディレクトリに保存されます。拡張子は .layout です。

プロジェクトでこのメタデータ型のコンポーネントを取得すると、同じパッケージで取得された Profile コンポーネントおよび PermissionSet コンポーネントにこのコンポーネントが表示されるようになります。

メモ

バージョン

レイアウトは、API バージョン 13.0 以降で使用できます。

項目

このメタデータ型は、ページレイアウトを定義する有効な値を表します。

項目名	データ型	説明
customButtons	string[]	このレイアウトのカスタムボタン。各ボタンは、同一オブジェクト上の WebLink への参照です。たとえば、ButtonLink は「ButtonLink」という名前の同一の標準オブジェクトまたはカスタムオブジェクトの Web リンクを参照します。
customConsoleComponents	CustomConsoleComponents	ページレイアウト上にあるカスタムコンソールコンポーネント (Visualforce ページ、参照項目、または関連リスト。Force.com Canvas アプリケーションは使用不可) を表します。カスタムコンソールコンポーネントは、Salesforce コンソールにのみ表示されます。
emailDefault	boolean	showEmailCheckbox が設定されている場合にのみ該当します。そのチェックボックスのデフォルト値を示します。
excludeButtons	string[]	このレイアウトから除外する標準ボタンのリスト。たとえば、`<excludeButtons>Delete</excludeButtons>` ではこのレイアウトから [削除] ボタンを除外します。
feedLayout	FeedLayout	フィードベースのページレイアウトのフィードビューを定義する値を表します。フィードベースのレイアウトは、取引先、ケース、取引先責任者、リード、商談、カスタム、および外部のブジェクトで使用できます。フィードビューと詳細ビューが含まれます。
headers	LayoutHeader[] (string 型の列挙)	レイアウトヘッダーは現在タギングのみに使用されており、タギングが有効になっている場合にのみ UI に表示されます。有効な string 値は次のとおりです。 `PersonalTagging` — タグはユーザには非公開です。 `PublicTagging` — レコードにアクセスできる他のすべてのユーザがタグを参照できます。
layoutSections	LayoutSection[]	項目、Sコントロール、およびカスタムリンクを含むレイアウトのメインセクション。ここでの順序はレイアウトの順序を決定します。
miniLayout	MiniLayout	ミニレイアウトは、[コンソール] タブ、詳細のフロート表示、行動のフロート表示でのレコードのミニビューで使用されます。
multilineLayoutFields	string[]	OpportunityProduct レイアウトで表示される特殊な複数行レイアウト項目の項目。その他の点では、これらの項目は、miniLayoutFields の miniLayout と似ています。
platformActionList	PlatformActionList	レイアウトの Salesforce アプリケーションアクションバーに表示されるアクションのリストとその順序。この項目は、API バージョン 34.0 以降で使用できます。
quickActionList	QuickActionList	ページレイアウトの Salesforce フルサイトに表示されるクイックアクションのリスト。この項目は、API バージョン 28.0 以降で使用できます。
relatedContent	RelatedContent	ページレイアウトの関連コンテンツセクション。この項目は、API バージョン 29.0 以降で使用できます。
relatedLists	RelatedListItem[]	レイアウトの関連リスト。ユーザインターフェースに表示される順序で表示されます。
relatedObjects	string[]	コンソールのミニビューに表示される関連オブジェクトのリスト。データベース用語では、これらのオブジェクトはレイアウトのオブジェクトの外部キー項目です。詳細は、Salesforce オンラインヘルプの「エージェントコンソールのミニビューの関連オブジェクトの選択」を参照してください。
runAssignmentRulesDefault	boolean	showRunAssignmentRulesCheckbox が設定されている場合にのみ該当します。そのチェックボックスのデフォルト値を示します。
showEmailCheckbox	boolean	ケース、CaseClose、および ToDo レイアウトでのみ使用可能。設定されている場合、メールを表示するためのチェックボックスが表示されます。
showHighlightsPanel	boolean	設定されている場合、強調表示パネルが Salesforce コンソールのページに表示されます。この項目は、API バージョン 22.0 以降で使用できます。
showInteractionLogPanel	boolean	設定されている場合、相互関係ログが Salesforce コンソールのページに表示されます。この項目は、API バージョン 22.0 以降で使用できます。
showKnowledgeComponent	boolean	ケースレイアウトでのみ使用可能。設定されている場合、ナレッジサイドバーが Salesforce コンソールのケースに表示されます。この項目は、API バージョン 20.0 以降で使用できます。
showRunAssignmentRulesCheckbox	boolean	リードオブジェクトおよび Case オブジェクトでのみ使用可能。設定されている場合、割り当てルールを表示するためのチェックボックスがページに表示されます。
showSolutionSection	boolean	CaseClose レイアウトでのみ使用可能。設定されている場合、組み込みのソリューション情報セクションがページに表示されます。
showSubmitAndAttachButton	boolean	ケースレイアウトでのみ使用可能。設定されている場合、[登録 & ファイルを添付] ボタンは、カスタムポータルのポータルユーザのケース編集ページに表示されます。

CustomConsoleComponents

ページレイアウト上にあるカスタムコンソールコンポーネント (Visualforce ページ、参照項目、または関連リスト。Force.com Canvas アプリケーションは使用不可) を表します。カスタムコンソールコンポーネントは、Salesforce コンソールにのみ表示されます。API バージョン 25.0 以降で使用できます。

項目名	データ型	説明
primaryTabComponents	PrimaryTabComponents	Salesforce コンソールの主タブにあるカスタムコンソールコンポーネントを表します。API バージョン 25.0 以降で使用できます。
subtabComponents	SubtabComponents	Salesforce コンソールのサブタブにあるカスタムコンソールコンポーネントを表します。API バージョン 25.0 以降で使用できます。

PrimaryTabComponents

Salesforce コンソールの主タブにあるカスタムコンソールコンポーネントを表します。API バージョン 25.0 以降で使用できます。

項目名	データ型	説明
component	ConsoleComponent[]	ページレイアウトのセクション上にあるカスタムコンソールコンポーネント (Visualforce ページ、参照項目、または関連リスト。Force.com Canvas アプリケーションは使用不可) を表します。カスタムコンソールコンポーネントは、Salesforce コンソールにのみ表示されます。この項目は、API バージョン 29.0 以前で使用できます。
containers	Container[]	Salesforce コンソールのサイドバー上に複数のカスタムコンソールコンポーネントを表示するための場所とスタイルを表します。4 つの場所 (左、右、上、および下) のそれぞれに最大 5 つのコンポーネントを指定できます。この項目は、API バージョン 30.0 以降で使用できます。

ConsoleComponent

ページレイアウトのセクション上にあるカスタムコンソールコンポーネント (Visualforce ページ、参照項目、または関連リスト。Force.com Canvas アプリケーションは使用不可) を表します。カスタムコンソールコンポーネントは、Salesforce コンソールにのみ表示されます。API バージョン 25.0 以降で使用できます。

項目名	データ型	説明
height	int	location が top または bottom のコンポーネントで必須です。カスタムコンソールコンポーネントの高さです。ピクセル単位で、0 より大きく 999 より小さい値に指定する必要があります。
location	string	必須。ページレイアウトのカスタムコンソールコンポーネントの位置。有効な値は、right、left、top、および bottom です。コンポーネントには、ページレイアウトあたり 1 つの location を指定できます。
visualforcePage	string	必須。カスタムコンソールコンポーネントの一意の名前。たとえば、ConsoleComponentPage です。
width	int	location が left または right のコンポーネントで必須です。カスタムコンソールコンポーネントの幅です。ピクセル単位で、0 より大きく 999 より小さい値に指定する必要があります。

Container

Salesforce コンソールのサイドバーに複数のカスタムコンソールコンポーネントを表示するための場所とスタイルを表します。たとえば、コンソールの右のサイドバーには、積み上げ、タブ、またはアコーディオンのスタイルで複数のコンポーネントを表示できます。API バージョン 30.0 以降で使用できます。

項目名	データ型	説明
height	int	location が top または bottom のコンポーネントで必須です。コンポーネントのコンテナの高さ。unit 項目は、単位 (ピクセルまたはパーセント) を決定します。
isContainerAutoSizeEnabled	boolean	必須。`true` に設定されると、サイドバーの積み上げコンソールコンポーネントの垂直方向のサイズが自動的に設定されます。新規作成されたコンソールコンポーネントの場合、デフォルトで `true` に設定されます。API バージョン 32.0 以降で使用できます。
region	string	必須。コンポーネントのコンテナの場所。使用できる値は次のとおりです。 `right` `left` `top` `bottom`
sidebarComponents	SidebarComponent[]	コンポーネントのコンテナに表示する特定のカスタムコンソールコンポーネントを表します。
style	string	必須。複数のコンポーネントを表示するコンテナのスタイル。使用できる値は次のとおりです。 `stack` — 複数のフレームを含むコンテンツ領域。 `tabs` — 複数のパネルのリストを含む単一コンテンツ領域。 `accordian` — 折りたたみ可能なコンテンツ領域。
unit	string	必須。コンポーネントのコンテナの高さまたは幅の単位 (ピクセルまたはパーセント)。ピクセル値は、ピクセル数 (`500` など) で、0 より大きく 999 より小さい値である必要があります。パーセント値は、パーセント記号を含み (`20%` など)、0 より大きく、100 より小さい値である必要があります。
width	int	location が right または left のコンポーネントで必須です。コンポーネントのコンテナの幅。unit 項目は、単位 (ピクセルまたはパーセント) を決定します。

SidebarComponent

Salesforce コンソールのサイドバーのいずれかでマルチコンポーネントをホストするコンテナに表示する特定のカスタムコンソールコンポーネントを表します。4 つのコンテナの場所 (左、右、上、および下) のそれぞれに最大 5 つのコンポーネントを指定できます。API バージョン 30.0 以降で使用できます。

項目名	データ型	説明
componentType	string	コンポーネントの種類を指定します。有効な値は、`KnowledgeOne`、`Lookup`、`Milestones`、`RelatedList`、`Topics`、`Files`、および `CaseExperts` です。この項目は、API バージョン 31.0 以降で使用できます。`Files` および `CaseExperts` 値は、API バージョン 32.0 以降で使用できます。ケースのエキスパートは、パイロットプログラムで使用可能です。メモ
createAction	string	コンポーネントが参照項目の場合、レコードの作成に使用されるクイックアクションの名前。この項目は、API バージョン 42.0 以降で使用できます。
enableLinking	boolean	コンポーネントが参照項目の場合、ユーザはレコードをこの項目に関連付けることができます。この項目は、API バージョン 42.0 以降で使用できます。
height	int	location が top または bottom のコンポーネントで必須です。コンテナ内のコンポーネントの高さ。unit 項目は、単位 (ピクセルまたはパーセント) を決定します。
label	string	コンソールユーザに表示されるコンポーネントの名前。スタイルがタブまたはアコーディオンのコンテナに含まれるコンポーネントに使用できます。
lookup	string	コンポーネントが参照項目の場合、項目の名前。
page	string	コンポーネントが Visualforce ページの場合は、Visualforce ページの名前。
relatedlists	RelatedList[]	コンポーネントが関連リストの場合、リストの名前。この項目は、API バージョン 31.0 以降で使用できます。
unit	string	コンテナ内のコンポーネントの高さまたは幅の単位 (ピクセルまたはパーセント)。ピクセル値は、ピクセル数 (`500` など) で、0 より大きく 999 より小さい値である必要があります。パーセント値は、パーセント記号を含み (`20%` など)、0 より大きく、100 より小さい値である必要があります。
updateAction	string	コンポーネントが参照項目の場合、レコードの更新に使用されるクイックアクションの名前。この項目は、API バージョン 42.0 以降で使用できます。
width	int	location が right または left のコンポーネントで必須です。コンテナ内のコンポーネントの幅。unit 項目は、単位 (ピクセルまたはパーセント) を決定します。

RelatedList

Salesforce コンソールのサイドバーにある関連リストのカスタムコンポーネントを表します。API バージョン 31.0 以降で使用できます。

項目名	データ型	説明
hideOnDetail	boolean	`true` に設定されている場合、コンポーネントとして表示される関連リストが詳細ページで非表示になり、重複する情報が表示されなくなります。
name	string	コンソールユーザに表示されるコンポーネントの名前。

SubtabComponents

Salesforce コンソールのサブタブにあるカスタムコンソールコンポーネントを表します。API バージョン 25.0 以降で使用できます。

項目名	データ型	説明
component	ConsoleComponent[]	ページレイアウトのセクション上にあるカスタムコンソールコンポーネント (Visualforce ページ、参照項目、または関連リスト。Force.com Canvas アプリケーションは使用不可) を表します。カスタムコンソールコンポーネントは、Salesforce コンソールにのみ表示されます。この項目は、API バージョン 29.0 以前で使用できます。
containers	Container[]	Salesforce コンソールのサイドバー上に複数のカスタムコンソールコンポーネントを表示するための場所とスタイルを表します。4 つの場所 (左、右、上、および下) のそれぞれに最大 5 つのコンポーネントを指定できます。この項目は、API バージョン 30.0 以降で使用できます。

FeedLayout

フィードベースのページレイアウトのフィードビューを定義する値を表します。フィードベースのレイアウトは、取引先、ケース、取引先責任者、リード、商談、カスタム、および外部のブジェクトで使用できます。フィードビューと詳細ビューが含まれます。API バージョン 30.0 以降で使用できます。

項目名	データ型	説明
autocollapsePublisher	boolean	ページの読み込み時にパブリッシャーを自動的に折りたたむか (`true`)、否か (`false`) を指定します。
compactFeed	boolean	フィードベースのページレイアウトでコンパクトフィードを使用するか (`true`)、否か (`false`) を指定します。`true` に設定した場合、ページのフィード項目はデフォルトで折りたたまれ、フィードビューには更新されたデザインが使用されます。
feedFilterPosition	FeedLayoutFilterPosition (string 型の列挙)	レイアウト内でフィード条件リストが含まれる場所。有効な値は、次のとおりです。 `centerDropDown` — 中央列にドロップダウンリストとして表示。 `leftFixed` — 左列に固定リストとして表示。 `leftFloat` — 左列にフロート表示リストとして表示。
feedFilters	FeedLayoutFilter[]	フィード条件リストに表示される個々の条件。
fullWidthFeed	boolean	フィードをページ上の使用可能な領域いっぱいまで横に展開するか (`true`)、否か (`false`) を指定します。
hideSidebar	boolean	サイドバーが非表示か (`true`)、否か (`false`) を示します。
leftComponents	FeedLayoutComponent[]	フィードビューの左列に表示される個々のコンポーネント。
rightComponents	FeedLayoutComponent[]	フィードビューの右列に表示される個々のコンポーネント。

FeedLayoutComponent

フィードベースのページレイアウトのフィードビュー内のコンポーネントを表します。API バージョン 30.0 以降で使用できます。

項目名	データ型	説明
componentType	FeedLayoutComponentType (string 型の列挙)	必須。コンポーネントの種類。有効な値は、次のとおりです。 `HelpAndToolLinks` — ページのヘルプトピック、ページレイアウト、およびページの印刷用表示にリンクするアイコン。ケースレイアウトでのみ使用できます。 `CustomButtons` — カスタムボタン。 `Following` — [フォロー] ボタン (レコードを表示しているユーザがまだレコードをフォローしていない場合) と [フォロー中] インジケータ (レコードを表示しているユーザがレコードをフォローしている場合) 間で切り替わるアイコン。 `Followers` — レコードをフォローしているユーザのリスト。 `CustomLinks` — カスタムリンク。 `Milestones` — マイルストントラッカー。これにより、ユーザはケースのマイルストンの状況を表示できます。ケースレイアウトでのみ使用できます。 `Topics` — レコードに関連するトピックのリスト。 `CaseUnifiedFiles` — ケースに添付されるすべてのファイルのリスト。 `Visualforce` — カスタム Visualforce コンポーネント。
height	int	コンポーネントの高さ (ピクセル単位)。`standardComponents` には適用されません。
page	string	カスタムコンポーネントとして使用されている Visualforce ページの名前。

FeedLayoutFilter

フィードベースのページレイアウトのフィードビュー内のフィード条件オプションを表します。1 つの条件には、standardFilter または feedItemType セットのみが含まれる必要があります。API バージョン 30.0 以降で使用できます。

項目名	データ型	説明
feedFilterName	string	CustomFeedFilter コンポーネントの名前。名前には、親オブジェクトの名前がプレフィックスとして付けられます。たとえば、`Case.MyCustomFeedFilter` のようになります。
feedFilterType	FeedLayoutFilterType (string 型の列挙)	条件の種別。有効な値は、次のとおりです。 `AllUpdates` — レコードに対するすべてのフィード項目を表示します。 `FeedItemType` — レコードに対する特定の種別の活動についてのみフィード項目を表示します。
feedItemType	FeedItemType (string 型の列挙)	表示するフィード項目の種別。有効な値は、次のとおりです。 `ActivityEvent` — ケースに関連付けられている ToDo と行動に対する活動に関連するフィード項目。ケースレイアウトでのみ使用できます。 `AdvancedTextPost` – フィードに投稿されたグループへのお知らせに関連するフィード項目。この値は API バージョン 31.0 以降で使用できます。 `AnnouncementPost` – 使用されません。 `ApprovalPost` — フィードに送信された承認に関連するフィード項目。 `AttachArticleEvent` — ケースへの記事の添付に関連する活動に関するフィード項目。ケースレイアウトでのみ使用できます。 `BasicTemplateFeedItem` — 使用されません。 `CallLogPost` — 「活動の記録」アクションからの活動に関するフィード項目。活動 (ToDo と行動) をサポートするオブジェクトのレイアウトでのみ使用できます。 `CanvasPost` — キャンバスアプリケーションによるフィードへの投稿に関するフィード項目。 `CaseCommentPost` — 「ケースメモ」アクションからの活動に関するフィード項目。ケースレイアウトでのみ使用できます。 `ChangeStatusPost` — 「状況の変更」アクションからの活動に関するフィード項目。ケースレイアウトでのみ使用できます。 `ChatTranscriptPost` — ケースへの Live Agent チャットトランスクリプトの添付に関連する活動に関するフィード項目。ケースレイアウトでのみ使用できます。 `CollaborationGroupCreated` — 公開グループの作成に関連するフィード項目。 `CollaborationGroupUnarchived` — 使用されません。 `ContentPost` — 投稿へのファイルの添付に関連するフィード項目。 `CreatedRecordEvent` — パブリッシャーからのレコードの作成に関連するフィード項目。 `DashboardComponentSnapshot` — フィードへのダッシュボードスナップショットの投稿に関連するフィード項目。 `EmailMessageEvent` — 「メール」アクションからの活動に関するフィード項目。ケースレイアウトでのみ使用できます。 `FacebookPost` — 使用されません。 `LinkPost` — 投稿への URL の添付に関連するフィード項目。 `MilestoneEvent` — ケースのマイルストンの状況への変更に関するフィード項目。ケースレイアウトでのみ使用できます。 `PollPost` — フィードへのアンケートの投稿に関連するフィード項目。 `ProfileSkillPost` — ユーザの Chatter プロファイルに追加されるスキルに関連するフィード項目。この値は API バージョン 31.0 以降で使用できます。 `QuestionPost` — フィードへの質問の投稿に関連するフィード項目。この値は API バージョン 31.0 以降で使用できます。 `ReplyPost` — 「ポータル」アクションからの活動に関するフィード項目。ケースレイアウトでのみ使用できます。 `RypplePost` — Work.com での感謝バッジの作成に関連するフィード項目。 `SocialPost` — 「ソーシャル投稿」アクションからの Twitter での活動に関するフィード項目。 `TextPost` — パブリッシャーからのテキスト投稿の作成に関するフィード項目。 `TrackedChange` — 追跡対象の項目に対する単一の変更、または変更の集合に関連するフィード項目。 `UserStatus` — 使用されません。

MiniLayout

[コンソール] タブ、詳細のフロート表示、および行動のフロート表示でのレコードのミニビューを表します。

項目名	データ型	説明
fields	string[]	ミニレイアウトの項目。UI に表示する順序で表示されます。ここに表示される項目はメインレイアウトに表示されます。
relatedLists	RelatedListItem[]	ミニ関連リスト。UI に表示される順序で表示されます。ミニ関連リストでの並び替えは設定できません。ここに表示される項目はメインレイアウトに表示されます。

LayoutSection

LayoutSection は [カスタムリンク] セクションなど、ページレイアウトのセクションを表します。

項目名	データ型	説明
customLabel	boolean	このセクションの表示ラベルがカスタムであるか標準 (組み込み) であるかを示します。カスタム表示ラベルは任意のテキストですが、翻訳する必要があります。標準表示ラベルには、「システム情報」など、自動的に翻訳される、定義済みの有効な値セットが含まれます。
detailHeading	boolean	このセクションを詳細ページに表示するかどうかを制御します。UI では、この設定はセクションの詳細ダイアログのチェックボックスに対応します。
editHeading	boolean	このセクションを編集ページに表示するかどうかを制御します。
label	string	表示ラベル。customLabel フラグに基づいて標準またはカスタムのいずれかとなります。
layoutColumns	LayoutColumn[]	レイアウトの列です。スタイルによって異なります。1 列、2 列、または 3 列が含まれ、左から右に並べられます。
style	LayoutSectionStyle (string 型の列挙)	レイアウトのスタイルは次のとおりです。 `TwoColumnsTopToBottom` - 2 列。タブは上から下に並べられます。 `TwoColumnsLeftToRight` - 2 列。タブは左から右に並べられます。 `OneColumn` - 1 列。 `CustomLinks` - カスタムリンクのみを含む。
summaryLayout	SummaryLayout	将来の使用のために予約されています。

LayoutColumn

LayoutColumn は、レイアウトセクション内の列の項目を表します。

項目名	データ型	説明
layoutItems	LayoutItem[]	列内の個々の項目 (上から下の順序)
reserved	string	この項目は Salesforce 用に予約されています。この項目は一部の SOAP ライブラリに関する問題を解決します。この項目に入力された値はすべて無視されます。

LayoutItem

LayoutItem は、レイアウト項目を定義する有効な値を表します。項目には、component、customLink、field、scontrol、page、analyticsCloudComponent、reportChartComponent のいずれか 1 つの値セットのみを含める必要があります。

項目名	データ型	説明
behavior	UiBehavior (string 型の列挙)	項目の動作を決定します。注意: UiBehavior を明示的に指定すると例外が発生します。UiBehavior を指定しないでください。有効な string 値は次のとおりです。 `Edit` — レイアウト項目を編集できますが、必須ではありません。 `Required` — レイアウト項目を編集できます。必須です。 `Readonly` — レイアウト項目は参照のみです。
canvas	string	キャンバスアプリケーションへの参照。この項目は、API バージョン 31.0 以降で使用できます。
component	string	コンポーネントへの参照。値は `sfa:socialCard` である必要があります。この項目は、API バージョン 30.0 以降で使用できます。これは、RelatedContentItem 内でのみ使用できます。`sfa:socialCard` は、取引先責任者、取引先、およびリードのページレイアウトでのみサポートされます。
customLink	string	customLink の参照。これは、CustomLink layoutSection 内でのみ使用できます。
emptySpace	boolean	このレイアウト項目が空白スペースであるかどうかを制御します。
field	string	`Description` または `MyField__c` などのレイアウトオブジェクトを��準にした項目名の参照。
height	int	ピクセル単位の高さ (Sコントロールおよびページのみ)。
page	string	Visualforce ページへの参照。
analyticsCloudComponent	AnalyticsCloudComponentLayoutItem	標準オブジェクトまたはカスタムオブジェクトのページに追加できる Analytics ダッシュボードを参照します。この項目は、API バージョン 34.0 以降で使用できます。
reportChartComponent	ReportChartComponentLayoutItem	標準またはカスタムオブジェクトページに追加できるレポートグラフを参照します。
scontrol	string	Sコントロールへの参照。
showLabel	boolean	表示ラベルを表示するかどうか (Sコントロールおよびページのみ)。
showScrollbars	boolean	スクロールバーを表示するかどうか (Sコントロールおよびページのみ)。
width	string	ピクセルまたはパーセント単位の幅 (Sコントロールおよびページのみ)。ピクセル値は `500` など、単なるピクセル数です。パーセント値には、`20%` などのようにパーセント記号を含める必要があります。

AnalyticsCloudComponentLayoutItem

標準ページまたはカスタムページの Analytics ダッシュボードの設定を示します。API バージョン 34.0 以降で使用できます。

項目名	データ型	説明
assetType	string	必須。追加する Analytics アセットのタイプを指定します。使用可能なアセットタイプは `dashboard` です。
devName	string	必須。追加するダッシュボードの一意の開発名。
error	string	基本となるダッシュボードでエラーが発生した場合にのみ入力されるエラー文字列。
filter	string	ダッシュボードのデータ項目をオブジェクトの項目に対応付けるためのダッシュボードの初期検索条件を通知し、表示されているレコードデータに関連するデータのみがダッシュボードに表示されるようにします。
height	int	ダッシュボードの高さ (ピクセル単位) を指定します。デフォルトは、`400` です。
hideOnError	boolean	エラーのあるダッシュボードをユーザに表示するかどうかを制御します。この属性が `true` に設定されている場合、ダッシュボードにエラーがあってもページには表示されません。`false` に設定すると、ダッシュボードは表示されますが、エラー以外のデータは表示されません。ユーザに Analytics またはダッシュボードへのアクセス権がないと、エラーが発生する可能性があります。デフォルトは `true` です。
showSharing	boolean	`true` に設定されていて、ダッシュボードが共有可能な場合、ダッシュボードには [共有] アイコンが表示されます。ユーザはこのアイコンをクリックして [共有] ダイアログを開き、ダッシュボードでの投稿やダウンロードができます。`false` に設定されている場合、ダッシュボードに [共有] アイコンは表示されません。この項目は、API バージョン 37.0 以降で使用できます。
showTitle	boolean	`true` の場合、ダッシュボードの上にダッシュボードのタイトルが表示されます。`false` の場合、タイトルなしでダッシュボードが表示されます。デフォルトは、`true` です。
width	string	ダッシュボードの幅 (ピクセルまたはパーセント単位) を指定します。ピクセル値は `500` など、単なるピクセル数です。パーセント値には、`20%` などのようにパーセント記号を含める必要があります。デフォルトは、`100%` です。

ReportChartComponentLayoutItem

標準ページまたはカスタムページのレポートグラフの設定を示します。

項目名	データ型	説明
cacheData	boolean	グラフを表示するときにキャッシュデータを使用するかどうかを示します。属性が `true` に設定されている場合、データは 24 時間キャッシュされます。属性が `false` に設定されている場合、ページが更新されるたびにレポートが実行されます。この項目は、API バージョン 29.0 以降で使用できます。
contextFilterableField	string	レポートグラフを絞り込んでページに関連するデータを返すために使用する項目の一意の開発名。これを設定すると、ページの親オブジェクトまたはレポートタイプの親オブジェクトの ID 項目がグラフのデータ条件になります。グラフが関連データを返すようにするには、レポートタイプの親オブジェクトとページの親オブジェクトが一致する必要があります。
error	string	基本となるレポートでエラーが発生した場合にのみ入力されるエラー文字列。この項目は、API バージョン 31.0 以降で使用できます。
hideOnError	boolean	エラーのあるグラフをユーザに表示するかどうかを制御します。エラーがあり、この属性が設定されていない場合、グラフにはエラー以外のデータは表示されません。エラーはさまざまな理由で発生します。たとえば、グラフで使用する項目へのアクセス権がユーザにない場合や、グラフがレポートから削除された場合などがあります。エラー時にページでグラフを非表示にするには、この属性を `true` に設定します。この項目は、API バージョン 29.0 以降で使用できます。
includeContext	boolean	`true` の場合、レポートグラフが絞り込まれて、ページに関連するデータが返されます。
reportName	string	グラフを含むレポートの一意の開発名。
showTitle	boolean	`true` の場合、レポートからグラフにタイトルが適用されます。
size	ReportChartComponentSize (string 型の列挙)	値が指定されていない場合、グラフサイズは中になります。有効な値は次のとおりです。 `SMALL` `MEDIUM` `LARGE`

PlatformActionList

PlatformActionList は、レイアウトの Salesforce アプリケーションアクションバーに表示されるアクションのリストとその順序を表します。API バージョン 34.0 以降で使用できます。

項目名	データ型	説明
actionListContext	PlatformActionListContext (string 型の列挙)	必須。アクションリストのコンテキスト。有効な値は、次のとおりです。 `Assistant` `BannerPhoto` `Chatter` `Dockable` `FeedElement` `FlexiPage` `Global` `ListView` `ListViewDefinition` `ListViewRecord` `Lookup` `MruList` `MruRow` `ObjectHomeChart` `Photo` `Record` `RecordEdit` `RelatedList` `RelatedListRecord`
platformActionListItems	PlatformActionListItem[]	PlatformActionList のアクション。
relatedSourceEntity	string	ActionListContext が RelatedList または RelatedListRecord の場合、この項目はアクションが属する関連リストの API 名を表します。

PlatformActionListItem

PlatformActionListItem は PlatformActionList のアクションを表します。API バージョン 34.0 以降で使用できます。

項目名	データ型	説明
actionName	string	リストのアクションの API 参照名。
actionType	PlatformActionType (string 型の列挙)	アクションの種別。有効な値は、次のとおりです。 `ActionLink` — API、Web ページ、またはファイルを指す、フィード要素上のインジケータで、Salesforce Chatter フィード UI のボタンによって表されます。 `CustomButton` — クリックすると、ウィンドウ内で URL または Visualforce ページが開くか、JavaScript が実行されます。 `InvocableAction` `ProductivityAction` — 生産性アクションは Salesforce によって事前定義され、限られたオブジェクトのセットに適用されます。生産性アクションを編集または削除することはできません。 `QuickAction` — グローバルアクションまたはオブジェクト固有のアクション。 `StandardButton` — 事前定義された Salesforce ボタン ([新規]、[編集]、[削除] など)。
sortOrder	int	リスト内のアクションの位置。
subtype	string	アクションのサブタイプ。クイックアクションの場合、サブタイプは `QuickActionType` になります。カスタムボタンの場合、サブタイプは `WebLinkTypeEnum` になります。アクションリンクの場合、サブタイプは `Api`、`ApiAsync`、`Download`、`Ui` になります。標準ボタンおよび生産性アクションには、サブタイプはありません。

QuickActionList

QuickActionList はページレイアウトに関連付けられたアクションのリストを表します。API バージョン 28.0 以降で使用できます。

項目名	データ型	説明
quickActionListItems	QuickActionListItem[]	0 個以上の QuickActionList オブジェクトの配列。

QuickActionListItem

QuickActionListItem は QuickActionList リストのアクションを表します。API バージョン 28.0 以降で使用できます。

項目名	データ型	説明
quickActionName	string	アクションの API 名。

RelatedContent

RelatedContent は、ページレイアウトの [モバイルカード] セクションを示します。API バージョン 29.0 以降で使用できます。

項目名	データ型	説明
relatedContentItems	RelatedContentItem[]	ページレイアウトの [モバイルカード] セクションにあるレイアウト項目のリスト。

RelatedContentItem

RelatedContentItem は、RelatedContentItem リストの個々の項目を表します。API バージョン 29.0 以降で使用できます。

項目名	データ型	説明
layoutItem	LayoutItem	[モバイルカード] セクションの個々の LayoutItem。

RelatedListItem

RelatedListItem はページレイアウトの関連リストを表します。

項目名	データ型	説明
customButtons	string[]	関連リストで使用するカスタムボタンのリスト。詳細は、Salesforce オンラインヘルプの「カスタムボタンとリンクの定義」を参照してください。
excludeButtons	string[]	除外される関連リストのボタンのリスト。
fields	string[]	関連リストで表示される項目のリスト。関連リストの標準項目の取得では、API 名ではなく項目の別名が使用されます。たとえば、[Fax]、[携帯]、および [自宅電話] 項目は、Phone2、Phone3、および Phone4 としてそれぞれ取得されます。
relatedList	string	必須。関連リストの名前。
sortField	string	並び替えに使用さ��る項目の名前。
sortOrder	SortOrder (string 型の列挙)	sortField が設定されている場合、sortOrder 項目が並び替え順を決定します。 `Asc` - 昇順での並び替え `Desc` - 降順での並び替え

SummaryLayout

ケースフィードが有効化されているときにページレイアウト上部のグリッドでキー項目を集計する、強調表示パネルの外観を制御します。API バージョン 25.0 以降で使用できます。

項目名	データ型	説明
masterLabel	string	必須。レイアウト表示ラベルの名前。
sizeX	int	必須。強調表示パネルの列数 (1 ～ 4 (両端を含む))。
sizeY	int	必須。各列の行数 (1 または 2)。
sizeZ	int	将来の使用のために予約されています。指定されている場合、設定内容はユーザに表示されません。
summaryLayoutItems	SummaryLayoutItem[]	ケースフィードが有効化されているときに、個々の項目の外観および強調表示パネルのグリッド内の列と行の位置を制御します。少なくとも 1 つは必須項目です。
summaryLayoutStyle	SummaryLayoutStyle (string 型の列挙)	強調表示パネルのスタイル。有効な string 値は次のとおりです。 Default QuoteTemplate DefaultQuoteTemplate CaseInteraction QuickActionLayoutLeftRight (API バージョン 28.0 以降で使用可能) QuickActionLayoutTopDown (API バージョン 28.0 以降で使用可能)

SummaryLayoutItem

ケースフィードが有効化されているときに、個々の項目の外観および強調表示パネルのグリッド内の列と行の位置を制御します。強調表示パネルのグリッドごとに 2 つの項目を指定できます。API バージョン 25.0 以降で使用できます。

項目名	データ型	説明
customLink	string	項目がカスタムリンクの場合は、`customLink` が参照先です。
field	string	ページレイアウトを基準にした項目名の参照。詳細ページにも存在する標準項目またはカスタム項目である必要があります。
posX	int	必須。強調表示パネルのグリッドにおける項目の列の位置。sizeX の範囲内である必要があります。
posY	int	必須。強調表示パネルグリッドにおける項目の行の位置。sizeY の範囲内である必要があります。
posZ	int	将来の使用のために予約されています。指定されている場合、設定内容はユーザに表示されません。

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

ページレイアウトの定義を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<Layout xmlns="http://soap.sforce.com/2006/04/metadata">
3   <customConsoleComponents>
4    <primaryTabComponents>
5       <container>
6           <region>left</region>
7          <style>Stack</style>
8          <unit>Pixel</unit>
9          <width>101</width>
10          <sidebarComponent>
11                <width>60</width>
12                <page>simplepage1</page>
13                <unit>Percentage</unit>
14          </sidebarComponent>
15          <sidebarComponent>
16                <width>40</width>
17                <page>Hello_World</page>
18                <unit>Percentage</unit>
19          </sidebarComponent>
20       </container>
21    </primaryTabComponents>
22    <subtabComponents>
23       <component>
24          <location>top</location>
25          <visualforcePage>ConsoleComponentPage2</visualforcePage>
26          <height>200</height>
27       </component>
28    </subtabComponents>
29   </customConsoleComponents>
30    <customButtons>ButtonLink</customButtons>
31    <layoutSections>
32        <editHeading>true</editHeading>
33        <label>Information</label>
34        <layoutColumns>
35            <layoutItems>
36                <behavior>Required</behavior>
37                <field>Name</field>
38            </layoutItems>
39            <layoutItems>
40                <height>180</height>
41                <scontrol>LayoutSControl</scontrol>
42                <showLabel>true</showLabel>
43                <showScrollbars>true</showScrollbars>
44                <width>50%</width>
45            </layoutItems>
46            <layoutItems>
47                <reportChartComponent>
48                   <contextFilterableField>CUST_ID</contextFilterableField>
49                   <includeContext>true</includeContext>
50                   <reportName>Open_Accounts_by_Cases</reportName>
51                   <showTitle>false</showTitle>
52                   <size>LARGE</size>
53                <reportChartComponent>
54            </layoutItems>
55        </layoutColumns>
56        <layoutColumns>
57            <layoutItems>
58                <behavior>Edit</behavior>
59                <field>OwnerId</field>
60            </layoutItems>
61            <layoutItems>
62                <behavior>Edit</behavior>
63                <field>CurrencyIsoCode</field>
64            </layoutItems>
65        </layoutColumns>
66        <style>TwoColumnsTopToBottom</style>
67    </layoutSections>
68    <layoutSections>
69        <editHeading>true</editHeading>
70        <label>System Information</label>
71        <layoutColumns>
72            <layoutItems>
73                <behavior>Readonly</behavior>
74                <field>CreatedById</field>
75            </layoutItems>
76            <layoutItems>
77                <behavior>Readonly</behavior>
78                <field>Alpha1__c</field>
79            </layoutItems>
80            <layoutItems>
81                <height>200</height>
82                <page>mcanvasPage</page>
83                <showLabel>true</showLabel>
84                <showScrollbars>false</showScrollbars>
85                <width>100%</width>
86            </layoutItems>
87        </layoutColumns>
88        <layoutColumns>
89            <layoutItems>
90                <behavior>Readonly</behavior>
91                <field>LastModifiedById</field>
92            </layoutItems>
93            <layoutItems>
94                <behavior>Edit</behavior>
95                <field>TextArea__c</field>
96            </layoutItems>
97        </layoutColumns>
98        <style>TwoColumnsTopToBottom</style>
99    </layoutSections>
100    <layoutSections>
101        <customLabel>true</customLabel>
102        <detailHeading>true</detailHeading>
103        <label>Custom Links</label>
104        <layoutColumns>
105            <layoutItems>
106                <customLink>CustomWebLink</customLink>
107            </layoutItems>
108        </layoutColumns>
109        <style>CustomLinks</style>
110    </layoutSections>
111     <quickActionList>
112        <quickActionListItems>
113            <quickActionName>FeedItem.TextPost</quickActionName>
114        </quickActionListItems>
115        <quickActionListItems>
116            <quickActionName>FeedItem.ContentPost</quickActionName>
117        </quickActionListItems>
118        <quickActionListItems>
119            <quickActionName>FeedItem.LinkPost</quickActionName>
120        </quickActionListItems>
121        <quickActionListItems>
122            <quickActionName>FeedItem.PollPost</quickActionName>
123        </quickActionListItems>
124    </quickActionList>
125    <relatedContent>
126        <relatedContentItems>
127            <layoutItem>
128                <component>sfa:socialPanel</component>
129            </layoutItem>
130        <relatedContentItems>
131    </relatedContent>
132    <miniLayoutFields>Name</miniLayoutFields>
133    <miniLayoutFields>OwnerId</miniLayoutFields>
134    <miniLayoutFields>CurrencyIsoCode</miniLayoutFields>
135    <miniLayoutFields>Alpha1__c</miniLayoutFields>
136    <miniLayoutFields>TextArea__c</miniLayoutFields>
137    <miniRelatedLists>
138        <relatedList>RelatedNoteList</relatedList>
139    </miniRelatedLists>
140    <relatedLists>
141        <fields>StepStatus</fields>
142        <fields>CreatedDate</fields>
143        <fields>OriginalActor</fields>
144        <fields>Actor</fields>
145        <fields>Comments</fields>
146        <fields>Actor.Alias</fields>
147        <fields>OriginalActor.Alias</fields>
148        <relatedList>RelatedProcessHistoryList</relatedList>
149    </relatedLists>
150    <relatedLists>
151        <relatedList>RelatedNoteList</relatedList>
152    </relatedLists>
153</Layout>

<summaryLayout> を使用したレイアウトの例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<Layout xmlns="http://soap.sforce.com/2006/04/metadata">
3    <layoutSections>
4        <editHeading>true</editHeading>
5        <label>System Information</label>
6        <layoutColumns>
7            <layoutItems>
8                <behavior>Readonly</behavior>
9                <field>CreatedById</field>
10            </layoutItems>
11            <layoutItems>
12                <behavior>Required</behavior>
13                <field>Name</field>
14            </layoutItems>
15        </layoutColumns>
16        <layoutColumns>
17            <layoutItems>
18                <behavior>Readonly</behavior>
19                <field>LastModifiedById</field>
20            </layoutItems>
21        </layoutColumns>
22        <style>TwoColumnsTopToBottom</style>
23    </layoutSections>
24    <summaryLayout>
25        <masterLabel>Great Name</masterLabel>
26        <sizeX>4</sizeX>
27        <sizeY>2</sizeY>
28        <summaryLayoutItems>
29            <posX>0</posX>
30            <posY>0</posY>
31            <field>Name</field>
32        </summaryLayoutItems>
33    </summaryLayout>
34</Layout>

フィードベースのレイアウトの例を次に示します。

1<Layout>
2...
3    <feedLayout>
4        <leftComponents>
5            <componentType>customLinks</componentType>
6        </leftComponents>
7        <rightComponents>
8            <componentType>follow</componentType>
9        </rightComponents>
10        <rightComponents>
11            <componentType>followers</componentType>
12        </rightComponents>
13        <rightComponents>
14            <componentType>visualforce</componentType>
15            <page>accountCustomWidget</page>
16            <height>200</height>
17        </rightComponents>
18        <hideSidebar>true</hideSidebar>
19        <feedFilterPosition>centerDropDown</feedFilterPosition>
20        <feedFilters>
21    <feedFilerType>allUpdates</feedFilerType>
22        </feedFilters>
23        <feedFilters>
24    <feedFilerType>feedItemType</feedFilerType>
25    <feedItemType>CallLogPost</feedItemType>
26        </feedFilters>
27        <feedFilters>
28    <feedFilerType>feedItemType</feedFilerType>
29    <feedItemType>TextPost</feedItemType>
30        </feedFilters>
31    </feedLayout>
32...
33</Layout>