ユーザー停止設定
- 印刷する
- PDF
ユーザー停止設定
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
当該コンテンツは、ローカリゼーションサービスを準備しております。早急にローカライズサービスをご提供できるよう、努めております。
ユーザーUIDでユーザーを利用停止処理します。
要請
POST 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 |
要請Header
| Header名 | 必須かどうか | 説明 |
|---|---|---|
| x-api-key | O | GamePotで発行する認証key |
| content-type | O | Request body content typeをapplication/jsonに指定 |
| accept-language | X | 使用言語 |
要請Body
| 項目 | タイプ | 必須かどうか | 説明 | 備考 |
|---|---|---|---|---|
| lang | String | O | 利用停止メッセージ言語 | |
| value | String | O | 利用停止事由メッセージ | |
| default | Boolean | O | デフォルト言語設定 デバイスの言語値がmessage Multiにない場合、trueに設定されたメッセージがデフォルトで表示されます。 | true, false |
| startedAt | String | O | 利用停止開始日 | YYYY-MM-DD HH:mm |
| endedAt | String | O | 利用停止終了日 | YYYY-MM-DD HH:mm |
応答
| フィールド名 | タイプ | 説明 |
|---|---|---|
| status | Int | 結果値 (1: 成功) |
| id | String | 利用停止となったID |
例示
要請例
curl --request POST \
--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 'content-type: application/json' \
--header 'x-api-key: 86dcgffae0641745432as02a8801ce5a5475f764fxxxxxxxxx'
--data '{
"messageMulti": [
{
"lang": "ko",
"value": "테스트-ko",
"default": true
}
],
"startedAt": "2020-05-11 12:02",
"endedAt": "2020-05-25 22:00"
}'
応答例
{
"status": 1,
"result": {
"memberBlock": {
"id": "xxxxxxxxxxxxx"
}
}
}
エラーコード
Gamepot Open APIリクエスト時に発生する共通エラーコードです。
| parameter | 説明 |
|---|---|
| status | エラーコード(1: 成功、失敗時Error code参考) |
| message | エラー詳細説明 |
| エラーコード | 説明 |
|---|---|
| -1 | ダッシュボードにないkeyを使用した場合 |
| -2 | ダッシュボードのkeyとheaderのkeyが異なる場合 |
| -3 | ダッシュボードで削除したkeyを使用した場合 |
| -4 | ダッシュボードで未使用に処理されたkeyを使用した場合 |
| -5 | keyが切れた場合 |
| -6 | プロジェクトIDがない場合 |
{
"status": -6,
"message": "projectId was wrong."
}
ユーザー停止設定APIリクエスト時に発生するエラーコードです。
| エラーコード | 説明 |
|---|---|
| -11 | bodyにデータ不足 |
| -12 | messageMulti値がJSON Arrayでない場合 |
| -13 | startedAt 値のフォーマットが正しくない場合、YYYY-MM-DD HH:mm 形態のみ可能 |
| -14 | endedAt 値のフォーマットが正しくない場合、YYYY-MM-DD HH:mm 形態のみ可能 |
| -15 | messageMulti値のデータフォーマットが正しくない場合 |
| -16 | messageMulti値のデータの中にdefaulttrueがないか、複数の場合 |
| -100 | 既に利用停止が設定されたユーザーの場合 |
この記事は役に立ちましたか?