メタデータ API 開発者ガイド
jQuickAction
Chatter パブリッシャーで使用可能となるオブジェクトに対して指定された作成または更新クイックアクションを表します。たとえば、取引先の詳細ページで、ユーザーがそのページの Chatter フィードからその取引先に関連する取引先責任者を作成するアクションを作成できます。QuickAction は、カスタム項目が許可されたオブジェクトで作成できます。
サポートされる親オブジェクトは、次のとおりです。
- Account
- Campaign
- Case
- Contact
- ContentNote
- Custom objects
- Group
- Lead
- Opportunity
ファイルのサフィックスおよびディレクトリの場所
QuickAction コンポーネントのサフィックスは quickAction で、quickActions フォルダーに保存されます。
バージョン
QuickAction コンポーネントは、API バージョン 28.0 以降で使用できます。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| canvas | string |
カスタムアクションがキャンバスアプリケーションを呼び出す場合のアプリケーション名。クイックアクション種別が Canvas の場合はキャンバスアプリケーションの完全修飾名を <namespace>__<dev_name> 形式で返し、そうでない場合は null を返します。 この項目は、API バージョン 29.0 以降で使用できます。 |
| description | string | アクションの説明。 |
| fieldOverrides | FieldOverride[] | QuickAction 内で上書きできる特定の項目。 |
| flowDefinition | string | カスタムアクションがフローを呼び出す場合、この項目は、そのフローの API 参照名を表します。それ以外の場合、この項目は null になります。 |
| height | int | カスタムアクションを作成する場合、この項目はアクションペインの高さ (ピクセル単位) を表します。 |
| icon | string | アクションの識別に使用するアイコン。 バージョン 32.0 以降は、以前の API バージョンと異なるアイコンを返します。 |
| isProtected | boolean | このコンポーネントが保護されるか (true)、否か (false) を示します。保護コンポーネントは、インストールする組織で作成されたコンポーネントによってリンク設定したり参照したりすることはできません。 |
| label | string | アクションを特定し、ユーザーに表示します。API および管理パッケージに使用するデフォルトの識別子でもあります。 |
| lightningComponent | string |
カスタムアクションが Lightning コンポーネントを呼び出す場合、この項目は、そのコンポーネントの完全修飾名を表します。それ以外の場合、この項目は null になります。 API バージョン 38.0 以降で利用できます。 |
| optionsCreateFeedItem | boolean | 必須。アクションが正常に完了するとフィード項目が作成されるか (true)、否か (false) を示します。[レコードの作成]、[レコードを更新]、および [活動の記録] クイックアクション種別にのみ適用されます。 API バージョン 36.0 以降で利用できます。 |
| page | string | カスタムアクションが Visualforce ページを呼び出す場合、この項目はページを特定します。 |
| quickActionLayout | QuickActionLayout | アクション中の項目のレイアウト。 |
| standardLabel | QuickActionLabel (string 型の列挙) | アクションに使用する標準表示ラベルを指定します。有効な値は、次のとおりです。
|
| successMessage | string | アクションが正常に完了するとユーザーに表示されるメッセージ。 API バージョン 36.0 以降で利用できます。 |
| targetObject | string | アクションを作成および実行する対象となるオブジェクト。 たとえば、取引先の詳細ページで、ユーザーがそのページの Chatter フィードからその取引先に関連する取引先責任者を作成するアクションを作成できます。QuickAction は、カスタム項目が許可されたオブジェクトで作成できます。この場合、取引先責任者が targetObject になります。 |
| targetParentField | string | アクションの親オブジェクト種別。対象オブジェクトを親オブジェクトにリンクします。たとえば、対象オブジェクトが取引先責任者であり、親オブジェクトが取引先である場合、取引先を使用します。 |
| targetRecordType | string | 作成するレコードタイプを指定します。有効な値は、次のとおりです。
|
| type | QuickActionType (string 型の列挙) | 必須。クイックアクションの種別。有効な値は、次のとおりです。
|
| width | int | カスタムアクションを作成する場合、この項目はアクションペインの幅 (ピクセル単位) を表します。 |
FieldOverride
QuickAction の定義済み値の設定を構成する項目名、各項目の数式およびリテラル値を表します。アクションの項目に定義済みの値とデフォルト値のセットの両方が含まれている場合、デフォルト値ではなく定義済みの値がアクションで使用されます。数式値とリテラル値の両方が設定されている場合は、数式値が優先されます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| field | string | 必須。定義済み値の設定を許容する項目の名前。 |
| formula | string | 項目の定義済み値を設定するときに使用する数式を指定します。API バージョン 43.0 以降、単一選択リストでサポートされます。 |
| literalValue | string | 選択リストでのみサポートされます。選択リストの値から定義される項目のリテラル値を指定します。定義済み値の UI の [特定値] 項目に対応します。 |
QuickActionLayout
アクション中の項目のレイアウト。アクションレイアウトに追加できる項目数にハードリミットはありま��ん。ただし、使いやすさを最適化するため、最大 8 項目をお勧めします。20 項目以上を追加すると、ユーザーの効率が大幅に低下します。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| layoutSectionStyle | LayoutSectionStyle (string 型の列挙) | 必須。使用するレイアウト構造の種別。有効な値は、次のとおりです。
|
| quickActionLayoutColumns | QuickActionLayoutColumn[] | QuickActionLayout の列を指定します。 |
QuickActionLayoutColumn
QuickActionLayout に定義される列です。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| quickActionLayoutItems | QuickActionLayoutItem[] | QuickActionLayoutColumn の行アイテムを指定します。 |
QuickActionLayoutItem
項目で構成され QuickActionLayoutColumn 用に定義される行アイテムです。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| emptySpace | boolean | このレイアウト項目が空白スペースであるか (true)、否か (false) を制御します。 |
| field | string | QuickActionLayoutItem の特定の項目を表します。 |
| uiBehavior | UiBehavior (string 型の列挙) |
QuickActionLayoutItem の特定の項目に関するユーザー入力動作を指定します。有効な値は、次のとおりです。
|
宣言的なメタデータの定義のサンプル
次に、QuickAction コンポーネントの例を示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<QuickAction xmlns="http://soap.sforce.com/2006/04/metadata">
3 <description>testActionDefinitionTypesCreateTask</description>
4 <label>testActionDefinitionTypesCreateTask</label>
5 <optionsCreateFeedItem>true</optionsCreateFeedItem>
6 <quickActionLayout>
7 <layoutSectionStyle>TwoColumnsLeftToRight</layoutSectionStyle>
8 <quickActionLayoutColumns>
9 <quickActionLayoutItems>
10 <emptySpace>false</emptySpace>
11 <field>OwnerId</field>
12 <uiBehavior>Required</uiBehavior>
13 </quickActionLayoutItems>
14 <quickActionLayoutItems>
15 <emptySpace>false</emptySpace>
16 <field>WhoId</field>
17 <uiBehavior>Edit</uiBehavior>
18 </quickActionLayoutItems>
19 <quickActionLayoutItems>
20 <emptySpace>false</emptySpace>
21 <field>WhatId</field>
22 <uiBehavior>Edit</uiBehavior>
23 </quickActionLayoutItems>
24 <quickActionLayoutItems>
25 <emptySpace>false</emptySpace>
26 <field>ActivityDate</field>
27 <uiBehavior>Edit</uiBehavior>
28 </quickActionLayoutItems>
29 <quickActionLayoutItems>
30 <emptySpace>false</emptySpace>
31 <field>Subject</field>
32 <uiBehavior>Edit</uiBehavior>
33 </quickActionLayoutItems>
34 <quickActionLayoutItems>
35 <emptySpace>false</emptySpace>
36 <field>Status</field>
37 <uiBehavior>Required</uiBehavior>
38 </quickActionLayoutItems>
39 <quickActionLayoutItems>
40 <emptySpace>false</emptySpace>
41 <field>Priority</field>
42 <uiBehavior>Required</uiBehavior>
43 </quickActionLayoutItems>
44 </quickActionLayoutColumns>
45 <quickActionLayoutColumns/>
46 </quickActionLayout>
47 <successMessage>This is a success message</successMessage>
48 <targetObject>Task</targetObject>
49 <targetParentField>What</targetParentField>
50 <type>Create</type>
51</QuickAction>マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。