応答画面 | メタデータ API 開発者ガイド

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

Prompt コンポーネントにはサフィックス prompt が付けられ、prompts フォルダに保存されます。

バージョン

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

特別なアクセスルール

システム管理者は、プロンプトを追加または編集できます。システム管理者以外のユーザについては、「プロンプトを管理」および「メタデータの変更」ユーザ権限ユーザ権限を割り当てます。すべてのユーザがアプリケーション内ガイダンスの設定ページを表示できます。

プロンプトのパッケージ化

詳細は、Salesforce ヘルプの「管理パッケージの作成」を参照してください。

プロンプトパッケージのインストールと管理、およびパッケージからインストールしたプロンプトの編集とコピーについての詳細は、「Lightning Experience でのプロンプトに関する考慮事項」を参照してください。

プロンプトの未管理パッケージはサポートされていません。

組織でパッケージからプロンプトをインストールすると、プロンプトは IsPublished 項目と同じ公開状態になります。たとえば、パッケージプロンプトが有効な場合、ユーザによるインストールでも有効になります。

インストーラの Salesforce 組織の一部ではないカスタムプロファイルまたは権限がパッケージに含まれている場合は、プロンプトがインストールされますが、このプロンプトには、これらの項目は含まれません。たとえば、組織に含まれていない複数のカスタムプロファイルを含むプロンプトをインストールします。プロンプトはそれらのカスタムプロファイルなしでインストールされます。

インストーラの Salesforce 組織の一部ではない標準アプリケーションがパッケージに含まれている場合は、プロンプトがインストールされますが、このプロンプトを使用することはできません。

項目

項目名	項目の型	説明
masterLabel	string	必須。プロンプトのマスタ表示ラベル。最大 80 文字です。
promptVersions	PromptVersion[]	プロンプトエントリのリスト。各エントリは異なるプロンプトを表します。

PromptVersion

プロンプトエントリのリスト。各エントリは異なるプロンプトを表します。

項目名	項目の型	説明
actionButtonLabel	string	アクションボタンの表示ラベル。最大 25 文字です。
actionButtonLink	string	アクションボタンの URL。最大 1,000 文字です。この項目に対する SOQL クエリでは、`GROUP BY` オプションを使用できません。
body	string	必須。プロンプトの本文コンテンツ。フロート表示プロンプトの場合、最大で 120 文字です。ドッキングプロンプトの場合、最大で 4000 文字です。
customApplication	string	内部的にのみ使用されます。この項目にはデータを入力できません。
delayDays	int	繰り返しがスケジュールされている場合は必須。プロンプトの出現間の日数。
description	string	プロンプトの説明。最大 255 文字です。
dismissButtonLabel	string	フロート表示プロンプトの破棄ボタンの表示ラベル。最大 15 文字です。
displayPosition	PromptDisplayPosition (string 型の列挙)	ページのフロート表示プロンプトの位置を示します。有効な値は、次のとおりです。 `BottomCenter` `BottomLeft` `BottomRight` `TopCenter` `TopLeft` `TopRight`
displayType	PromptDisplayType (string 型の列挙)	必須。プロンプトの種別を示します。有効な値は、次のとおりです。 `DockedComposer` (ドッキングプロンプト) `FloatingPanel` (フロート表示プロンプト)
endDate	date	プロンプトの表示を停止する日付を示します。
header	string	ドッキングプロンプトのヘッダーの表示ラベル。この表示ラベルは、ウィンドウのブラウザバーに表示されます。最大 36 文字です。
indexWithIsPublished	string	クエリを効率的にするために Salesforce が使用します。
indexWithoutIsPublished	string	クエリを効率的にするために Salesforce が使用します。
isPublished	boolean	プロンプトが有効であるか (`true`)、否か (`false`) を示します。
masterLabel	string	必須。プロンプトのマスタ表示ラベル。
publishedByUser	string	内部的にのみ使用されます。この項目にはデータを入力できません。
publishedDate	date	プロンプトが有効化された日付を示します。プロンプトがパッケージの一部である場合、これはパッケージがインストールされた日付です。
shouldDisplayActionButton	boolean	必須。プロンプトにアクションボタンが含まれているか (`true`)、否か (`false`) を示します。
shouldIgnoreGlobalDelay	boolean	プロンプトが、プロンプト間のグローバル遅延時間を無視し、代わりにページの読み込みについて表示するか (`true`)、否か (`false`) を示します。この項目は、API バージョン 48.0 以降で使用できます。
startDate	date	必須。プロンプトの表示を開始する日付を示します。
targetAppDeveloperName	string	必須。プロンプトが表示されるアプリケーションの開発者名。
targetAppNamespacePrefix	string	プロンプトが表示されるアプリケーションの名前空間プレフィックス。
targetPageKey1	string	必須。`targetPageKey2` および `targetPageType` と一緒にプロンプトのページの場所を特定するために Salesforce が使用します。
targetPageKey2	string	`targetPageKey1` および `targetPageType` と一緒にプロンプトのページの場所を特定するために Salesforce が使用します。
targetPageType	string	必須。`targetPageKey1` および `targetPageKey2` と一緒にプロンプトのページの場所を特定するために Salesforce が使用します。
timesToDisplay	int	繰り返しがスケジュールされている場合は必須。プロンプトを表示する回数 (つまり、出現数) の最大数。ユーザによるプロンプトの操作 (または無視) が検出され、プロンプトを再度表示するか、スケジュールされた繰り返しをキャンセルするかが決定されます。これは、スケジュールされた出現数と矛盾する場合もあります。最大値は 30 です。
title	string	必須。プロンプトのタイトルの表示ラベル。最大 36 文字です。
uiFormulaRule	UiFormulaRule	プロンプトをページ上に表示する条件を定義する 1 つ以上の権限の条件のセット。ルールが `true` と評価されると、プロンプトがページに表示されます。`false` の場合は表示されません。この項目が `null` の場合、デフォルトではプロンプトが表示されます。
userAccess	PromptUserAccess (string 型の列挙)	必須。プロンプトが表示される権限を示します。有効な値は、次のとおりです。 `Everyone` (プロンプトを表示できるユーザに権限の制限がないことを示す) `SpecificPermissions` (指定された特定のユーザ権限を持つユーザのみがプロンプトを表示できることを示す)
userProfileAccess	PromptUserProfileAccess (string 型の列挙)	プロンプトが表示されるプロファイルを示します。この項目は、API バージョン 48.0 以降で使用できます。有効な値は、次のとおりです。 `Everyone` (プロンプトを表示できるユーザにプロファイル制限がないことを示す) `SpecificProfiles` (指定されたユーザプロファイルを持つユーザがプロンプトを参照できることを示す)
versionNumber	int	必須。複数のバージョンが組織で保存されないため、数値は `1` のままです。
videoLink	string	ドッキングプロンプトの動画の URL。最大 1,000 文字です。この項目は、API バージョン 48.0 以降で使用できます。動画の埋め込みコードを探すには、動画ホスト Web サイトからの手順に従います。通常、これらの手順は、Web サイトの名前と「埋め込み動画」を検索すると見つかります。たとえば YouTube の場合、埋め込み動画コードは次のようになります。 `<iframe width="560" height="315" src="https://www.youtube.com/embed/Ko-gcObzTVo" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>` 次に、`src` 属性に含まれている URL を入力します。上記の例では、`「https://www.youtube.com/embed/Ko-gcObzTVo」`を入力します。

UiFormulaRule

プロンプトを Lightning ページ上に表示する条件を定義する 1 つ以上の条件のセット。

項目名	項目の型	説明
booleanFilter	string	AND 絞り込み条件を指定します。
criteria	UiFormulaCriterion[]	評価時にプロンプトの表示を決定する 1 つ以上の条件のリスト。

UiFormulaCriterion

評価時に Lightning ページのプロンプトの表示を定義する 1 つの条件。

項目名	項目の型	説明
leftValue	string	必須。条件のベースとなる項目。含むことができるのは標準権限およびカスタム権限のみです。プロンプトの表示に関する条件を設定する場合、leftValue 項目で次の式を使用できます。 `{!$Permission.CustomPermission.permissionName}` — Lightning ページを参照しているユーザのカスタム権限に基づいてプロンプトの表示を制御するには、この式を使用します。アプリケーション、ホーム、およびレコードページでのみサポートされます。 `{!$Permission.StandardPermission.permissionName}` — Lightning ページを参照しているユーザの標準権限に基づいてプロンプトの表示を制御するには、この式を使用します。アプリケーション、ホーム、およびレコードページでのみサポートされます。 `{!ENCODED:{!ID:$User.Profile.Key}}` — Lightning ページを参照しているユーザのカスタムまたは標準プロファイルに基づいてプロンプトの表示を制御するには、この式を使用します。API バージョン 48.0 以降で使用できます。
operator	string	必須。データを絞り込むために使用される演算子を定義します。有効な値は `EQUAL` です。
rightValue	string	権限またはプロファイルの名前の表示を評価するかどうかを指定します。権限には、`true` を使用します。プロファイルには、プロファイルの名前を使用します。API バージョン 48.0 以降で使用できます。たとえば、`Standard` または `custom_regionalsales` です。

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

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

1<?xml version="1.0" encoding="UTF-8"?>
2<Prompt xmlns="http://soap.sforce.com/2006/04/metadata">
3    <masterLabel>Prompt Master Label</masterLabel>
4    <promptVersions>
5        <actionButtonLabel>Learn How</actionButtonLabel>
6        <actionButtonLink>https://trailhead.salesforce.com/en/content/learn/modules/scrum-and-kanban-at-salesforce/learn-about-kanban</actionButtonLink>
7        <body>Explore how the Path and the Kanban view can help you track, manage, and update your records.</body>
8        <delayDays>1</delayDays>
9        <description>Kanban floating prompt</description>
10        <dismissButtonLabel>OK</dismissButtonLabel>
11        <displayPosition>TopLeft</displayPosition>
12        <displayType>FloatingPanel</displayType>
13        <endDate>2019-03-11</endDate>
14        <isPublished>true</isPublished>
15        <masterLabel>Prompt Master Label</masterLabel>
16        <publishedDate>2019-03-11</publishedDate>
17        <shouldDisplayActionButton>false</shouldDisplayActionButton>
18        <shouldIgnoreGlobalDelay>false</shouldIgnoreGlobalDelay>
19        <startDate>2019-03-11</startDate>
20        <targetAppDeveloperName>LightningSales</targetAppDeveloperName>
21        <targetAppNamespacePrefix>standard</targetAppNamespacePrefix>
22        <timesToDisplay>3</timesToDisplay>
23        <title>Get on the Path to Success</title>
24        <userAccess>SpecificPermissions</userAccess>
25        <userProfileAccess>SpecificProfiles</userProfileAccess>
26        <versionNumber>1</versionNumber>
27        <videolink>https://www.youtube.com/embed/Ko-gcObzTVo</videolink>
28        <uiFormulaRule>
29            <booleanFilter>(1 AND 2 AND 3) AND (4 OR 5)</booleanFilter>
30            <criteria>
31                <leftValue>{!$Permission.StandardPermission.ActivitiesAccess}</leftValue>
32                <operator>EQUAL</operator>
33                <rightValue>TRUE</rightValue>
34            </criteria>
35            <criteria>
36                <leftValue>{!$Permission.StandardPermission.ContentWorkspaces}</leftValue>
37                <operator>EQUAL</operator>
38                <rightValue>TRUE</rightValue>
39            </criteria>
40            <criteria>
41                <leftValue>{!$Permission.CustomPermission.MyCustomPerm}</leftValue>
42                <operator>EQUAL</operator>
43                <rightValue>TRUE</rightValue>
44            </criteria>
45            <criteria>
46                <leftValue>{!ENCODED:{!ID:$User.Profile.Key}}</leftValue>
47                <operator>EQUAL</operator>
48                <rightValue>Standard</rightValue>
49            </criteria>
50            <criteria>
51                <leftValue>{!ENCODED:{!ID:$User.Profile.Key}}</leftValue>
52                <operator>EQUAL</operator>
53                <rightValue>custom_mysysadmin</rightValue>
54            </criteria>
55        </uiFormulaRule>
56    </promptVersions>
57</Prompt>

前の定義を参照する 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>Prompt</name>
6    </types>
7    <version>46.0</version>
8</Package>

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

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