クォータと引き換えコード
クォータと引き換えコードは通常どちらか一方のみが有効で、デフォルトはクォータです。デフォルトでは管理者がメンバーにクォータを割り当て、引き換えコードでのチャージは環境で有効化された場合にのみ利用できます。
管理者は、メンバーにクォータ(周期ごとにリセットされる消費上限)を割り当てることも、引き換えコードでメンバーの残高をチャージすることもできます。メンバーのクォータは周期ごとの消費上限を制御し、残高は実際のチャージ分を担います。2 つの仕組みはそれぞれ独立して機能します。
クォータと残高
| 種類 | 発生元 | 使われ方 |
|---|---|---|
| メンバーのクォータ | 管理者が割り当て | ページで提供される周期に従って消費上限を設定し、期限到来時にリセット |
| 残高 | メンバーが引き換えコードでチャージ | チャージ後は実際の消費に応じて差し引かれ、周期でリセットされない |
基本ルール:クォータが不足すると残高にフォールバック
呼び出しはまずメンバーのクォータを消費し、クォータが不足すると残高にフォールバックします。メンバーのクォータが設定されていないメンバーは直接残高を使用します。どちらも今回の呼び出し分を差し引くのに足りない場合にのみ、リクエストが拒否されます。そのため、メンバーのクォータを使い切っても、必ずしも呼び出しが停止するわけではありません。
メンバーのクォータはメンバーごとに独立して適用されます。部署単位での割り当ては、選択した各メンバーに個別にクォータを設定するものであり、部署で共有する残高を作成するものではありません。
API Keys のクォータ制限とメンバーのクォータはそれぞれ別に適用されます。API Key に個別の上限が設定されている場合、メンバーに利用可能なクォータが残っていても、そのキー自体のクォータ不足により呼び出せないことがあります。消費をメンバーのクォータで一元的に管理したい場合は、クォータを個別に制限しない API Key を使用してください。
クォータの管理
部署とメンバーのクォータの確認
Organization → Quotas を開き、管理の目的に応じてビューを切り替えます。
| ビュー | 用途 |
|---|---|
| Department overview | 組織階層ごとにメンバー数、クォータの設定状況、使用状況を確認します |
| Needs attention | 上限に近い、または使い切ったメンバーをまとめて確認します |
| Unconfigured | メンバーのクォータがまだ設定されていないユーザーを探します |
| Configured | クォータルールが設定済みのメンバーを確認します |
| All members | メンバー一覧を表示し、部署やクォータの状態などの条件で絞り込みます |
Department overview の Members の数値は「メンバー総数 / 設定済み人数」の形式で表示され、未設定、上限間近、使い切りの人数と平均使用率もあわせて表示されます。部署に所属していないメンバーは Unassigned department にまとめて表示されます。
メンバー一覧には、クォータ額、リセット周期、次回リセット時刻、使用済みと残りのクォータ、クォータの状態と同期状態が表示されます。検索、所属部署、クォータの状態で対象メンバーを絞り込めます。
| クォータの状態 | 意味 |
|---|---|
| Unconfigured | 有効なメンバーのクォータルールがありません |
| Normal | 使用率が 80% 未満です |
| Near limit | 使用率が 80% に達しているが、100% には達していません |
| Exhausted | 使用率が 100% に達しているか、超えています |
ここでの使用率と残りのクォータはメンバーのクォータに関するもので、残高を表すものではありません。メンバーが部署を異動すると統計上の所属もそれに伴って変わりますが、既存のクォータルールは部署の変更だけでは調整されません。
クォータの割り当て
割り当てる前に、メンバーの OneGateway アカウントが作成済みであることを確認してください。
- Assign quota をクリックして、クォータポリシーのフォームを開きます。
- Select members をクリックし、部署単位で一括選択するか、メンバー単位の個別選択に切り替えます。部署やメンバーは検索できます。
- reset period を選択します。デフォルトは毎月です。選択可能な周期は現在の環境のページ表示に従います。
- quota per member を入力します。0 より大きく、システムが許容する上限以下である必要があります。
- 必要に応じて、クォータの使用率が 80% に達したときのユーザー通知を設定します。
- メンバー数、1 人あたりのクォータ、リセットルールを確認して Save quota をクリックし、各メンバーの同期状態を確認します。
割り当て画面のメンバー選択では、クォータが未設定のメンバーのみが表示されます。既にクォータが設定されているメンバーは、Adjust または Bulk adjust で変更してください。
部署単位で選択した場合、実際の割り当て対象は今回選択されたメンバーです。後から部署に加わったユーザーには、今回のクォータは自動的には付与されません。
一括保存では一部のみ成功することがあります。失敗の詳細が返された場合は、まずどのメンバーが成功したかを確認し、失敗原因に応じて該当メンバーに対処してください。成功したメンバーのクォータを重複して調整しないよう注意してください。
クォータの調整と取り消し
個別のメンバーを調整する:メンバー一覧で Adjust をクリックし、周期、クォータ、通知設定を変更して保存します。フォームにはそのメンバーの現在の設定が表示され、調整中にメンバーを変更することはできません。
一括調整する:対象メンバーにチェックを入れ、表示される Bulk adjust をクリックして、周期、1 人あたりのクォータ、通知オプションを一括で設定します。一括フォームはデフォルト値を使用しており、選択したメンバーの既存の設定が同じであることを示すものではないため、保存前に各項目を確認してください。
クォータを調整すると今周期の使用済み金額がゼロになります
調整を保存すると元の周期が終了して新しい周期が開始され、今周期の使用済み金額はゼロにリセットされ、クォータは新しい設定で再計算されます。現在の調整画面は通知設定の保存にも使用されるため、操作前にこの影響もあわせて考慮してください。
クォータを取り消す:メンバーの行で Cancel quota をクリックして確定すると、そのメンバーの現在のクォータルールが終了し、未設定の状態に戻ります。クォータを取り消しても残高はクリアされません。残高が十分に残っている場合、メンバーは引き続き呼び出しを行える可能性があります。
周期リセットと使用量通知
選択可能な周期は、現在の環境のクォータ設定ページの表示に従います。ページに毎日のオプションが提供されている場合にのみ、毎日のリセットを設定できます。
| リセット周期 | リセット時刻 |
|---|---|
| Weekly | 毎週月曜日 00:00 |
| Monthly | 毎月 1 日 00:00 |
| Daily(ページで提供される場合) | 毎日 00:00 |
リセットはゲートウェイサーバーの実行タイムゾーンで実行され、個人の PC や組織のタイムゾーン設定には左右されません。ページに表示される Next reset の時刻を基準にしてください。
その他のリセット日や時刻を独自に選択することはできません。周期が到来すると使用済みクォータが再計算され、前の周期で未使用だったクォータは次の周期に繰り越されません。
クォータポリシーの user notification は、クォータの使用率が 80% に達したときにメンバーへ通知するかどうかを設定するもので、初回の割り当て時はデフォルトでオンです。通知をオフにしても、メンバーの状態の判定や消費上限は変わりません。
クォータの同期状態の確認
クォータの状態は「どれだけ使ったか」を、同期状態は「設定が正常に配信されて反映されたか」を表します。両者はそれぞれ確認する必要があります。
| 同期状態 | 対処方法 |
|---|---|
| Synced | 設定は正常に配信されています。クォータルールと合わせて結果を確認できます |
| Pushing | 処理の完了を待ってから更新して確認します |
| Push failed | エラー原因を確認して対処した後、Re-push で再試行します |
ページで保存に成功しただけで、クォータが反映されたとは判断しないでください。メンバー一覧の使用済み金額は実際の消費より遅れて反映される場合があります。実際の呼び出し時のクォータチェックはシステムがリアルタイムで行うもので、管理ページの更新には依存しません。
引き換えコードの管理
引き換えコードの作成と配布
引き換えコードの管理権限がある画面から引き換えコード一覧を開き、引き換えコードを新規作成します。主な設定項目は次のとおりです:Amount(1 つの引き換えコードに対応するチャージ額)、Count(1–100)、Expiration(空欄の場合は無期限)、Scope(引き換えコードが有効なメンバーの範囲。作成後は変更できません)。
配布方法に応じて、次の操作を選択します。
- 手動で配布:作成に成功したら、引き換えコードのテキストファイルをダウンロードするか、個々の引き換えコードをコピーして、受け取るメンバーに渡します。
- 部署またはメンバーを指定して配布:通知を有効にし、部署または特定のメンバーを選択します。システムは範囲内で条件を満たすメンバーの人数分の引き換えコードを生成し(1 人につき 1 つ)、設定済みの通知チャネルで配布します。
引き換えコードを生成・送信しても、メンバーがチャージを完了したことにはなりません。メンバー自身が引き換えを行う必要があります。
引き換え結果の確認
引き換えコード一覧で、状態、引き換えたメンバー、引き換え日時を確認し、使用済みかどうかを確認します。メンバーを指定して配布した場合、レコードには受け取るメンバーが事前に関連付けられていることがあるため、メンバー情報があるだけで引き換え成功と判断することはできません。使用済みの状態と実際の引き換え日時をあわせて確認してください。
引き換えに成功すると、金額はメンバーの残高に加算されます。メンバーのクォータが増えることはなく、今周期の使用済み金額がリセットされることもありません。同じ引き換えコードで引き換えに成功できるのは 1 回だけです。
メンバーは引き換えコードでチャージの手順に従って引き換えを行い、自分の残高と最近の引き換え履歴を確認できます。
引き換えコードの管理と整理
| 操作 | 利用シーンと制限 |
|---|---|
| Edit | 未使用の引き換えコードの名前、金額、有効期限を変更します。使用済みの引き換えコードは編集できません |
| Disable | 未使用の引き換えコードの引き換えを一時停止します |
| Enable | 条件を満たす引き換えコードを復元します。使用済みまたは期限切れのコードは、有効化しても再利用できません |
| Delete | 不要になった引き換えコードを削除します。操作前に状態と配布状況を確認してください |
| Clean up invalid codes | 使用済み、無効化済み、期限切れの引き換えコードを一括で整理します |
整理した引き換えコードは復元できませんが、チャージのログは保持されます。