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

PromptVersion

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

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

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

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

特別なアクセスルール

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

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

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

Developer Edition 組織で管理パッケージを作成するには、最初に組織の名前空間プレフィックスを設定します。名前空間プレフィックスがない場合、プロンプトを作成できません。

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

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

項目

項目 詳細
ActionButtonLabel
型
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
アクションボタンの表示ラベル。最大 25 文字です。
ActionButtonLink
型
url
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
アクションボタンの URL。最大 1,000 文字です。この項目に対する SOQL クエリでは、GROUP BY オプションを使用できません。
Body
型
textarea
プロパティ
Create、Update
説明
プロンプトの本文コンテンツ。フロート表示プロンプトの場合、最大で 120 文字です。ドッキングプロンプトの場合、最大で 4000 文字です。
DelayDays
型
int
プロパティ
Create、Filter、Group、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
  • BottomLeft
  • BottomCenter
  • BottomRight
DisplayType
型
picklist
プロパティ
Create、Filter、Group、Restricted picklist、Sort、Update
説明
プロンプトの種別を示します。有効な値は、次のとおりです。
  • DockedComposer (ドッキングプロンプト)
  • FloatingPanel (フロート表示プロンプト)
EndDate
型
date
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
プロンプトの表示を停止する日付を示します。
Header
型
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
ドッキングプロンプトのヘッダーの表示ラベル。この表示ラベルは、ウィンドウのブラウザバーに表示されます。最大 36 文字です。
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、Update
説明
プロンプトの ID。
PublishedByUserId
型
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
プロンプトを有効化したユーザの ID。プロンプトがパッケージの一部���ある場合、これはパッケージをインストールしたユーザです。
PublishedDate
型
date
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
プロンプトが有効化された日付を示します。プロンプトがパッケージの一部である場合、これはパッケージがインストールされた日付です。
ShouldDisplayActionButton
型
boolean
プロパティ
Create、Defaulted on create、Filter、Group、Sort、Update
説明
プロンプトにアクションボタンが含まれているか (yes)、否か (no) を示します。
StartDate
型
date
プロパティ
Create、Filter、Group、Sort、Update
説明
プロンプトの表示を開始する日付を示します。
TargetAppDeveloperName
型
string
プロパティ
Create、Filter、Group、Sort、Update
説明
プロンプトが表示されるアプリケーションの 開発者名。
TargetAppNamespacePrefix
型
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
プロンプトが表示されるアプリケーションの名前空間プレフィックス。最大 15 文字です。
TargetPageKey1
型
string
プロパティ
Create、Filter、Group、Sort、Update
説明
targetPageKey2 および targetPageType と一緒にプロンプトのページの場所を特定するために Salesforce が使用します。
TargetPageKey2
型
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
targetPageKey1 および targetPageType と一緒にプロンプトのページの場所を特定するために Salesforce が使用します。
TargetPageType
型
string
プロパティ
Create、Filter、Group、Sort、Update
説明
プロンプトが表示されるページの種別。
TimesToDisplay
型
int
プロパティ
Create、Filter、Group、Sort、Update
説明
プロンプトを表示する回数 (つまり、出現数) の最大数。ユーザによるプロンプトの操作 (または無視) が検出され、プロンプトを再度表示するか、スケジュールされた繰り返しをキャンセルするかが決定されます。これは、スケジュールされた表示数に反して実行される可能性があります。最大値は 30 です。
Title
型
string
プロパティ
Create、Filter、Group、Sort、Update
説明
プロンプトのタイトルの表示ラベル。最大 36 文字です。
UserAccess
型
picklist
プロパティ
Create、Filter、Group、Restricted picklist、Sort、Update
説明
プロンプトが表示されるユーザを示します。有効な値は、次のとおりです。
  • Everyone (プロンプトを表示できるユーザに制限がないことを示す)
  • Specific Permissions (指定された特定のユーザ権限を持つユーザのみがプロンプトを表示できることを示す)

特定の権限でのみ表示されるプロンプトを見るには、「設定・定義を参照する」権限が必要です。全員を対象としたプロンプトは、このユーザ権限がなくても見ることができます。

VersionNumber
型
int
プロパティ
Create、Filter、Group、Sort、Update
説明
複数のバージョンが組織で保存されないため、数値は 1 のままです。