コンテンツにスキップ

利用停止 API ガイド

あなたの運用ポリシーに従い、Hive サーバーでアカウントを一時停止する機能を提供しています。Hive コンソールで一時停止の種類を事前に登録することで、永久に一時停止されたユーザーと一時停止期間を持つユーザーを区別して登録できます。さらに、すでに登録されているユーザー(PlayerIDで区別)について、一時停止の種類と一時停止期間を変更することができます。

基礎

リクエストURL
  • 本番: https://auth.qpyou.cn/game/block/set
  • サンドボックス: https://sandbox-auth.qpyou.cn/game/block/set
メソッド POST
HTTPヘッダー
  • Content-type: application/json
  • ISCRYPT: 0
レスポンスフォーマット JSON

リクエスト

パラメーター タイプ 必須 説明
appid 文字列 O AppID
player_id 整数 O プレイヤーID
hive_certification_key 文字列 O 認証キー(App Centerから発行されたもの)
status 文字列 O 停止状況
  • `P`: 永久停止
  • `B`: 停止期間のあるユーザー
block_type 整数 O 利用停止タイプ番号
[Hive コンソール > 認証 > 利用停止 > タイプ登録]で事前に登録する必要があります。
start_date 文字列 O 停止開始日
end_date 文字列 O 停止終了日
skip_blocked Boolean X skip_blocked=trueでリクエストすると、既存のブロックデータがすでにある場合、ブロックデータを変更せずにresult_code=0を返します。
did Integer X ゲームアプリのインストール時に生成されるゲームアプリ識別子です。同じ種類のゲームアプリを識別する際に使用します。SDK 初期化時に新規発行された値、または既存の値を受け取って渡すと、該当デバイスのログイン履歴を検証します。

レスポンス

パラメータ タイプ 説明
result_code 整数 結果コード
  • 0: 成功
  • 4000: 無効なパラメータ
    • 停止開始日と終了日の形式が不正な場合
    • 開始日が終了日より後の場合
    • 現在の時間が終了日より後の場合
  • 4002: 認証キーの不一致
  • 4011: 登録されていないタイプ
  • 4013: did ログイン履歴の検証失敗
    • ログアウト状態では検証不可
  • 6000: 無効なappid
result_msg 文字列 停止の原因に関する結果メッセージ

期間制限利用停止登録リクエスト例

期間制限利用停止ユーザーを登録する場合は、statusB に指定し、start_dateend_date をあわせて渡してください。

curl -X POST https://auth.qpyou.cn/game/block/set \
-H 'Content-Type: application/json' \
-H 'ISCRYPT: 0' \
-d '{"appid" : "com.com2us.hivesdk.normal.freefull.apple.global.ios.universal", "player_id" : 24000000000, "hive_certification_key" : "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNjAyMDU2NzI2LCJqdGkiOiIxODczMTExMzIwIn0.3soFiHTPlObCoqR5xX9ZeOQTSvnHrHDHWmopP3QfWtY", "status" : "B", "block_type" : 18, "start_date" : "2024-06-03 00:00:00", "end_date" : "2024-06-30 23:59:59", "skip_blocked" : true, "did" : 2000000}'

期間制限利用停止登録成功レスポンス例

リクエストが正常に処理されると、result_code0result_msgSUCCESS として返されます。

{
"result_code": 0,
"result_msg": "SUCCESS"
}

サスペンションからユーザーを解除する

Hiveサーバーで特定のアカウントを直接停止解除します。

基礎

リクエストURL
  • 本番: https://auth.qpyou.cn/game/block/delete
  • サンドボックス: https://sandbox-auth.qpyou.cn/game/block/delete
メソッド POST
HTTPヘッダー
  • Content-type: application/json
  • ISCRYPT: 0
レスポンスフォーマット JSON

リクエスト

フィールド タイプ 必須 説明
appid 文字列 O AppID
player_id 整数 O PlayerID
hive_certification_key 文字列 O 認証キー(アプリセンターで発行される)

応答

フィールド タイプ 説明
result_code 整数
  • 0: 成功
  • 2002: ユーザーは停止されていません
  • 4000: 無効なパラメータ
  • 4002: 認証キーの不一致
  • 6000: 無効なappid
result_msg 文字列 結果メッセージ

利用停止解除リクエスト例

特定アカウントの利用停止を解除する場合は、以下のリクエスト形式で appidplayer_idhive_certification_key をあわせて渡してください。

curl -X POST https://auth.qpyou.cn/game/block/delete \
-H 'Content-Type: application/json' \
-H 'ISCRYPT: 0' \
-d '{"appid" : "com.com2us.hivesdk.normal.freefull.apple.global.ios.universal", "player_id" : 24000000000, "hive_certification_key" : "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNjAyMDU2NzI2LCJqdGkiOiIxODczMTExMzIwIn0.3soFiHTPlObCoqR5xX9ZeOQTSvnHrHDHWmopP3QfWtY"}'

利用停止解除成功レスポンス例

リクエストが正常に処理されると、result_code0result_msgSUCCESS として返されます。

{
   "result_code": 0,
   "result_msg": "SUCCESS"
}