利用停止通知ゲームサーバー登録¶

利用停止ユーザー情報を新規登録または変更する場合、または利用停止を解除する場合に、該当データをゲームサーバーへリアルタイムで自動送信するAPIです。ゲームサーバーはこのAPIを通じてユーザーの利用停止状態の変化を即時に受信し、サービスに反映します。

• データ伝達タイミング: 利用停止ユーザーの情報が新規登録または変更されたとき、および利用停止が解除されたときに、自動でゲームサーバーへ伝達されます。利用停止解除には、管理者が直接解除した場合と利用停止期間が満了した場合の両方が含まれ、どちらの場合もstatusはEで伝達されます。
• データ送信単位: 1回のリクエスト(Request)で最大100件の利用停止ユーザー情報が送信されます。ただし、同一ユーザーの処理順序を保証するためにユーザーを複数のグループに分けて送信するため、対象が多い場合でも常に100件ずつ送信されるとは限りません。リクエスト数と1リクエストあたりの件数は、対象ユーザーの分布によって異なります。

このAPIを使用するには、リクエスト(Request)を受け取れるようにゲームサーバーを準備した後、Hiveコンソール > 認証 > 利用停止 > ゲームサーバー登録でゲームサーバーを登録する必要があります。

リクエストURL¶

リクエストヘッダー¶

リクエスト本文¶

リクエスト例¶

1回のリクエストに含まれるdataは、すべて同じstatusと同じevent_timeを持ちます。異なる状態が1つのリクエストに混在して伝達されることはありません。

期間付き利用停止（B）¶

{
  "game_index": 539,
  "server_url": "{Hiveコンソールに登録したプロジェクトのゲームサーバーURL}",
  "data": [
    {
      "event_time": 1720612623847,
      "player_id": 1,
      "status": "B",
      "start_date": "2024-07-10 20:56:59",
      "end_date": "2024-07-13 20:56:59"
    },
    {
      "event_time": 1720612623847,
      "player_id": 2,
      "status": "B",
      "start_date": "2024-07-10 20:56:59",
      "end_date": "2024-07-13 20:56:59"
    }
  ]
}

永久利用停止（P）¶

{
  "game_index": 539,
  "server_url": "{Hiveコンソールに登録したプロジェクトのゲームサーバーURL}",
  "data": [
    {
      "event_time": 1720612624215,
      "player_id": 3,
      "status": "P",
      "start_date": "2024-07-10 20:56:59",
      "end_date": "9999-12-31 00:00:00"
    },
    {
      "event_time": 1720612624215,
      "player_id": 4,
      "status": "P",
      "start_date": "2024-07-10 20:56:59",
      "end_date": "9999-12-31 00:00:00"
    }
  ]
}

利用停止解除（E）¶

解除された利用停止の期間がそのまま伝達されるため、start_dateとend_dateはユーザーごとに異なる場合があります。

{
  "game_index": 539,
  "server_url": "{Hiveコンソールに登録したプロジェクトのゲームサーバーURL}",
  "data": [
    {
      "event_time": 1720829722391,
      "player_id": 5,
      "status": "E",
      "start_date": "2024-07-01 10:00:00",
      "end_date": "2024-07-08 10:00:00"
    },
    {
      "event_time": 1720829722391,
      "player_id": 6,
      "status": "E",
      "start_date": "2024-07-03 15:30:00",
      "end_date": "9999-12-31 00:00:00"
    }
  ]
}

処理順序を判定する¶

event_timeは、Hiveサーバーが該当情報を発行した時刻をepochミリ秒（1970年1月1日 00:00:00 UTCから経過したミリ秒）で表した値です。たとえば1720612623847はKST基準で2024-07-10 20:57:03.847です。値が大きいほど後に発生した処理であるため、ゲームサーバーはこの値を比較することで、リクエストの到着順序に関係なく最新状態を判定できます。

player_idごとに最後に反映したevent_timeを保存しておき、新しく受信した値と比較して以下のように処理してください。

受信した値が最新状態かどうかを確実に確認する必要がある場合は、ゲーム利用停止ユーザーを確認するAPIで該当ユーザーの現在状態を照会してください。

レスポンス本文¶

ゲームサーバーはリクエストを正常に処理した後、以下の形式で応答する必要があります。

レスポンスコード¶

レスポンス例¶

成功¶

{
  "result_code": 0
}

ゲームサーバー状態確認¶

登録されたゲームサーバーが利用停止ユーザー情報を受信できる状態か確認するため、一定の間隔で状態確認リクエストを送信します。リクエストURL、リクエストヘッダー、リクエスト本文の形式は、実際の利用停止ユーザー情報伝達と同じです。

送信間隔は運用状況に応じて調整される場合があります。そのため、ゲームサーバーは特定の周期を前提として実装してはいけません。リクエストを受信した時点に関係なく、常に正常応答を返せる必要があります。

状態確認リクエストのdataフィールドには、以下のようにplayer_idが1のダミーデータ1件のみが含まれて伝達されます。

• player_id: 1（実際には存在しないダミーID）
• event_time / start_date: 状態確認リクエストを送信した時刻
• 例外処理必須: player_idが1のリクエストは、受信可否だけを確認するためのシグナルです。実際の利用停止ロジックを実行してはならず、処理順序判定の対象からも除外する必要があります。

{
  "game_index": 539,
  "server_url": "{Hiveコンソールに登録したプロジェクトのゲームサーバーURL}",
  "data": [
    {
      "event_time": 1720612623847,
      "player_id": 1,
      "status": "P",
      "start_date": "2024-07-10 20:57:03",
      "end_date": "9999-12-31 00:00:00"
    }
  ]
}

ゲームサーバーは状態確認リクエストにもresult_codeを含むレスポンスを返す必要があります。result_codeの値は確認せず、フィールドが存在するかのみを確認するため、存在しないユーザーと判断して失敗コード（0以外の値）を返しても正常応答として処理されます。