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

PromptVersion

アプリケーション内ガイダンスプロンプトまたはウォークスルーを表します。API バージョン 46.0 以降で利用できます。

プロンプトとウォークスルーを使用すれば、アプリケーション内でユーザにお知らせ、トレーニング、またはニュースを表示できます。任意の URL にリンクするアクションボタンまたはリンクの追加を選択します。表示、アクションボタンのクリック、ウォークスルーの完了を追跡します。

可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。コード内の用語を変更すると、現在の実装が壊れる可能性があるため、このオブジェクトの名前は維持しました。

重要

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

create()、delete()、describeSObjects()、query()、retrieve()、update()、upsert()

特別なアクセスルール

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

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

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

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

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

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

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

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

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

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

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

項目

項目	詳細
ActionButtonLabel	型 string プロパティ Create、Filter、Group、Nillable、Sort、Update 説明アクションボタンの表示ラベル。最大 25 文字です。ウォークスルーの場合、この項目は最後のステップでのみ指定できます。
ActionButtonLink	型 url プロパティ Create、Filter、Nillable、Sort、Update 説明アクションボタンの URL。最大 1,000 文字です。この項目に対する SOQL クエリでは、`GROUP BY` オプションを使用できません。ウォークスルーの場合、この項目は最後のステップでのみ指定できます。
Body	型 textarea プロパティ Create、Update 説明本文コンテンツ。フロート表示プロンプトの場合、最大で 240 文字です。ドッキングプロンプトの場合、最大で 4000 文字です。ただし、ドッキングプロンプトではリッチテキストエディタを使用するため、最大文字数は人間が読めるテキストではなく、HTML マークアップの文字数を指します。
DelayDays	型 int プロパティ Create、Filter、Group、Nillable、Sort、Update 説明表示間の日数。ウォークスルーの場合、この項目は最初のステップでのみ指定できます。
Description	型 string プロパティ Create、Filter、Group、Nillable、Sort、Update 説明アプリケーション内ガイダンスの説明。最大 255 文字です。
DismissButtonLabel	型 string プロパティ Create、Filter、Group、Nillable、Sort、Update 説明フロート表示プロンプトの破棄ボタンの表示ラベル。最大 15 文字です。
DisplayPosition	種別 picklist プロパティ Create、Filter、Group、Nillable、Restricted picklist、Sort、Update 説明ページのフロート表示プロンプトの位置を示します。有効な値は、次のとおりです。 `TopLeft` `TopCenter` `TopRight` `MiddleLeft` `MiddleCenter` `MiddleRight` `BottomLeft` `BottomCenter` `BottomRight`
DisplayType	型 picklist プロパティ Create、Filter、Group、Restricted picklist、Sort、Update 説明プロンプトの種別を示します。有効な値は、次のとおりです。 `DockedComposer` — ドッキングプロンプト `FloatingPanel` — フロート表示プロンプト `Targeted` — 対象プロンプト。API バージョン 52.0 以降で利用できます。
ElementRelativePosition	型 picklist プロパティ Create、Filter、Group、Nillable、Restricted picklist、Sort、Update 説明要素に関連するプロンプトの場所を示します。この項目は、API バージョン 52.0 以降で使用できます。有効な値は、次のとおりです。 `BottomCenter` `BottomLeft` `BottomRight` `LeftBottom` `LeftCenter` `LeftTop` `RightBottom` `RightCenter` `RightTop` `TopCenter` `TopLeft` `TopRight`
EndDate	型 date プロパティ Create、Filter、Group、Nillable、Sort、Update 説明アプリケーション内ガイダンスの表示を停止する日付を示します。ウォークスルーの場合、この項目は最初のステップでのみ指定できます。
Header	型 string プロパティ Create、Filter、Group、Nillable、Sort、Update 説明ドッキングプロンプトのヘッダーの表示ラベル。この表示ラベルは、ウィンドウのブラウザバーに表示されます。最大 36 文字です。
ImageAltText	型 string プロパティ Create、Filter、Group、Nillable、Sort、Update 説明画像の代替テキストを示します。`ImageLocation` または `ImageID` が指定されている場合は必須です。
ImageId	型 reference プロパティ Create、Filter、Group、Nillable、Sort、Update 説明画像を保持する ContentAsset の ID。`ImageLocation` または `ImageAltText` が指定されている場合は必須です。これはリレーション項目です。リレーション名 Image リレーション種別 Lookup 参照先 ContentAsset
ImageLocation	型 picklist プロパティ Create、Filter、Group、Nillable、Restricted picklist、Sort、Update 説明本文テキストに関連する画像の場所を示します。`ImageID` または `ImageAltText` が指定されている場合は必須です。有効な値は、次のとおりです。 `Top` `Bottom` `Right` — フロート表示プロンプトの場合のみ `Left` — フロート表示プロンプトの場合のみ
IndexWithIsPublished	型 string プロパティ Filter、idLookup、Nillable、Sort 説明クエリを効率的にするために Salesforce が使用します。
IndexWithoutIsPublished	型 string プロパティ Filter、idLookup、Nillable、Sort 説明クエリを効率的にするために Salesforce が使用します。
IsPublished	型 boolean プロパティ Create、Defaulted on create、Filter、Group、Sort、Update 説明アプリケーション内ガイダンスが有効であるか (`yes`)、否か (`no`) を示します。
MasterLabel	型 string プロパティ Create、Filter、Group、Sort、Update 説明表示ラベル。最大 80 文字です。
ParentId	型 reference プロパティ Create、Filter、Group、Sort 説明アプリケーション内ガイダンスの ID。これはリレーション項目です。リレーション名 Parent リレーション種別 Lookup 参照先 Prompt
PublishedByUserId	型 reference プロパティ Create、Filter、Group、Nillable、Sort、Update 説明アプリケーション内ガイダンスを有効化したユーザの ID。アプリケーション内ガイダンスがパッケージの一部である場合、これはパッケージをインストールしたユーザです。これはリレーション項目です。リレーション名 PublishedByUser リレーション種別 Lookup 参照先 User
PublishedDate	型 date プロパティ Create、Filter、Group、Nillable、Sort、Update 説明アプリケーション内ガイダンスが有効化された日付を示します。アプリケーション内ガイダンスがパッケージの一部である場合、これはパッケージがインストールされた日付です。ウォークスルーの場合、この項目は最初のステップでのみ指定できます。
ReferenceElementContext	型 textarea プロパティ Create、Nillable、Update 説明 Salesforce で、対象プロンプトが関連付けられている要素を特定するために使用されます。この項目は、API バージョン 52.0 以降で使用できます。
ShouldDisplayActionButton	型 boolean プロパティ Create、Defaulted on create、Filter、Group、Sort、Update 説明アプリケーション内ガイダンスにアクションボタンまたはリンクが含まれているか (`yes`)、否か (`no`) を示します。
ShouldIgnoreGlobalDelay	型 boolean プロパティ Create、Defaulted on create、Filter、Group、Sort、Update 説明アプリケーション内ガイダンス間のグローバル時間の遅延をプロンプトで無視し、代わりにページの読み込み時にプロンプトを表示するか (`yes`)、否か (`no`) を示します。デフォルトは `no` です。
StartDate	型 date プロパティ Create、Filter、Group、Nillable、Sort、Update 説明表示を開始する日付を示します。ウォークスルーの場合、この項目は最初のステップでのみ指定できます。
StepNumber	型 int プロパティ Create、Filter、Group、Nillable、Sort、Update 説明ウォークスルーでユーザが表示または操作した最後のステップの番号を示します。最大値は 10 です。
TargetAppDeveloperName	型 string プロパティ Create、Filter、Group、Sort、Update 説明アプリケーション内ガイダンスを表示するアプリケーションの開発者名。API バージョン 51.0 で廃止されました。
TargetAppNamespacePrefix	型 string プロパティ Create、Filter、Group、Nillable、Sort、Update 説明アプリケーション内ガイダンスを表示するアプリケーションの名前空間プレフィックス。パッケージのインストール先の組織にある対象アプリケーションの `NamespacePrefix` に一致する必要があります。最大 15 文字です。API バージョン 51.0 で廃止されました。
TargetPageKey1	型 string プロパティ Create、Filter、Group、Sort、Update 説明必須。Salesforce でページの場所を特定するために `TargetPageKey2`、`TargetPageKey3`、`TargetPageKey4`、および `TargetPageType` と共に使用されます。
TargetPageKey1Ref	型 picklist プロパティ Create、Filter、Group、Nillable、Restricted picklist、Sort、Update 説明 Salesforce でプロンプトのページの場所を特定するために `TargetPageKey2`、`TargetPageKey3`、`TargetPageKey4`、および `TargetPageType` と共に使用されます。
TargetPageKey2	型 string プロパティ Create、Filter、Group、Nillable、Sort、Update 説明 Salesforce でプロンプトのページの場所を特定するために `TargetPageKey1`、`TargetPageKey3`、`TargetPageKey4`、および `TargetPageType` と共に使用されます。
TargetPageKey3	型 string プロパティ Create、Filter、Group、Nillable、Sort、Update 説明 Salesforce でプロンプトのページの場所を特定するために `TargetPageKey1`、`TargetPageKey2`、`TargetPageKey4`、および `TargetPageType` と共に使用されます。
TargetPageKey4	型 string プロパティ Create、Filter、Group、Nillable、Sort、Update 説明 Salesforce でページの場所を特定するために `TargetPageKey1`、`TargetPageKey2`、`TargetPageKey3`、および `TargetPageType` と共に使用されます。この項目は、API バージョン 53.0 以降で使用できます。
TargetPageType	型 string プロパティ Create、Filter、Group、Sort、Update 説明アプリケーション内ガイダンスが表示されるページの種別。
TargetRecordType	型 reference プロパティ Create、Filter、Group、Nillable、Sort、Update 説明 Salesforce でアプリケーション内ガイダンスがレコードタイプに固有であるかどうかを判断するために使用されます。この項目は、API バージョン 52.0 以降で使用できます。リレーション名 TargetRecordType リレーション種別 Lookup 参照先 RecordType
ThemeColor	型 picklist プロパティ Create、Filter、Group、Nillable、Restricted picklist、Sort、Update 説明アプリケーション内ガイダンスに適用するカスタムテーマ色を示します。ThemeSaturation が指定されている場合は必須です。ウォークスルーの最初のステップで指定して、ウォークスルー全体に適用します。有効な値は、次のとおりです。 `Theme1` — 現在のブランドの色から派生 `Theme2` — 現在のページ背景の色から派生 `Theme3` — 現在のグローバルヘッダーの色から派生 `Theme4` — 現在のアプリケーションテーマの色から派生
ThemeSaturation	型 picklist プロパティ Create、Filter、Group、Nillable、Restricted picklist、Sort、Update 説明カスタムテーマ色が適用されたアプリケーション内ガイダンスに適用する色の値 (彩度) を示します。ThemeColor が指定されている場合は必須です。ウォークスルーの最初のステップで指定して、ウォークスルー全体に適用します。有効な値は、次のとおりです。 `Dark` `Light`
TimesToDisplay	型 int プロパティ Create、Filter、Group、Nillable、Sort、Update 説明アプリケーション内ガイダンスを表示する回数 (つまり出現数) の最大数。ユーザによるアプリケーション内ガイダンスの操作 (または無視) が検出され、アプリケーション内ガイダンスを再度表示するか、スケジュールされた繰り返しをキャンセルするかが決定されます。これは、スケジュールされた表示数に反して実行される可能性があります。最大値は 30 です。ウォークスルーの場合、この項目は最初のステップでのみ指定できます。
Title	型 string プロパティ Create、Filter、Group、Sort、Update 説明アプリケーション内ガイダンスのタイトルの表示ラベル。最大 36 文字です。
UserAccess	型 picklist プロパティ Create、Filter、Group、Nillable、Restricted picklist、Sort、Update 説明アプリケーション内ガイダンスが表示される権限を示します。有効な値は、次のとおりです。 `Everyone` — 表示できるユーザに制限はありません。 `SpecificPermissions` — 指定された特定のユーザ権限をすべて持つユーザのみがアプリケーション内ガイダンスを表示できます。
UserProfileAccess	型 picklist プロパティ Create、Filter、Group、Nillable、Restricted picklist、Sort、Update 説明アプリケーション内ガイダンスが表示されるプロファイルを示します。有効な値は、次のとおりです。 `Everyone` — 表示できるユーザに権限の制限はありません。 `SpecificProfiles` — 指定された特定のユーザプロファイルを持つユーザがアプリケーション内ガイダンスを表示できます。
VersionNumber	型 int プロパティ Create、Filter、Group、Sort、Update 説明複数のバージョンが組織で保存されないため、数値は `1` のままです。
VideoLink	型 url プロパティ Create、Filter、Nillable、Sort、Update 説明ドッキングプロンプトでの動画の URL。最大 1,000 文字です。この項目または `ImageId` 項目のみを指定することも、両方とも指定しないこともできます。動画の埋め込みコードを探すには、動画ホスト 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」`を入力します。

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

PromptVersion

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

特別なアクセスルール

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

項目