メタデータ API 開発者ガイド
j応答画面
ファイルのサフィックスおよびディレクトリの場所
Prompt コンポーネントにはサフィックス prompt が付けられ、prompts フォルダに保存されます。
バージョン
Prompt コンポーネントは、API バージョン 46.0 以降で使用できます。
特別なアクセスルール
システム管理者は、プロンプトとウォークスルーを追加または編集できます。システム管理者以外のユーザについては、「プロンプトを管理」および「メタデータ API 関数を使用したメタデータを変更」ユーザ権限を割り当てます。すべてのユーザがアプリケーション内ガイダンスの設定ページを表示できます。ユーザにウォークスルーを表示するには、「ウォークスルーを参照」ユーザ権限を使用します。これは「ウォークスルー」権限セットライセンスに含まれています。myTrailhead サブスクリプションにこの機能が含まれています。価格設定についての詳細は、Salesforce アカウントエグゼクティブにお問い合わせください。
プロンプトとウォークスルーのパッケージ化
詳細は、Salesforce ヘルプの「管理パッケージの作成」を参照してください。
プロンプトパッケージのインストールと管理、およびパッケージからインストールしたプロンプトの編集とコピーについての詳細は、「Lightning Experience でのプロンプトに関する考慮事項」を参照してください。
Salesforce 組織に含まれていないカスタムプロファイルまたは権限がパッケージに含まれている場合、アプリケーション内ガイダンスはインストールされますが、それらのカスタム項目は含まれません。たとえば、組織にない複数のカスタムプロファイルを含むプロンプトを組織でインストールした場合、プロンプトはそれらのカスタムプロファイルなしでインストールされます。
Salesforce 組織にない標準アプリケーションがパッケージに含まれている場合、アプリケーション内ガイダンスはインストールされますが、それを使用することはできません。
組織にある標準アプリケーションのウォークスルーがパッケージに含まれている場合、そのウォークスルーはインストールされますが、組織が myTrailhead に登録しているか、30 日間のトライアルを開始しない限り、ユーザには表示されません。ただし、組織が myTrailhead に登録していない場合や、トライアルを開始していない場合、その組織は、少なくとも 1 つのカスタムアプリページにウォークスルーがあるパッケージからユーザにウォークスルーを表示できます。
ウォークスルーは、未管理パッケージ、またはセキュリティが確認されている第一世代管理パッケージにのみ含めることができます。
組織でパッケージからアプリケーション内ガイダンスをインストールすると、アプリケーション内ガイダンスでは 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 型の列挙) | ページのフロート表示プロンプトの位置を示します。有効な値は、次のとおりです。
|
| displayType | PromptDisplayType (string 型の列挙) | 必須。プロンプトの種別を示します。有効な値は、次のとおりです。
|
| 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 | アプリケーション内ガイダンスの表示を開始する日付を示します。ウォークスルーの場合、この項目は最初のステップでのみ指定できます。 API バージョン 48.0 以前の場合、この項目は必須です。 |
| stepNumber | int | ウォークスルーにのみ必要になります。ウォークスルーでユーザが表示または操作した最後のステップの番号を示します。ステップの最大数は 10 ステップです。番号は、繰り返したり飛んだりすることなく、連続している必要があります。API バージョン 49.0 以降で利用できます。 |
| targetAppDeveloperName | string | 必須。アプリケーション内ガイダンスを表示するアプリケーションの開発者名。 |
| targetAppNamespacePrefix | string | アプリケーション内ガイダンスを表示するアプリケーションの名前空間プレフィックス。 |
| targetPageKey1 | string | 必須。Salesforce でページの場所を特定するために targetPageKey2 および targetPageType と共に使用されます。 |
| targetPageKey2 | string | Salesforce でページの場所を特定するために targetPageKey1 および targetPageType と共に使用されます。 |
| targetPageType | string | 必須。Salesforce でページの場所を特定するために targetPageKey1 および targetPageKey2 と共に使用されます。 |
| timesToDisplay | int | 繰り返しがスケジュールされている場合は必須。アプリケーション内ガイダンスを表示する回数 (つまり出現数) の最大数。ユーザによるアプリケーション内ガイダンスの操作 (または無視) が検出され、アプリケーション内ガイダンスを再度表示するか、スケジュールされた繰り返しをキャンセルするかが決定されます。これは、スケジュールされた出現数と矛盾する場合もあります。最大値は 30 です。ウォークスルーの場合、この項目は最初のステップでのみ指定できます。 |
| title | string | 必須。タイトルの表示ラベル。最大 36 文字です。 |
| uiFormulaRule | UiFormulaRule | アプリケーション内ガイダンスをページ上に表示する条件を定義する 1 つ以上の権限の条件のセット。 ルールが true と評価されると、アプリケーション内ガイダンスがページに表示されます。false の場合は表示されません。この項目が null の場合、デフォルトではアプリケーション内ガイダンスが表示されます。 |
| userAccess | PromptUserAccess (string 型の列挙) | アプリケーション内ガイダンスが表示される権限を示します。有効な値は、次のとおりです。
API バージョン 48.0 以前の場合、この項目は必須です。 |
| userProfileAccess | PromptUserProfileAccess (string 型の列挙) | アプリケーション内ガイダンスが表示されるプロファイルを示します。この項目は、API バージョン 48.0 以降で使用できます。有効な値は、次のとおりです。
|
| 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 項目で次の式を使用できます。
|
| operator | string | 必須。データを絞り込むために使用される演算子を定義します。有効な値は EQUAL です。 |
| rightValue | string | 権限またはプロファイルの名前の表示を評価するかどうかを指定します。
|
マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。