Platform Events Developer Guide (プラットフォームイベント開発者ガイド)
jプラットフォームイベント項目
Salesforce Classic または Lightning Experience でプラットフォームイベントを定義する手順は、次のとおりです。
- [設定] から、[クイック検索] ボックスに「プラットフォームイベント」と入力し、[プラットフォームイベント] を選択します。
- [プラットフォームイベント] ページで [新規プラットフォームイベント] をクリックします。
- 標準項目を入力し、必要に応じて説明を追加します。
- [イベント種別] で [標準量] を選択します。
- [保存] をクリックします。
- 項目を追加するには、[カスタム項目 & リレーション] 関連リストで [新規] をクリックします。
- カスタム項目ウィザードに従って、項目プロパティを設定します。
標準項目
プラットフォームイベントには標準項目が含まれます。この項目は [新規プラットフォームイベント] ページに表示されます。
| 項目 | 説明 |
|---|---|
| 表示ラベル | ユーザインターフェースページでプラットフォームイベントを参照するために使用する名前。 |
| 表示ラベル (複数形) | プラットフォームイベントの名前 (複数形)。 |
| 母音で始まる場合はチェック | 組織のデフォルト言語に該当している場合、表示ラベルが「a」ではなく「an」から始まるかどうかを示します。 |
| オブジェクト名 | API を使用する場合にプラットフォームイベントを参照するために使用する一意の名前。管理パッケージでは、この名前により、複数のパッケージインストールでの名前の競合が回避されます。英数字文字とアンダースコアのみを使用します。名前は文字で始まる必要があり、空白を含むことはできません。名前には、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。 |
| 説明 | オブジェクトの説明 (省略可能)。 |
| リリース状況 | プラットフォームイベントを他のユーザに表示するかどうかを示します。 |
カスタム項目
標準項目に加えて、カスタム項目を追加してイベントをカスタマイズします。プラットフォームイベントのカスタム項目では、次のデータ型のみがサポートされます。
- チェックボックス
- 日付
- 日付/時間
- 数値
- テキスト
- ロングテキストエリア
ReplayId システム項目
各イベントメッセージに、ReplayId 項目に含まれる不透明 ID が割り当てられます。ReplayId 項目値は、イベントが登録者に配信されるときにシステムによって入力され、イベントストリーム内のイベントの位置を参照します。連続するイベントに対して再生 ID の値に連番が振られるという保証はありません。たとえば、ID 999 のイベントの次のイベントの ID が 1,025 になることもあり得ます。登録者は再生 ID の値を保存し、再登録時にその値を使用して、保持ウィンドウ内のイベントを取得できます。たとえば、登録者は、接続に失敗した後、欠落したイベントを取得できます。ただし、登録者は、保存した再生 ID に基づいて新しい再生 ID を計算し、システム内の他のイベントを参照することはできません。
プラットフォームイベント用 API 参照名サフィックス
プラットフォームイベントを作成すると、システムは __e サフィックスを追加してイベントの API 参照名を作成します。たとえば、オブジェクト名 Low Ink (低インクレベル) を使用してイベントを作成した場合、API 参照名は Low_Ink__e になります。プログラムを使用して、たとえば、API 内でイベントを参照する場合、この API 参照名が使用されます。