この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

PlatformAction

PlatformAction は、参照のみの仮想オブジェクトです。ユーザ、コンテキスト、デバイス形式、レコード ID に応じて、UI に表示するアクションを照会できるようにします。たとえば、標準およびカスタムボタン、クイックアクション、生産性アクションなどを照会できます。

サポートされているコール

describeSObjects()、query()

項目

項目	詳細
ActionListContext	型 picklist プロパティ Filter、Group、Nillable、Restricted picklist、Sort 説明必須。このアクションが適用されるリストコンテキスト。有効な値は、次のとおりです。 `ActionDefinition` `Assistant` `BannerPhoto` `Chatter` `Dockable` `FeedElement` `FlexiPage` `Global` `ListView` `ListViewDefinition` `ListViewRecord` `Lookup` `MruList` `MruRow` `ObjectHomeChart` `Photo` `Record` `RecordEdit` `RelatedList` `RelatedListRecord`
ActionTarget	型 textarea プロパティ Nillable 説明アクションが呼び出された場合に、アクションの呼び出しまたは記述を行うための URL。アクションが Visualforce ページで上書きされた標準ボタンの場合、/apex/`pagename` のような Visualforce ページの URL が ActionTarget から返されます。この項目は、API バージョン 35.0 以降で使用できます。
ActionTargetType	型 picklist プロパティ Filter、Group、Nillable、Restricted picklist、Sort 説明このアクションがトリガされる対象の種類。有効な値は、次のとおりです。 `Describe` — クイックアクションなど、ユーザインターフェースを使用するアクションに適用されます。 `Invoke` — アクションリンクや呼び出し可能なアクションなど、ユーザインターフェースを使用しないアクションに適用されます。 `Visualforce` — Visualforce ページで上書きされた標準ボタンに適用されます。
ActionTargetUrl	型 string プロパティ Filter、Group、Nillable、Sort 説明アクションが呼び出された場合に、アクションの呼び出しまたは記述を行うための URL。この項目は API バージョン 35.0 以降では廃止されました。代わりに ActionTarget を使用します。
Category	型 picklist プロパティ Filter、Group、Nillable、Restricted picklist、Sort 説明アクションリンクにのみ適用されます。アクションのフィード項目リストまたはオーバーフローリストのどちらにアクションリンクを表示するかを示します。有効な値は、次のとおりです。 `Primary` `Overflow`
ConfirmationMessage	型 string プロパティ Filter、Group、Nillable、Sort 説明アクションリンクにのみ適用されます。アクションを呼び出す前に表示するメッセージ。アクションを呼び出す前に確認する必要がない場合、この項目は null になります。
DeviceFormat	型 picklist プロパティ Defaulted on create、Filter、Group、Nillable、Restricted picklist、Sort 説明 PlatformAction クエリから返されるアクションアイコンを指定します。この項目を指定しない場合、デフォルトは Phone です。有効な値は、次のとおりです。 `Aloha` `Desktop` `Phone` `Tablet`
ExternalId	型 string プロパティ Filter、Group、Nillable、Sort 説明 PlatformAction の一意の ID。アクションに ID がない場合、API 名が使用されます。
GroupId	型 reference プロパティ Filter、Group、Nillable、Sort 説明アクションリンクのグループの一意の ID。
IconContentType	型 string プロパティ Filter、Group、Nillable、Sort 説明このアクションのアイコンのコンテンツタイプ (.jpg、.gif、.png など)。アクションに割り当てられたカスタムアイコンと標準アイコンの両方に適用されます。
IconHeight	型 int プロパティ Filter、Group、Nillable、Sort 説明このアクションのアイコンの高さ。標準アイコンにのみ適用されます。
IconUrl	型 url プロパティ Filter、Group、Nillable、Sort 説明このアクションのアイコンの URL。
IconWidth	型 int プロパティ Filter、Group、Nillable、Sort 説明このアクションのアイコンの幅。標準アイコンにのみ適用されます。
InvocationStatus	型 picklist プロパティ Filter、Group、Nillable、Restricted picklist、Sort 説明フィード項目内のアクションの状況。アクションリンクにのみ適用されます。有効な値は、次のとおりです。 `Failed` `New` `Pending` `Successful`
InvokedByUserId	型 reference プロパティ Filter、Group、Nillable、Sort 説明現在のフィード項目内でこのアクションを最後に呼び出したユーザの ID。アクションリンクにのみ適用されます。これはリレーション項目です。リレーション名 InvokedByUser リレーション種別 Lookup 参照先 User
IsGroupDefault	型 boolean プロパティ Defaulted on create、Filter、Group、Sort 説明アクションリンクグループのデフォルトアクションかどうかを示します。他のアクション種別の場合は False になります。アクションリンクにのみ適用されます。
IsMassAction	型 boolean プロパティ Defaulted on create、Filter、Group、Sort 説明アクションを複数のレコードに対して実行できるかどうかを示します。この項目は、API バージョン 38.0 以降で使用できます。
Label	型 string プロパティ Filter、Group、Sort 説明このアクションに表示する表示ラベル。
PrimaryColor	型 string プロパティ Filter、Group、Nillable、Sort 説明このアクションのアイコンのメインの色。
RelatedListRecordId	型 string プロパティ Filter、Group、Nillable、Sort 説明オブジェクトの関連リスト内のレコードの ID を表します。この項目は、API バージョン 38.0 以降で使用できます。
RelatedSourceEntity	型 string プロパティ Filter、Group、Nillable、Sort 説明 ActionListContext が RelatedList または RelatedListRecord の場合、この項目はアクションが属する関連リストの API 名を表します。
Section	型 picklist プロパティ Filter、Group、Nillable、Restricted picklist、Sort 説明アクションが存在するユーザインターフェースのセクション。Lightning Experience にのみ適用されます。有効な値は、次のとおりです。 ActivityComposer CollaborateComposer NotesComposer Page SingleActionLinks この項目は、API バージョン 35.0 以降で使用できます。
SourceEntity	型 string プロパティ Filter、Group、Sort 説明必須。このアクションが関連付けられているオブジェクトまたはレコード。
Subtype	型 string プロパティ Filter、Group、Nillable、Sort 説明アクションのサブタイプ。クイックアクションの場合、サブタイプは `QuickActionType` になります。カスタムボタンの場合、サブタイプは `WebLinkTypeEnum` になります。アクションリンクの場合、サブタイプは `Api`、`ApiAsync`、`Download`、`Ui` になります。標準ボタンおよび生産性アクションには、サブタイプはありません。
TargetObject	型 string プロパティ Filter、Group、Nillable、Sort 説明アクションで作成されるオブジェクトレコードのタイプ (取引先責任者や商談など)。この項目は、API バージョン 41.0 以降で使用できます。
TargetUrl	型 string プロパティ Filter、Nillable、Sort 説明カスタムボタンまたはカスタムリンクで指し示される URL。この項目は、API バージョン 41.0 以降で使用できます。
Type	型 picklist プロパティ Filter、Group、Restricted picklist、Sort 説明アクションの種別。有効な値は、次のとおりです。 `ActionLink` — API、Web ページ、またはファイルを指す、フィード要素上のインジケータで、Salesforce Chatter フィード UI のボタンによって表されます。 `CustomButton` — クリックすると、ウィンドウ内で URL または Visualforce ページが開くか、JavaScript が実行されます。 `InvocableAction` `ProductivityAction` — 生産性アクションは事前定義され、限られたオブジェクトのセットに適用されます。生産性アクションには、[メールを送信]、[電話]、[地図]、[Web サイトを表示]、[ニュースを閲覧] が含まれます。[電話] アクション以外の生産性アクションを編集することはできません。 `QuickAction` — グローバルアクションまたはオブジェクト固有のアクション。 `StandardButton` — 事前定義された Salesforce ボタン ([新規]、[編集]、[削除] など)。

使用方法

PlatformAction は、describeSObjects() を使用して記述できます。

PlatformAction を直接照会することができます。たとえば、次のクエリは、リストされたオブジェクトの各レコードに関連付けられたアクションのすべての項目を返します。

1SELECT ExternalId, ActionTargetType, ActionTargetUrl, ApiName, Category,
2      ConfirmationMessage, ExternalId, GroupId, UiTheme, IconUrl, IconContentType, 
3      IconHeight, IconWidth, PrimaryColor, InvocationStatus, InvokedByUserId, 
4      IsGroupDefault, Label, LastModifiedDate, Subtype, SourceEntity, Type 
5FROM PlatformAction 
6WHERE SourceEntity IN ('001xx000003DGsH', '001xx000003DHBq', ‘Task’) AND 
7      ActionListContext = ‘Record’;

PlatformAction を照会するには、ActionListContext および SourceEntity を指定します。RelatedList の値を使用して ActionListContext を照会するときに RelatedSourceEntity を指定しないと、関連リストの API 名がクエリから返されます。API v43.0 以前では、SOQL クエリ内でクイックアクションを取得するための SourceEntity = 'Object API Name' と ActionListContext = 'ListView' の組み合わせは無効です。代わりに、SourceEntity = 'Object ID' と ActionListContext = 'ListView' を使用してください。

メモ

次のクエリでは、複数の ActionListContext 値を WHERE 句で使用しており、指定されたオブジェクトに対して Lightning Experience ユーザインターフェース (DeviceFormat = 'Desktop') ですべてのアクションが返されます。

1SELECT ActionListContext, Label, Type, Subtype, Section, SourceEntity,
2     RelatedSourceEntity, ActionTarget, ActionTargetType, ApiName, Category, 
3     ConfirmationMessage, DeviceFormat, ExternalId, GroupId, IconContentType, 
4     IconHeight, IconUrl, IconWidth, Id, InvocationStatus, InvokedByUserId, 
5     IsGroupDefault, LastModifiedDate, PrimaryColor 
6FROM PlatformAction 
7WHERE ActionListContext IN ('Record','Chatter','RelatedList') AND 
8      SourceEntity = '001xx000003DlvX' AND 
9      DeviceFormat = 'Desktop'

Salesforce および Lightning プラットフォームのオブジェクトリファレンス

PlatformAction

サポートされているコール

項目

使用方法