ユーザー停止の照会

Prev Next

ユーザー UIDでユーザーが停止されているか照会します。

リクエスト

GET https://dashboard-api.gamepot.ntruss.com/v1/api/project/{projectId}/user/{userId}/block
項目 タイプ 必須 説明 備考
projectId String O GAMEPOT SDKの projectId
userId String O GAMEPOT SDKの userId

リクエストヘッダ

ヘッダ名 必須 説明
x-api-key O GAMEPOTで発行する認証キー
accept-language X 使用言語

レスポンス

フィールド名 タイプ 説明
status Int 結果値 (1: 成功)
id String ユーザー停止情報に対する ID
member_id String ユーザー ID
deleted Boolean ユーザー停止情報の削除有無 (true: 削除、false: 正常)
type String 利用停止の分類 (manual: 手動、autopurchase: 自動)
status Int 状態 (1: 有効、2: 無効)
message String 利用停止の理由(現在使用されていない)
lang String 利用停止メッセージ言語
value String 利用停止理由のメッセージ
default Boolean 基本言語設定(デバイスの言語値が messageMultiにない場合、trueに設定されたメッセージがデフォルトで表示される)
startedAt String 利用停止の開始日
endedAt String 利用停止の終了日
createdAt Boolean 利用停止の登録日
updatedAt Boolean 利用停止の変更日
deletedAt Boolean 利用停止の削除日
category_id String 利用停止の分類 ID

例

リクエスト例

curl --request GET \
--url https://dashboard-api.gamepot.ntruss.com/v1/api/project/12a0f2ff-xxxx-xxxx-xxxx-9c13ef02f5fs/user/h43ea8e8-xxxx-xxxx-xxxx-531a46d25eef/block \
--header 'accept-language: ko' \
--header 'x-api-key: 86dcgffae0641745432as02a8801ce5a5475f764fxxxxxxxxx'

レスポンス例

{
  "status": 1,
  "result": {
    "id": "xxxxxxxxxxxxxx",
    "member_id": "xxxxxxxxxxxxxx",
    "deleted": false,
    "type": "manual",
    "status": 1,
    "message": null,
    "messageMulti": [
      {
        "lang": "ko",
        "value": "テスト-ko",
        "default": true
      }
    ],
    "startedAt": "Mon May 11 2020 12:02:00 GMT+0900 (GMT+09:00)",
    "endedAt": "Mon May 25 2020 22:00:00 GMT+0900 (GMT+09:00)",
    "createdAt": "Tue May 12 2020 14:06:40 GMT+0900 (GMT+09:00)",
    "updatedAt": "Tue May 12 2020 14:06:40 GMT+0900 (GMT+09:00)",
    "deletedAt": null,
    "category_id": ""
  }
}

エラーコード

Gamepot Open APIをリクエストする際に発生する共通エラーコードです。

パラメータ 説明
status エラーコード(1: 成功、失敗時は Error code参照)
message エラー詳細の説明
エラーコード 説明
-1 ダッシュボードにないキーを使用した場合
-2 ダッシュボードのキーとヘッダのキーが別の場合
-3 ダッシュボードで削除したキーを使用した場合
-4 ダッシュボードで未使用として処理されたキーを使用した場合
-5 キーの期限が切れた場合
-6 プロジェクト IDがない場合 
{
  "status": -6,
  "message": "projectId was wrong."
}