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

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

各 AppMenu コンポーネントは、対応するパッケージディレクトリのフォルダ内の 1 つのファイルに保存されます。ファイル名には、Feature.appMenu という形式が使用されます。

AppSwitcher.appMenu という名前のファイルに 1 つのアプリケーションスイッチャのアプリケーションメニューファイルが保存されます。
Salesforce1.appMenu という名前のファイルに 1 つの Salesforce アプリケーションメニューファイルが保存されます。

appMenus フォルダにはこれら 2 つのファイルがあります。.appMenu ファイルは、AppMenu コンポーネントごとにファイルが 1 つしかないため、他の名前付きコンポーネントとは異なります。アプリケーションメニューファイルの作成や削除はできません。

バージョン

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

項目

項目名	項目の型	説明
appMenuItems	AppMenuItem[]	アプリケーションメニュー内のメニュー項目のリスト。

AppMenuItem

アプリケーションメニュー内のメニュー項目を表します。

項目名	項目の型	説明
name	string	項目の API 名。
type	string	この項目で表されるアプリケーションの種別。 AppSwitcher.appMenu の有効値は次のとおりです。 `ConnectedApp` `CustomApplication` `ServiceProvider` Salesforce1.appMenu の有効値は次のとおりです。 `CustomApplication` `CustomTab` `StandardAppMenuItem`。この項目には次の名前を使用できます。 `MyDay` `Feed` `ToDo` `Dashboards` `Search` `People` (Chatter が有効な場合にのみ使用可能) `Groups` (Chatter が有効な場合にのみ使用可能)

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

次に、AppSwitcher.appMenu ファイルの例を示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<AppMenu xmlns="http://soap.sforce.com/2006/04/metadata">
3   <appMenuItems>
4      <appMenuItem>
5         <name>standard__Sales</name>
6         <type>CustomApplication</type>
7      </appMenuItem>
8      <appMenuItem>
9         <name>standard__Support</name>
10         <type>CustomApplication</type>
11      </appMenuItem>
12      <appMenuItem>
13         <name>CustomApp1</name>
14         <type>CustomApplication</type>
15      </appMenuItem>
16      <appMenuItem>
17         <name>CustomApp2</name>
18         <type>CustomApplication</type>
19      </appMenuItem>
20      <appMenuItem>
21         <name>ConnectedApp1</name>
22         <type>ConnectedApp</type>
23      </appMenuItem>
24   </appMenuItems>
25</AppMenu>

前の定義を参照する package.xml の例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3   <types>
4      <members>AppSwitcher</members>
5      <name>AppMenu</name>
6   </types>

Salesforce1.appMenu コンポーネントの例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<AppMenu xmlns="http://soap.sforce.com/2006/04/metadata">
3   <appMenuItems>
4      <appMenuItem>
5         <name>StandardItem1</name>
6         <type>StandardAppMenuItem</type>
7      </appMenuItem>
8      <appMenuItem>
9         <name>StandardItem2</name>
10         <type>StandardAppMenuItem</type>
11      </appMenuItem>
12      <appMenuItem>
13         <name>StandardItem3</name>
14         <type>StandardAppMenuItem</type>
15      </appMenuItem>
16      <appMenuItem>
17         <name>CustomTab1</name>
18         <type>CustomTab</type>
19      </appMenuItem>
20   </appMenuItems>
21</AppMenu>

前の定義を参照する package.xml の例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3   <types>
4      <members>Salesforce1</members>
5      <name>AppMenu</name>
6   </types>

組織の使用可能なすべてのアプリケーションメニューメタデータをリリースまたは取得するために使用される、パッケージマニフェストの例を次に示します。

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>AppMenu</name>
6   </types>
7   <version>30.0</version>
8</Package>

使用方法

アプリケーションメニューに表示されるメニュー項目のリストを並び替えるには、AppSwitcher.appMenu を使用します。AppSwitcher.appMenu にアプリケーションメニュー項目を追加したり、AppSwitcher.appMenu からアプリケーションメニュー項目を削除したりすることはできません。

アプリケーションメニュー項目を並び替え、追加、または削除することによって Salesforce ナビゲーションメニューに表示するメニュー項目のリストをカスタマイズするには、Salesforce1.appMenu を使用します。

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

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