REST API 開発者ガイド
jイベント監視の使用
この例では、REST API イベント監視データを使用しています。このデータに含まれる情報は、組織の利用状況のトレンドとユーザの行動を評価する場合に役立ちます。イベント監視には、EventLogFile オブジェクトを介して Lightning Platform SOAP API および REST API を通じてアクセスします。したがって、自分のバックエンドストレージやデータマートにログデータを統合して、複数の組織や分散されたシステムからのデータを相関することができます。
イベント監視を使用する場合、次の点に留意してください。
- ごくまれに 24 時間ログファイルが生成されないことがありますが、その場合は Salesforce カスタマーサポートにお問い合わせください。
- ログデータは参照専用です。ログデータは挿入、更新、または削除できません。
- EventType 項目を使用して、自分の組織で生成されたファイルを特定します。
- イベントによって、リアルタイムにログデータが生成されます。ただし、1 日ごとのログファイルはイベントが実行された翌日のピーク時間以外に生成されます。そのため、1 日ごとのログファイルデータはイベントが発生してから少なくとも 1 日は使用できません。1 時間ごとのログファイルの場合、イベントの配信時間と最終処理時間によっては、ログファイルでイベントが使用できるようになるまで、3 ～ 6 時間かかることが予想されます。ただし、それより長くかかることもあります。
- ログファイルは、その日またはその時間に ([EventType] 項目に表示される) 少なくとも 1 つの種別の 1 つのイベントが発生した場合に生成されます。イベントが発生していない場合、このファイルは生成されません。
- ログファイルの期限は、CreatedDate から 30 日間 (イベント監視を組織で購入している場合) または 1 日 (Developer Edition 組織の場合) です。
- すべてのイベント監視ログは、EventLogFile オブジェクトを介して API に公開されます。ただし、Event Monitoring Analytics アプリケーションからアクセスする場合を除き、ユーザインターフェースからアクセスすることはできません。
- イベント監視ログファイルは、ユーザアクティビティの記録のシステムではありません。これは信頼できる情報源ですが、永続性はありません。Salesforce サイトの切り替え時、インスタンスの更新時、または計画外のシステム停止時にデータが失われる可能性があります。たとえば、Salesforce が本番組織インスタンスを移動した場合、イベントログファイルのデータにギャップが生じる可能性があります。Salesforce はイベントログファイルのデータの整合性を維持し、データ損失を回避するための商業的に合理的な努力を払っています。Salesforce がサイトの切り替えやインスタンスの更新を実行する場合、自動化プロセスを使用してイベントログを複製します。
- 1 時間ごとのログファイルを見れば、組織で発生した直近のイベントをレビューすることができます。ただし、1 時間ごとのイベントログファイルにはすべてのイベントログが取得されない場合があります。特に、サイト切り替え、インスタンスリフレッシュ、または計画外のシステム停止時にはデータが失われる可能性があります。完全なデータを得るには、1 時間ごとのログファイルを使用してください。
- イベント送信に失敗して回復に時間がかかり過ぎる場合は、ログファイルが必ず 1 回は届くように再送信されます。その結果、これらの潜在的なログファイルではイベントデータが重複することがあります。アプリケーションで潜在的なログファイルが使用されている場合は、重複しているイベント配信がアプリケーションで処理されることを確認します。
- 常に新しいログファイルについて EventLogFile オブジェクトを照会して、潜在的なログを含めるようにすることをお勧めします。新しく作成されたログファイルを識別するには、EventLogFile CreatedDate 項目を使用します。1 時間ごとおよび 1 日ごとの増分ログの配信方法は異なります。詳細は、「1 時間ごとのイベントログと 24 時間のイベントログの違い」を参照してください。
このセクションのすべてのクエリと例には、「イベントログファイルを参照」および「API の有効化」ユーザ権限が必要です。「すべてのデータの参照」権限を持つユーザは、イベント監視データも表示できます。