メタデータ API 開発者ガイド
jNavigationMenu
Experience Builder サイトのナビゲーションメニューを表します。ナビゲーションメニューは、ユーザーがクリックするとサイトの他の部分に移動できる項目で構成されます。この種別は、ネットワークの NavigationLinkSet サブタイプの代わりに使用されます。NavigationMenu は API バージョン 47.0 以降で使用できます。Metadata メタデータ型を拡張し、その fullName 項目を継承します。
ヘルプセンターテンプレートと LWR テンプレート (Build Your Own とマイクロサイト) に汎用のレコードページは含まれません。そのため、Salesforce オブジェクトにリンクするオブジェクトアクション種別またはグローバルアクション種別のメニュー項目を作成する場合は、対応するオブジェクトページも必ず作成してください。関連付けられたオブジェクトページを作成しない場合、エンドユーザーがメニュー項目をクリックしても何も表示されません。
ファイルのサフィックスおよびディレクトリの場所
NavigationMenu コンポーネントのサフィックスは .navigationMenu で、navigationMenus フォルダーに保存されます。
バージョン
NavigationMenu コンポーネントは、API バージョン 47.0 以降で使用できます。
特別なアクセスルール
MultipleNavigationMenu 権限が必要です。
項目
| 項目 | 項目の型 | 説明 |
|---|---|---|
| container | string | ナビゲーションメニューコンテナの名前。 |
| containerType | string | コンテナ種別。選択肢は、Network と CommunityTemplateDefinition です。 |
| label | string | ナビゲーションメニューラベル。エクスペリエンスビルダー UI にこのとおり表示されます。 |
| NavigationMenuItem[] | NavigationMenu のメニュー項目のリスト。このオブジェクトを使用して、サイトのナビゲーションメニューのメニュー項目を作成、削除、または更新します。 |
| 項目 | 項目の型 | 説明 |
|---|---|---|
| defaultListViewId | string | type 項目の値が SalesforceObject の場合、値はオブジェクトのデフォルトのリストビューの ID です。 |
| label | string | 必須。ナビゲーションメニューのこの項目に表示されるテキスト。 |
| menuItemBranding | NavigationMenuItemBranding | ナビゲーションメニュー項目のブランド。API バージョン 47.0 以降で利用できます。 |
| position | int | 必須。ナビゲーションメニュー内のメニュー項目の位置。 |
| publiclyAvailable | boolean | true に設定すると、ゲストユーザーにアクセス権が付与されます。 |
| subMenu | NavigationSubMenu | 子メニュー項目のリスト。この項目は API 39.0 以降で使用できます。 |
| target | string | type が ExternalLink、InternalLink、SalesforceObject のいずれかである場合は必須です。type が ExternalLink または InternalLink の場合、target はリンクが参照する URL です。ExternalLink の場合、エントリは https://salesforce.com のようになります。InternalLink の場合、/contactsupport のような相対 URL を使用します。type が MenuLabel または NavigationalTopic の場合、target は使用されません。 |
| targetPreference | string | 対象項目の設定を含む選択リストが基盤となります。有効な値は、次のとおりです。
|
| type | string | 必須。ナビゲーションメニュー項目の種別。有効な値は、次のとおりです。
MenuLabel の下の種別が MenuLabel または NavigationalTopic のその他の項目はネストできません。 |
宣言的なメタデータの定義のサンプル
NavigationMenu コンポーネントの例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<NavigationMenu xmlns="http://soap.sforce.com/2006/04/metadata">
3 <container>Service</container>
4 <containerType>Network</containerType>
5 <label>Test Navigation</label>
6 <navigationMenuItem>
7 <label>Accounts</label>
8 <position>1</position>
9 <publiclyAvailable>false</publiclyAvailable>
10 <target>Account</target>
11 <type>SalesforceObject</type>
12 </navigationMenuItem>
13 <navigationMenuItem>
14 <label>External Link</label>
15 <menuItemBranding>
16 <tileImage>google_image</tileImage>
17 </menuItemBranding>
18 <position>2</position>
19 <publiclyAvailable>false</publiclyAvailable>
20 <target>http://google.com</target>
21 <targetPreference>OpenExternalLinkInSameTab</targetPreference>
22 <type>ExternalLink</type>
23 </navigationMenuItem>
24 <navigationMenuItem>
25 <label>All Objects</label>
26 <position>3</position>
27 <publiclyAvailable>false</publiclyAvailable>
28 <subMenu>
29 <navigationMenuItem>
30 <label>Leads</label>
31 <position>0</position>
32 <publiclyAvailable>false</publiclyAvailable>
33 <target>Account</target>
34 <type>SalesforceObject</type>
35 </navigationMenuItem>
36 </subMenu>
37 <type>MenuLabel</type>
38 </navigationMenuItem>
39</NavigationMenu>前の定義を参照する package.xml の例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>*</members>
5 <name>NavigationMenu</name>
6 </types>
7 <version>47.0</version>
8</Package>マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。