Google G Suite Activity Reports REST API プロトコルの FAQ

ご質問がある場合は、 よくあるご質問 (FAQ) と回答を確認して、Google G Suite Activity Reports REST API プロトコルの理解にお役立てください。

イベント遅延オプションの用途を教えてください。

イベント遅延オプションは、イベントが欠落しないようにするために使用されます。 イベントの欠落は、このコンテキストでは、プロトコルがイベントの受信時刻よりも新しい時間フレームに照会範囲を更新した後でイベントが使用可能になったために発生します。 イベントが発生したが Google G Suite Activity Reports REST API にポストされなかった場合、プロトコルがそのイベントの作成時刻に対して照会を行っても、プロトコルはそのイベントを取得しません。

例 1: 次の例は、イベントがどのように失われるのかを示しています。

午後 1 時から午後 1 時 59 分までのイベントを収集するために、プロトコルが午後 2 時に Google G Suite Activity Reports REST API を照会します。 Google G Suite Activity Reports REST API の応答が、Google G Suite Activity Reports REST API で使用可能な午後1 時から午後1 時 59 分までのイベントを返します。 このプロトコルは、すべてのイベントが収集されたものとして動作します。 その後、次の照会を午後 3 時に Google G Suite Activity Reports REST API に送信し、午後 2 時から午後 2 時 59 分の間に発生したイベントを取得します。 このシナリオの問題は、Google G Suite Activity Reports REST API に、午後 1 時から午後 1 時 59 分までに発生したすべてのイベントが含まれているとは限らないことです。 イベントが午後 1 時 58 分に発生した場合、そのイベントは、午後 2 時 3 分まで Google G Suite Activity Reports REST API で使用可能にならない可能性があります。 しかし、このプロトコルは既に午後 1 時から午後 1 時 59 分までの時刻範囲で照会しているため、その時刻範囲を再照会することはできず、重複イベントを取得することはありません。 この遅延は、数時間におよぶ場合もあります。

例 2: 次の例は例 1 を示していますが、このシナリオでは 15 分の遅延が追加されています。

この例では、プロトコルが照会呼び出しを行うときに 15 分の遅延を使用しています。 プロトコルが午後 2 時に Google G Suite Activity Reports REST API に対して照会呼び出しを行い、午後 1 時から午後 1 時 45 分までに発生したイベントを収集します。 このプロトコルは、すべてのイベントが収集されたものとして動作します。 その後、次の照会を午後 3 時に Google G Suite Activity Reports REST API に送信し、午後 1 時 45 分から午後 2 時 45 分の間に発生したすべてのイベントを収集します。 イベントは、例 1 のように欠落せず、次の午後 1 時 45 分から午後 2 時 45 分の間の照会呼び出しで取得されます。

例 3: 次の例は例 2 を示していますが、このシナリオではイベントが翌日に入手可能になります。

イベントが午後 1 時 58 分に発生したが、翌日の午後 1 時 57 分になって初めて Google G Suite Activity Reports REST API がそのイベントを取得可能になった場合、例 2 で設定したイベント遅延では、そのイベントは取得されません。 代わりに、イベント遅延をより大きい値 (この場合は 24 時間) に設定する必要があります。

イベント遅延オプションの仕組みを教えてください。

最後に受信したイベント時刻 から 現在時刻 までを問い合わせるのではなく、このプロトコルでは、最後に受信したイベント時刻 から 現在時刻 - <イベント遅延> までを問い合わせます。イベント遅延は秒単位です。 例えば、15 分 (900 秒) の遅延は、15 分前までのみ照会することを意味します。 この照会は、イベントが欠落せずに入手可能になるように、15 分間を Google G Suite Activity Reports REST API に提供します。 現在時刻 - <イベント遅延> が 最後に受信したイベント時刻 よりも小さい場合、プロトコルは Google G Suite 処理状況レポートの REST API を照会しません。 代わりに、条件が満たされるまで待ってから照会を行います。

イベント遅延オプションにどの値を使用すればよいですか?

Google G Suite Activity Reports REST API では、イベントの取得を遅らせることができます。 イベントが欠落しないようにするために、「イベント遅延 (Event Delay)」パラメーター・オプションの値を 168 時間 (1 週間) に設定できます。 ただし、イベント遅延が大きいほど、結果がリアルタイムでなくなります。 例えば、イベント遅延を 24 時間に設定した場合、イベントは発生直後ではなく、発生から 24 時間後にならないと確認できません。 値は、受け入れ可能なリスクの程度や、リアルタイム・データの重要度によって異なります。 デフォルトの遅延は 2 時間 (7200 秒) です。この場合、設定された値がリアルタイムで提供される一方で、ほとんどのイベントは欠落することがありません。 遅延について詳しくは、 データの保存と遅延時間 (https://support.google.com/a/answer/7061566?hl=en) を参照してください。