スケジュール済みイベントを作成する

特定の期間だけ Waiting Room の動きをカスタマイズしたい場合（キュー方式の変更や、合計アクティブユーザー数の増加など）は、scheduled event（スケジュール済みイベント）を設定します。ダッシュボードまたは API から行えます。

イベントに設定したプロパティは、イベント期間中、Waiting Room のデフォルトプロパティを上書きします。

1. アプリケーション内で、Traffic > Waiting Room を開きます。

2. Waiting Room を展開し、Schedule event を選びます。

3. イベントの詳細をカスタマイズします。イベントに名前を付け、説明を追加し（任意）、Start Date Time と End Date Time を選びます。

4. 事前キュー（pre-queueing）を有効にすることもできます。この場合は事前キューの時間を定義します。Shuffle at event start を選ぶと、事前キュー内の全ユーザーがイベント開始時にランダムに入場します。

5. Next を選びます。

6. Settings では、Total active users、New users per minute、Session duration、Session Renewal、Queueing Method に新しい値を定義できます。各設定には、Waiting Room で定義した値を常に継承するオプションもあります。このオプションを使うと、ベースの Waiting Room の設定を変更したとき、対応するイベント設定も更新されます。

7. Next を選びます。

8. カスタマイズでは、Always inherit（Waiting Room のテンプレートを常に継承、デフォルト）を選ぶか、Custom Event Template で上書きできます。上書きする場合は、独自のテンプレートをインポートします。続行する前に、結果をプレビューしてください。

9. Next を選び、イベントの詳細と設定を確認します。

10. Save を選びます。

Waiting Room のページの Next Event 列で、次にスケジュールされているイベントの日付を確認できます。その Waiting Room にイベントがない場合、この列は N/A になります。イベントはいつでも一時停止、編集、削除できます。

イベントを作成するには、必須パラメーターと任意パラメーター を含めて POST リクエスト を送ります。イベントに設定したプロパティは、イベント期間中、Waiting Room のデフォルトプロパティを上書きします。

カスタムテンプレート を使っている場合は、テンプレートに 関連する変数 を追加するとよいでしょう（json_response_enabled パラメーターの下に記載されています）。

ほとんどのパラメーターは通常の Waiting Room と同じですが、イベント作成固有のものがいくつかあります。イベント設定の完全な一覧は、Create an Event を参照してください。

• 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 の場合、イベントは無視され、トラフィックは Waiting Room の通常設定で処理されます。

イベントを設定するときは、Waiting Room のデフォルトのキュー方式も調整することがあります。

通常はトラフィックをそのまま通し、スケジュール済みイベント中だけ制限したい場合は、Waiting Room のキュー方式を Passthrough にします。

通常はすべてのトラフィックをブロックし、サインアップやチケット販売などの特別なイベント中だけ許可したい場合は、Waiting Room のキュー方式を Reject にします。

イベント開始前にキューへ入ったすべてのユーザーに機会を与える「抽選」システムを設定します。

事前キュー期間中 にアプリケーションへ到達したユーザーは、イベント開始時に ランダムに 順番が割り当てられます。イベントが FIFO 順 の場合、事前キュー期間後 に到達したユーザーは、事前キューのユーザーの後ろに割り当てられます。

「抽選」を設定するには、API リクエストに 次のパラメーター を含めます。

• prequeue_start_time
• shuffle_at_event_start

イベントに設定した一部のプロパティは、イベント期間中に Waiting Room のデフォルトプロパティを上書きします。そのため、開始前に API で イベント設定をプレビュー してください。

このコマンドは、イベントが有効であるかのように設定を表示します。Waiting Room から継承したフィールドには、現在の値が表示されます。

イベントを編集するには、PATCH リクエスト を使います。

suspended パラメーターを true にすると、イベントを無効にできます。

また、Waiting Room 自体が Disabled の場合、イベントは有効になりません。

メンテナンス時間の前後にキューを作らず、スケジュール済みのメンテナンスページを表示したい場合は、次の手順に従います。

1. Passthrough キュー方式を有効にして Waiting Room を作成 します。
2. この Waiting Room に、Reject キュー方式を有効にした Waiting Room イベントを作成します。

スケジュール済みイベントが終了すると、ユーザーはサイトにアクセスできます。スケジュール済みイベントが終わる前にメンテナンスを終了するには、イベントを無効にします。