スケジュールされたイベントの作成
特定の期間に待機室の動作をカスタマイズしたい場合（例えば、キュー方式の変更や総アクティブユーザー数の増加など）、スケジュールされたイベントを設定します。これはダッシュボードまたはAPIを介して行うことができます。
イベントに設定されたプロパティは、イベントの期間中、待機室のデフォルトプロパティを上書きします。
-
アプリケーション内で、トラフィック > 待機室に移動します。
-
待機室を展開し、イベントをスケジュールを選択します。
-
イベントの詳細をカスタマイズします：イベントに名前を付け、説明を追加（オプション）、開始日時と終了日時を選択します。
-
プレキューイングを有効にすることもできます。この場合、プレキューイング時間を定義する必要があります。また、イベント開始時にシャッフルを選択すると、プレキュー内のすべてのユーザーがイベント開始時にランダムに入場します。
-
次へを選択します。
-
設定セクションで、総アクティブユーザー数、新しいユーザー数（毎分）、セッションの持続時間、セッションの更新、キュー方式の新しい値を定義できます。これらの設定のそれぞれについて、待機室で定義された値を常に継承するオプションもあります。このオプションを選択すると、基本の待機室の設定を変更した場合、対応するイベント設定も更新されます。
-
次へを選択します。
-
カスタマイズセクションで、待機室のテンプレートを常に継承する（デフォルト）か、カスタムイベントテンプレートで上書きするかを選択できます。この場合、自分のテンプレートをインポートする必要があります。続行する前に結果をプレビューしてください。
-
次へを選択し、イベントの詳細と設定を確認します。
-
保存を選択します。
待機室ページの次のイベント列では、スケジュールされた次のイベントの日付を視覚化できます。この列は、その待機室にスケジュールされたイベントがない場合、N/Aと表示されます。イベントを一時停止、編集、または削除することもできます。
イベントを作成するには、必要なパラメータとオプションのパラメータを含むPOSTリクエストを行います。イベントに設定されたプロパティは、イベントの期間中、待機室のデフォルトプロパティを上書きします。
カスタムテンプレートを使用している場合は、テンプレートに関連する変数を追加することをお勧めします（json_response_enabledパラメータの下にリストされています）。
ほとんどのパラメータは通常の待機室と同じですが、イベントを作成する際に特有のものもいくつかあります。イベント設定の完全なリストについては、イベントの作成を参照してください。
name（必須）：英数字、ハイフン、アンダースコアを含む一意の名前。event_start_time（必須）：イベントの開始を示すISO 8601タイムスタンプ。この時点で、キューに入っているユーザーはイベントの設定に従って処理されます。event_end_timeの少なくとも1分前に発生する必要があります。event_end_time（必須）：イベントの終了を示すISO 8601タイムスタンプ。shuffle_at_event_start：trueの場合、prequeue_start_timeがnullでない場合、プレキュー内のユーザーはevent_start_timeでランダムにシャッフルされます。これは、イベントがFIFOキュー方式を使用している場合に公平性を確保するために一般的に使用されます。prequeue_start_time：イベント開始前にすべてのユーザーをキューに入れる開始時刻を示すISO 8601タイムスタンプ。event_start_timeの少なくとも5分前に発生する必要があります。description：イベントに関する詳細を提供するテキスト説明。suspended：trueの場合、イベントは無視され、トラフィックは待機室の通常の設定に基づいて処理されます。
イベントを設定する際、待機室のデフォルトのキュー方式を調整することも考慮するかもしれません。
待機室のキュー方式をパススルーに設定すると、通常通りトラフィックを許可しますが、スケジュールされたイベント中はトラフィックを制限します。
待機室のキュー方式を拒否に設定すると、通常はすべてのトラフィックをブロックしますが、サインアップやチケット販売などの特別なイベント中はトラフィックを許可します。
イベント開始前にキューに入ったすべてのユーザーに報酬を与えるために、“ロッタリー”システムを設定します。
プレキュー期間中にアプリケーションに到達したユーザーは、イベント開始時にランダムに割り当てられます。イベントがFIFO順序を使用している場合、プレキュー期間後にアプリケーションに到達したユーザーは、プレキューのユーザーの後に割り当てられます。
“ロッタリー”を設定するには、APIリクエストに以下のパラメータを含めます：
prequeue_start_timeshuffle_at_event_start
イベントに設定されたプロパティは、イベントの期間中、待機室のデフォルトプロパティを上書きするため、イベントが開始される前にAPIを使用してイベント設定のプレビューを行うべきです。
このコマンドは、イベントがアクティブであるかのようにイベントの設定を表示します。つまり、待機室から継承されたフィールドは現在の値を表示します。
イベントを編集するには、PATCHリクエストを使用します。
suspendedパラメータをtrueに設定することで、イベントを無効にできます。
さらに、待機室自体が無効の場合、イベントはアクティブになりません。
メンテナンスウィンドウの前後にキューなしでスケジュールされたメンテナンスページを展開したい場合は、以下の手順に従ってください。
スケジュールされたイベントが終了した後、ユーザーはサイトにアクセスできるようになります。スケジュールされたイベントが終了する前にメンテナンスウィンドウを終了するには、イベントを無効に設定します。
| 機能 | コマンド |
|---|---|
| イベントの詳細を取得 | GET |
| スケジュールされたイベントのリスト | GET |
| イベントを削除 | DELETE |