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

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 内で上書きできる特定の項目。
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 型の列挙)	アクションに使用する標準表示ラベルを指定します。有効な値は、次のとおりです。 `LogACall` `LogANote` `New` (新しいレコード) `NewRecordType` (表示ラベルが「新しいアイデア」などのような場合) `Update` `UpdateRecordType` `NewChild` (新しい子レコード) `NewChildRecordType` `CreateNew` `CreateNewRecordType` (表示ラベルが「新しいアイデアを作成」などのような場合) `SendEmail` (この値は API バージョン 31.0 以降で使用できます)。 `QuickRecordType` `Quick` (クイックレコード)
successMessage	string	アクションが正常に完了するとユーザに表示されるメッセージ。 API バージョン 36.0 以降で利用できます。
targetObject	string	アクションを作成および実行する対象となるオブジェクト。たとえば、取引先の詳細ページで、ユーザがそのページの Chatter フィードからその取引先に関連する取引先責任者を作成するアクションを作成できます。この場合、取引先責任者が targetObject になります。
targetParentField	string	アクションの親オブジェクト種別。ターゲットオブジェクトを親オブジェクトにリンクします。たとえば、ターゲットオブジェクトが取引先責任者であり、親オブジェクトが取引先である場合、取引先を使用します。
targetRecordType	string	作成するレコードタイプを指定します。有効な値は、次のとおりです。法人取引先個人取引先主取引先
type	QuickActionType (string 型の列挙)	必須。クイックアクションの種別。有効な値は、次のとおりです。 `Canvas` `Create` `LightningComponent` (この値は API バージョン 38.0 以降で使用できます)。 `LogACall` `Post` `SendEmail` (この値は API バージョン 31.0 以降で使用できます)。 `SocialPost` `Update` `VisualforcePage`
width	int	カスタムアクションを作成する場合、この項目はアクションペインの幅 (ピクセル単位) を表します。

FieldOverride

QuickAction での上書きを構成する項目名、各項目の数式およびリテラル値を表します。

項目名	データ型	説明
field	string	上書きを許可する特定の項目の名前。
formula	string	項目を上書きするときに使用する数式を指定します。
literalValue	string	上書きなしの項目の値。

QuickActionLayout

アクション中の項目のレイアウト。アクションレイアウトに追加できる項目数にハードリミットはありません。ただし、使いやすさを最適化するため、最大 8 項目をお勧めします。20 項目以上を追加すると、ユーザの効率が大幅に低下します。

項目名	データ型	説明
layoutSectionStyle	LayoutSectionStyle (string 型の列挙)	使用するレイアウト構造の種別。有効な値は、次のとおりです。 `TwoColumnsTopToBottom` `TwoColumnsLeftToRight` `OneColumn` `CustomLinks`
quickActionLayoutColumns	QuickActionLayoutColumn[]	QuickActionLayout の列を指定します。

QuickActionLayoutColumn

QuickActionLayout に定義される列です。

項目名	データ型	説明
quickActionLayoutItems	QuickActionLayoutItem[]	QuickActionLayoutColumn の行アイテムを指定します。

QuickActionLayoutItem

項目で構成され QuickActionLayoutColumn 用に定義される行アイテムです。

項目名	データ型	説明
emptySpace	boolean	このレイアウト項目が空白スペースであるか (`true`)、否か (`false`) を制御します。
field	string	QuickActionLayoutItem の特定の項目を表します。アクションレイアウトに追加できる項目数にハードリミットはありません。ただし、使いやすさを最適化するため、最大 8 項目をお勧めします。20 項目以上を追加すると、ユーザの効率が大幅に低下します。
uiBehavior	UiBehavior (string 型の列挙)	QuickActionLayoutItem の特定の項目に関するユーザ入力動作を指定します。有効な値は、次のとおりです。 `Edit` `Required` `Readonly`

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

次に、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>