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

可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。顧客の実装に対する影響を回避するために、一部の用語は変更されていません。

重要

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

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

バージョン

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

特別なアクセスルール

システム管理者は、プロンプトとウォークスルーを追加または編集できます。システム管理者以外のユーザについては、「プロンプトを管理」ユーザ権限を割り当てます。すべてのユーザがアプリケーション内ガイダンスの設定ページを表示できます。ユーザに 4 つ以上のウォークスルーを表示するには、「ウォークスルーを参照」ユーザ権限を使用します。これは「ウォークスルー」権限セットライセンスに含まれています。セールスイネーブルメント (myTrailhead) サブスクリプションにこの機能が含まれています。価格設定についての詳細は、Salesforce アカウントエグゼクティブにお問い合わせください。「プロンプトとウォークスルーのパッケージ化」セクションで作成するウォークスルーのユーザ表示に関する制限に注意してください。

プロンプトとウォークスルーのパッケージ化

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

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

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

Salesforce 組織に含まれていないカスタム権限がパッケージに含まれる場合、インストールは失敗します。

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

未管理パッケージには名前空間プレフィックスを含める必要があります。詳細は、Salesforce ヘルプの「名前空間プレフィックスの登録」および「パッケージをインストールすると自分の名前空間プレフィックスはどうなりますか?」を参照してください。

ウォークスルーパッケージの場合:

管理パッケージまたは未管理パッケージに標準アプリケーションのウォークスルーが含まれる場合、ウォークスルーがインストールされます。ただし、セールスイネーブルメント (myTrailhead) に登録していない場合、本番組織で一度に持つことができる有効なウォークスルーは 3 個のみです。
セキュリティレビューに合格した第一世代管理パッケージにカスタムアプリケーション内のページに 1 つ以上のステップがあるウォークスルーが含まれている場合、ユーザはセールスイネーブルメント (myTrailhead) に登録しなくてもウォークスルーを表示できます。

組織でパッケージからアプリケーション内ガイダンスをインストールすると、アプリケーション内ガイダンスでは IsPublished 項目に示されている公開状態が維持されます。たとえば、パッケージプロンプトが有効な場合、組織によるインストールでも有効になります。

項目

項目名	項目の型	説明
masterLabel	string	必須。表示ラベル。最大 80 文字です。
promptVersions	PromptVersion[]	アプリケーション内ガイダンスのエントリのリスト。各エントリは異なるプロンプトまたはウォークスルーを表します。

PromptVersion

アプリケーション内ガイダンスのエントリのリスト。各エントリは異なるプロンプトまたはウォークスルーを表します。

項目名	項目の型	説明
actionButtonLabel	string	アクションボタンまたはリンクの表示ラベル。最大 25 文字です。ウォークスルーの場合、この項目は最後のステップでのみ指定できます。
actionButtonLink	string	アクションボタンまたはリンクの URL。最大 1,000 文字です。この項目に対する SOQL クエリでは、`GROUP BY` オプションを使用できません。ウォークスルーの場合、この項目は最後のステップでのみ指定できます。
body	string	必須。本文コンテンツ。フロート表示プロンプトの場合、最大で 240 文字です。ドッキングプロンプトの場合、最大で 4000 文字です。ドッキングプロンプトにはリッチテキストエディターが搭載されているため、最大文字数は、判読可能テキストではなく、HTML マークアップがカウントされます。
customApplication	string	内部的にのみ使用されます。この項目にはデータを入力できません。
delayDays	int	繰り返しがスケジュールされている場合は必須。出現間の日数。ウォークスルーの場合、この項目は最初のステップでのみ指定できます。
description	string	説明。最大 255 文字です。
dismissButtonLabel	string	フロート表示プロンプトの破棄ボタンの表示ラベル。最大 15 文字です。
displayPosition	PromptDisplayPosition (string 型の列挙)	ページのフロート表示プロンプトの位置を示します。有効な値は、次のとおりです。 `BottomCenter` `BottomLeft` `BottomRight` `TopCenter` `TopLeft` `TopRight`
displayType	PromptDisplayType (string 型の列挙)	必須。プロンプトの種別を示します。有効な値は、次のとおりです。 `DockedComposer` (ドッキングプロンプト) `FloatingPanel` (フロート表示プロンプト) `Targeted` (対象プロンプト)。API バージョン 52.0 以降で利用できます。
elementRelativePosition	PromptElementRelativePosition (string 型の列挙)	要素に関連するプロンプトの場所を示します。API バージョン 52.0 以降で利用できます。有効な値は、次のとおりです。 `BottomCenter` `BottomLeft` `BottomRight` `LeftBottom` `LeftCenter` `LeftTop` `RightBottom` `RightCenter` `RightTop` `TopCenter` `TopLeft` `TopRight`
endDate	date	アプリケーション内ガイダンスの表示を停止する日付を示します。ウォークスルーの場合、この項目は最初のステップでのみ指定できます。
header	string	ドッキングプロンプトのヘッダーの表示ラベル。この表示ラベルは、ウィンドウのブラウザバーに表示されます。最大 36 文字です。
image	string	画像を保持する contentAsset の API 参照名。この項目または `imageLink` 項目のいずれかを指定できますが、両方指定することはできません。
imageAltText	string	画像を利用しやすくする画像の代替テキストを示します。`imageLocation`、`imageLink`、または `image` が指定されている場合は必須です。
imageLink	string	プロンプトの画像の URL。この項目または image 項目のいずれかを指定できますが、両方指定することはできません。API バージョン 53.0 以降で利用できます。
imageLocation	picklist	本文テキストに関連する画像の場所を示します。`image`、`imageLink`、または `imageAltText` が指定されている場合は必須です。有効な値は、次のとおりです。 `Top` `Bottom` `Right` (フロート表示プロンプトの場合のみ) `Left` (フロート表示プロンプトの場合のみ)
indexWithIsPublished	string	クエリを効率的にするために Salesforce が使用します。
indexWithoutIsPublished	string	クエリを効率的にするために Salesforce が使用します。
isPublished	boolean	有効であるか (`true`)、否か (`false`) を示します。
masterLabel	string	必須。表示ラベル。
publishedByUser	string	内部的にのみ使用されます。この項目にはデータを入力できません。
publishedDate	date	アプリケーション内ガイダンスが有効化された日付を示します。パッケージからインストールした場合、これはパッケージがインストールされた日付です。ウォークスルーの場合、この項目は最初のステップでのみ指定できます。
referenceElementContext	textarea	Salesforce で、対象プロンプトが関連付けられている要素を特定するために使用されます。API バージョン 52.0 以降で利用できます。
shouldDisplayActionButton	boolean	アクションボタンまたはリンクが含まれているか (`true`)、否か (`false`) を示します。
shouldIgnoreGlobalDelay	boolean	アプリケーション内ガイダンスが、グローバル遅延時間を無視し、代わりにページの読み込みについて表示するか (`true`)、否か (`false`) を示します。この項目は、API バージョン 48.0 以降で使用できます。
startDate	date	アプリケーション内ガイダンスの表示を開始する日付を示します。ウォークスルーの場合、この項目は最初のステップでのみ指定できます。 API バージョン 48.0 以前の場合、この項目は必須です。
stepNumber	int	ウォークスルーにのみ必要になります。ウォークスルーでユーザが表示または操作した最後のステップの番号を示します。ステップの最大数は 10 ステップです。番号は、繰り返したり飛んだりすることなく、連続している必要があります。API バージョン 49.0 以降で利用できます。
targetAppDeveloperName	string	アプリケーション内ガイダンスを表示するアプリケーションの開発者名。API バージョン 51.0 以降では使用できなくなりました。
targetAppNamespacePrefix	string	アプリケーション内ガイダンスを表示するアプリケーションの名前空間プレフィックス。パッケージのインストール先の組織にある対象アプリケーションの `NamespacePrefix` に一致する必要があります。最大 15 文字です。API バージョン 51.0 以降では使用できなくなりました。
targetPageKey1	string	必須。Salesforce でプロンプトのページの場所を特定するために `targetPageKey2`、`targetPageKey3`、`targetPageKey4`、および `targetPageType` と共に使用されます。
targetPageKey2	string	Salesforce でプロンプトのページの場所を特定するために `targetPageKey1`、`targetPageKey3`、`targetPageKey4`、および `targetPageType` と共に使用されます。
targetPageKey3	string	Salesforce でプロンプトのページの場所を特定するために `targetPageKey1`、`targetPageKey2`、`targetPageKey4`、および `targetPageType` と共に使用されます。
targetPageKey4	string	Salesforce でプロンプトのページの場所を特定するために `targetPageKey1`、`targetPageKey2`、`TargetPageKey3`、および `targetPageType` と共に使用されます。この項目は、API バージョン 53.0 以降で使用できます。
targetPageType	string	必須。Salesforce でページの場所を特定するために `targetPageKey1`、`targetPageKey2`、`targetPageKey3`、および `targetPageKey4` と共に使用されます。
targetRecordType	string	Salesforce でアプリケーション内ガイダンスがレコードタイプに固有であるかどうかを判断するために使用されます。この項目は、API バージョン 53.0 以降で使用できます。
themeColor	PromptThemeColor (string 型の列挙)	アプリケーション内ガイダンスに適用するカスタムテーマ色を示します。themeSaturation が指定されている場合は必須です。ウォークスルーの最初のステップで指定して、ウォークスルー全体に適用します。有効な値は、次のとおりです。 `Theme1`: 現在のブランドの色から派生 `Theme2`: 現在のページ背景の色から派生 `Theme3`: 現在のグローバルヘッダーの色から派生 `Theme4`: 現在のアプリケーションテーマの色から派生
themeSaturation	PromptThemeSaturation (string 型の列挙)	カスタムテーマ色が適用されたアプリケーション内ガイダンスに適用する色の値 (彩度) を示します。themeColor が指定されている場合は必須です。ウォークスルーの最初のステップで指定して、ウォークスルー全体に適用します。有効な値は、次のとおりです。 `Dark` `Light`
timesToDisplay	int	繰り返しがスケジュールされている場合は必須。アプリケーション内ガイダンスを表示する回数 (つまり出現数) の最大数。ユーザによるアプリケーション内ガイダンスの操作 (または無視) が検出され、アプリケーション内ガイダンスを再度表示するか、スケジュールされた繰り返しをキャンセルするかが決定されます。これは、スケジュールされた出現数と矛盾する場合もあります。最大値は 30 です。ウォークスルーの場合、この項目は最初のステップでのみ指定できます。
title	string	必須。タイトルの表示ラベル。最大 36 文字です。
uiFormulaRule	UiFormulaRule	アプリケーション内ガイダンスをページ上に表示する条件を定義する 1 つ以上の権限の条件のセット。ルールが `true` と評価されると、アプリケーション内ガイダンスがページに表示されます。`false` の場合は表示されません。この項目が `null` の場合、デフォルトではアプリケーション内ガイダンスが表示されます。
userAccess	PromptUserAccess (string 型の列挙)	アプリケーション内ガイダンスが表示される権限を示します。有効な値は、次のとおりです。 `Everyone` (権限の制限がないことを示す) `SpecificPermissions` (指定された特定のユーザ権限を持つユーザのみがアプリケーション内ガイダンスを表示できることを示す) API バージョン 48.0 以前の場合、この項目は必須です。
userProfileAccess	PromptUserProfileAccess (string 型の列挙)	アプリケーション内ガイダンスが表示されるプロファイルを示します。この項目は、API バージョン 48.0 以降で使用できます。有効な値は、次のとおりです。 `Everyone` (プロファイルの制限がないことを示す) `SpecificProfiles` (指定されたユーザプロファイルを持つユーザがアプリケーション内ガイダンスを参照できることを示す)
versionNumber	int	必須。複数のバージョンが組織で保存されないため、数値は `1` のままです。
videoLink	string	ドッキングプロンプトの動画の URL。最大 1,000 文字です。この項目または `image` 項目のいずれかを指定できますが、両方指定することはできません。この項目は、API バージョン 48.0 以降で使用できます。動画の埋め込みコードを探すには、動画ホスト Web サイトからの手順に従います。通常、これらの手順は、Web サイトの名前と「埋め込み動画」を検索すると見つかります。たとえば YouTube の場合、埋め込み動画コードは次のようになります。 `<iframe width="560" height="315" src="https://www.youtube.com/embed/di6iwHhrH6s" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>` 次に、`src` 属性に含まれている URL を入力します。上記の例では、`「https://www.youtube.com/embed/di6iwHhrH6s」`を入力します。

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 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 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 ファイルを使用したメタデータのリリースと取得」を参照してください。