ユーザー利用停止リストの照会

Prev Next

Classic/VPC環境で利用できます。

利用停止されたユーザーリストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /v2/memberblock

リクエストヘッダ

GAMEPOT 3.0 APIで共通して使用されるヘッダの詳細は、GAMEPOT 3.0のリクエストヘッダをご参照ください。

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
filter String Required 絞り込みの条件
  • レスポンスボディの一部のフィールドで絞り込み
  • 完全一致する値のみ絞り込み
  • 条件がない場合、空の値{}を入力
  • <例> {"member_id":"{ユーザー ID}"}、{"status":1}、{"deleted":true}
sort String Optional ソートの基準
  • {基準:方式}形式で入力
    • 基準: レスポンスボディの Stringタイプフィールド
    • 方式: -1 | 1
      • -1: 降順
      • 1: 昇順
  • <例> {"createdAt":"-1"}: 作成日時基準の降順
option String Optional 追加オプション: Option
  • <例> {"offset":0,"per_page":20}: 最初の項目から20個表示

Option

Optionの説明は次の通りです。

フィールド タイプ 必須の有無 説明
offset Integer Optional 照会開始オフセット
  • 0~N
per_page Integer Optional ページごとの項目数
  • 1~100
count Boolean Optional リストの代わりにレスポンス結果数を表示するか
  • true | false
    • true: レスポンス結果数を表示
    • false: リストを表示

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://dashboard-api.gamepot.ntruss.com/v2/memberblock?filter=%7B%22member_id%22%3A%2232e19c61-****-****-****-840c4028aa88%22%7D&sort=%7B%22createdAt%22%3A%22-1%22%7D&option=%7B%22count%22%3Afalse%7D' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project ID}' \
--header 'Accept: application/json'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
id String - 利用停止履歴 ID
member_id String - ユーザー ID
deleted Boolean - 利用停止履歴を削除するか
  • true | false
    • true: 削除
    • false: 削除しない
type String - 利用停止の分類
  • manual | autopurchase
    • manual: 手動
    • autopurchase: 自動
status Integer - 利用停止状態
  • 1 | 2
    • 1: 有効化
    • 2: 無効化(利用停止解除)
message String - 利用停止の理由
  • 現在使用していないため、nullと表示
messageMulti Array - 利用停止理由の多言語情報: messageMulti
startedAt String - 利用停止の開始日時
  • ISO 8601形式
endedAt String - 利用停止の終了日時
  • ISO 8601形式
createdAt String - 利用停止履歴の作成日時
  • ISO 8601形式
updatedAt String - 利用停止履歴の更新日時
  • ISO 8601形式
deletedAt String - 利用停止履歴の削除日時
  • ISO 8601形式
category_id String - 利用停止分類 ID

messageMulti

messageMultiの説明は次の通りです。

フィールド タイプ 必須の有無 説明
lang String - 言語コード
value String - 理由のメッセージ
default Boolean - デフォルト言語かどうか
  • true | false
    • true: デフォルト言語
    • false: デフォルト言語ではない

レスポンスステータスコード

GAMEPOT 3.0 APIで共通して使用されるレスポンスステータスコードの詳細は、GAMEPOT 3.0のレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

[
  {
    "id": "TWVtYmVyQm******************************************NTc4ODQzYjJj",
    "member_id": "32e19c61-****-****-****-840c4028aa88",
    "deleted": false,
    "type": "manual",
    "status": 1,
    "message": null,
    "messageMulti": [
      {
        "lang": "ko",
        "value": "12",
        "default": true
      }
    ],
    "startedAt": "2025-07-23T00:00:00+09:00",
    "endedAt": "2025-07-25T00:00:00+09:00",
    "createdAt": "2025-07-24T15:56:33+09:00",
    "updatedAt": "2025-07-24T15:56:33+09:00",
    "deletedAt": null,
    "category_id": "eade0943-****-****-****-f2b5e9852ce4"
  }
]