RaySheetバージョン16ではプラットフォームイベントAPIはベータ版の機能です。今後のバージョンで正式にサポートする予定です。
このセクションでは、プラットフォームイベントAPIのリファレンスについて詳述しています。
レコード取得イベントはRaySheetの表画面に表示するレコードを取得する際に公開されるイベントです。
| 項目の表示ラベル | API参照名 | データ型 | 補足 |
|---|---|---|---|
| フォルダーID | gcss__FolderId__c | Text(255) | |
| フォルダー名 | gcss__Folder__c | Text(255) | |
| ビューID | gcss__ViewId__c | Text(255) | |
| ビュー名 | gcss__View__c | Text(255) | |
| オブジェクト名 | gcss__Object__c | Text(255) | オブジェクトのAPI参照名です。 |
| SOQL | gcss__SOQL__c | Long Text Area(131072) | レコード取得の過程で使用する複数のSOQLが格納されます。また、SOQLにパラメーターを使用する場合はクエリとパラメーターを分けた形で格納されます。 |
| レコード数 | gcss__RecordNum__c | Number(18、0) | |
| レコードID | gcss__RecordIds__c | Long Text Area(131072) | ・シートモードの場合は最大2,000レコード（１ページに表示されるレコード）のカンマ区切りのレコードIDです。 ・ピボットモードの場合は空白です。 |
| ユーザーID | gcss__UserId__c | Text(255) | |
| ユーザー名 | gcss__User__c | Text(255) | |
| クエリ結果 | gcss__Result__c | Checkbox | |
| エラーメッセージ | gcss__ErrorMessage__c | Long Text Area(131072) |
SOQL例
{
"query": "SELECT ID FROM Account ORDER BY ID LIMIT 1000"
},
{
"ids": "0015j000008FivtAAC,0015j000009udUWAAY,0015j000009udUXAAY,0015j000009udUYAAY,0015j000009udUZAAY,0015j000009udUaAAI,0015j000009udUbAAI,0015j000009udUcAAI",
"query": "SELECT Id,Name,Phone,Site,Type,BillingState,Owner.Name FROM Account WHERE ID IN :ids ORDER BY ID"
},
{
"gReferenceIds": "0035j00000rTBXZAA4,0035j00000ngliXAAQ,0035j0000088Cg8AAE,0035j0000088CgAAAU,0035j0000088CgBAAU,0035j0000088CgDAAU,0035j0000088CgEAAU",
"query": "SELECT Account.Name AccountName,Account.Id AccountId FROM Contact WHERE ID IN :gReferenceIds GROUP BY Account.Name,Account.Id"
}
レコード保存イベントはRaySheetでレコードを保存する際に公開されるイベントです。
| 項目の表示ラベル | API参照名 | データ型 | 補足 |
|---|---|---|---|
| フォルダーID | gcss__FolderId__c | Text(255) | |
| フォルダー名 | gcss__Folder__c | Text(255) | |
| ビューID | gcss__ViewId__c | Text(255) | |
| ビュー名 | gcss__View__c | Text(255) | |
| オブジェクト名 | gcss__Object__c | Text(255) | オブジェクトのAPI参照名です。 |
| 種別 | gcss__Type__c | Text(255) | ・Insert、Update、Deleteのいずれかが格納されます。 ・１回の保存操作でInsertとUpdateの両方が行われる場合は、レコード保存イベントが２つに分けられます。 |
| 保存対象のレコード数 | gcss__RecordNum__c | Number(18、0) | |
| 保存に成功したレコード数 | gcss__SuccessRecordNum__c | Number(18、0) | |
| 保存に失敗したレコード数 | gcss__ErrorRecordNum__c | Number(18、0) | |
| 保存に成功したレコードID | gcss__SuccressRecordIds__c | Long Text Area(131072) | 最大5,000レコードのカンマ区切りのレコードIDです。5,001以上のレコードは切り捨てられます。 |
| 保存に失敗したレコードID | gcss__ErrorRecordIds__c | Long Text Area(131072) | 最大5,000レコードのカンマ区切りのレコードIDです。5,001以上のレコードは切り捨てられます。 |
| ユーザーID | gcss__UserId__c | Text(255) | |
| ユーザー名 | gcss__User__c | Text(255) | |
| エラーメッセージ | gcss__ErrorMessage__c | Long Text Area(131072) |
レコード保存イベントは以下の操作で公開されます。
・「保存」ボタンでの操作や「一括でTODoを追加」アクションなど、「１回の保存操作」で対象となるレコードがレコード保存イベントの対象となります。対象となるレコードとバッチサイズに関連はありません。
・保存イベントはすべてのレコードの保存が終わった後に公開されます。保存処理中に予期せぬエラー（ネットワークエラーなど）が発生した場合、保存イベントは公開されません。この仕様により、保存イベントが公開されていなくても、いくつかのレコードの保存が行われている場合があります。バッチサイズにより保存処理をいくつかに分けている場合にその可能性があります。いくつかのバッチが完了した後に予期せぬエラーが発生した場合は、完了したバッチ分のレコード保存は行われていますが、保存イベントは公開されません。
・「関連オブジェクト項目の編集を許可する」をオンにし、親の関連オブジェクトの項目も更新した場合、保存イベントはメインのオブジェクトと親のオブジェクトの２つ分の保存イベントを公開します。
レコードエクスポートイベントはRaySheetでレコードのエクスポートをする際に公開されるイベントです。
| 項目の表示ラベル | API参照名 | データ型 | 補足 |
|---|---|---|---|
| フォルダーID | gcss__FolderId__c | Text(255) | |
| フォルダー名 | gcss__Folder__c | Text(255) | |
| ビューID | gcss__ViewId__c | Text(255) | |
| ビュー名 | gcss__View__c | Text(255) | |
| オブジェクト名 | gcss__Object__c | Text(255) | オブジェクトのAPI参照名です。 |
| 種別 | gcss__Type__c | Text(255) | Excel、CSVのいずれかが格納されます。 |
| SOQL | gcss__SOQL__c | Long Text Area(131072) | ・レコード取得の過程で使用する複数のSOQLが格納されます。また、SOQLにパラメーターを使用する場合はクエリとパラメーターを分けた形で格納されます。 ・サーバー側（Salesforce側）に問い合わせる必要がない場合（ピボットモードや現在のページで表示されているレコードのみの場合）は空白です。 |
| レコード数 | gcss__RecordNum__c | Number(18、0) | |
| レコードID | gcss__RecordIds__c | Long Text Area(131072) | |
| ユーザーID | gcss__UserId__c | Text(255) | |
| ユーザー名 | gcss__User__c | Text(255) | |
| クエリ結果 | gcss__Result__c | Checkbox | |
| エラーメッセージ | gcss__ErrorMessage__c | Long Text Area(131072) | |
| グループイベントId | gcss__groupEventId__c | Text(255) | |
| サブイベント数 | gcss__totalSubEvent__c | Number(18、0) | |
| サブイベントインデックス | gcss__subEventIndex__c | Text(255) |
レコードエクスポートイベントは「１回のエクスポート操作」を１つのグループとし、ページサイズ単位で分割されます。例えば、ページサイズが100で300レコードをエクスポートする場合、グループイベントIdが同一で、それぞれ異なったサブイベントインデックスを持った３つのイベントが公開されます。