メタデータ API 開発者ガイド
jActionLinkGroupTemplate
アクションリンクグループテンプレートを表します。アクションリンクテンプレートを使用すると、アクションリンク定義を再利用して、アクションリンクをパッケージ化および配布することができます。アクションリンクは、フィード要素上のボタンです。アクションリンクをクリックすると、ユーザーを別の Web ページに移動したり、ファイルダウンロードを開始したり、外部サーバーまたは Salesforce への API コールを呼び出したりできます。アクションリンクを使用して Salesforce およびサードパーティサービスをフィードに統合できます。すべてのアクションリンクはアクションリンクグループに属しており、グループ内のアクションリンクは相互排他的です。
Metadata メタデータ型を拡張し、その fullName 項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
ActionLinkGroupTemplate コンポーネントのサフィックスは .actionLinkGroupTemplate で、actionLinkGroupTemplates フォルダーに保存されます。
バージョン
ActionLinkGroupTemplate コンポーネントは、API バージョン 33.0 以降で使用できます。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| actionLinkTemplates | ActionLinkTemplate[] | アクションリンクグループテンプレートに関連付けられたアクションリンクテンプレート。 |
| category | PlatformActionGroupCategory (string 型の列挙) | 必須。フィード要素内のアクションリンクグループの場所。値は次のとおりです。
|
| executionsAllowed | ActionLinkExecutionsAllowed (string 型の列挙) | 必須。アクションリンクを実行できる回数。値は次のとおりです。
|
| hoursUntilExpiration | int | 必須。関連するフィード要素から削除され実行できなくなるまでに、アクションリンクグループを作成できる時間数。最大値は、8,760 です。 |
| isPublished | boolean | 必須。true の場合、アクションリンクグループテンプレートが公開されます。アクションリンクグループテンプレートは、少なくとも 1 つのアクションリンクテンプレートが関連付けられるまで公開しないでください。 |
| name | string | 必須。コードで使用するアクションリンクグループテンプレートの名前。 |
ActionLinkTemplate
ActionLinkTemplate コンポーネントは、プロパティを共有する複数のアクションリンクを作成するために使用されます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| actionUrl | string | 必須。アクションリンクの URL。たとえば、Ui アクションリンク URL は Web ページになります。Download アクションリンク URL は、ダウンロードするファイルへのリンクになります。Ui および Download アクションリンク URL がクライアントに提供されます。Api または ApiAsync アクションリンク URL は REST リソースになります。Api および ApiAsync アクションリンク URL はクライアントに提供されません。Salesforce へのリンクは、相対リンクにすることができます。他のすべてのリンクは、https:// で始まる絶対リンクにする必要があります。 |
| headers | string | 対応するアクションリンクが呼び出されときに送信される HTTP ヘッダーのテンプレート。この項目は、Api および ApiAsync アクションリンクでのみ使用できます。この項目には、コンテキスト変数とバインド変数を {!Bindings.key} 形式で含めることができます。 |
| isConfirmationRequired | boolean | 必須。true の場合、アクションの実行前に確認ダイアログが表示されます。 |
| isGroupDefault | boolean | 必須。true の場合、このテンプレートから派生するアクションリンクが、そのアクショングループのデフォルトアクションまたはプライマリアクションになります。各アクショングループに含めることができるデフォルトアクションは 1 つのみです。 |
| label | string | アクションリンクボタンに表示するカスタムの表示ラベル。どの LabelKey 値もアクションリンクには不適切な場合は、カスタムの表示ラベルを使用します。LabelKey 項目を None に設定し、Label 項目に表示ラベル名を入力します。 |
| labelKey | string | 必須。新規、待機中、成功、失敗の状況を示す、アクションリンクの表示ラベルのセットのキー。たとえば、[承認] セットには、[承認]、[待機中]、[承認済み]、[失敗] の表示ラベルが含まれます。キーおよび表示ラベルの完全なリストは、『Connect REST API 開発者ガイド』の「アクションリンクの表示ラベル」を参照してください。 |
| linkType | ActionLinkType (string 型の列挙) | 必須。アクションリンクの種別。次のいずれかの値になります。
|
| method | ActionLinkHttpMethod (string 型の列挙) | 必須。アクション URL の HTTP メソッド。次のいずれかの値になります。
Ui および Download アクションリンクでは、HttpGet を使用する必要があります。 |
| position | int | 必須。グループ内の他のアクションリンクに関連するアクションリンクテンプレートの位置を指定する整数。0 は最初の位置です。 |
| requestBody | string | 対応するアクションリンクが呼び出されときに送信される HTTP リクエストボディのテンプレート。この項目は、Api および ApiAsync アクションリンクでのみ使用できます。この項目には、コンテキスト変数とバインド変数を {!Bindings.key} 形式で含めることができます。 |
| userAlias | string | UserVisibility に対して CustomUser または CustomExcludedUser を選択した場合、この項目がカスタムユーザーの別名になります。テンプレートを使用してアクションリンクグループを作成する場合、テンプレートバインドでこの別名を使用してカスタムユーザーを指定します。 |
| userVisibility | ActionLinkUserVisibility (string 型の列挙) | 必須。アクションリンクを表示できるユーザー。この値は、アクションリンクグループごとではなく、アクションリンクごとに設定されます。値は次のとおりです。
|
宣言的なメタデータの定義のサンプル
ActionLinkGroupTemplate コンポーネントの例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<ActionLinkGroupTemplate xmlns="http://soap.sforce.com/2006/04/metadata">
3 <actionLinkTemplates>
4 <actionUrl>/services/data/{!Bindings.word}/chatter/feed-elements</actionUrl>
5 <headers>Content-Type:{!Bindings.word3}</headers>
6 <isConfirmationRequired>true</isConfirmationRequired>
7 <isGroupDefault>true</isGroupDefault>
8 <labelKey>Add</labelKey>
9 <linkType>API</linkType>
10 <method>httpPost</method>
11 <position>0</position>
12 <requestBody>{"body":{"messageSegments":[{"type": "Text",
13 "text": "{!Bindings.word1}"}]},"subjectId": "{!Bindings.word2}",
14 "feedElementType": "feedItem"}</requestBody>
15 <userAlias>customExcludedUser</userAlias>
16 <userVisibility>CustomExcludedUser</userVisibility>
17 </actionLinkTemplates>
18 <category>Primary</category>
19 <executionsAllowed>OncePerUser</executionsAllowed>
20 <hoursUntilExpiration>10</hoursUntilExpiration>
21 <isPublished>true</isPublished>
22 <name>MyPackage</name>
23</ActionLinkGroupTemplate>前の定義を参照する 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>ActionLinkGroupTemplate</name>
6 </types>
7 <version>33.0</version>
8</Package>使用方法
アクションリンクグループテンプレートを変更すると、関連するアクションリンクテンプレートが上書きされます。
公開済みのアクションリンクグループテンプレートを削除すると、関連するすべてのアクションリンクの情報が削除されます。これには、フィード項目のテンプレートを使用してインスタンス化されたすべてのアクションリンクの削除も含まれます。
マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。