当該コンテンツは、ローカリゼーションサービスを準備しております。早急にローカライズサービスをご提供できるよう、努めております。
一般クーポンの使用履歴を照会します。
キーワードクーポン使用履歴は照会されません。
要請
GET https://dashboard-api.gamepot.ntruss.com/v1/api/project/{projectId}/coupon/{couponNumber}
| 項目 |
タイプ |
必須かどうか |
説明 |
備考 |
| projectId |
String |
O |
GamePot SDKの projectId |
|
| couponNumber |
String |
O |
ダッシュボードで発行されたクーポン番号 |
|
要請 Header
| Header名 |
必須かどうか |
説明 |
| x-api-key |
O |
GamePotで発行する認証key |
| accept-language |
X |
使用言語 |
応答
| フィールド名 |
タイプ |
説明 |
| status |
Int |
結果値 (1: 成功) |
| id |
String |
クーポン使用履歴ID |
| status |
Boolean |
クーポンの使用可否(true: 使用, false: 未使用) |
| enable |
Int |
使用可否 |
| number |
String |
クーポン番号 |
| userdata |
String |
クーポン使用ユーザー情報 |
| usedAt |
String |
クーポン使用日 |
| request |
String |
クーポン券の使用要請 |
| response |
String |
クーポン応答 |
| (coupon_idの) id |
String |
クーポンID |
| (coupon_idの) enable |
int |
使用可否 |
| type |
String |
クーポン タイプ |
| keyword |
String |
キーワード クーポン キーワード |
| desc |
String |
クーポン名 |
| used |
int |
クーポンの状態 |
| count |
int |
クーポン数量 |
| length |
int |
クーポンの長さ |
| limit |
String |
アイテム数量 |
| prefix |
String |
クーポン接尾辞 |
| suffix |
String |
クーポン接頭辞 |
| store_id |
String |
ストア アイディ (google,one,apple,galaxy) |
| startedAt |
String |
クーポン使用開始日 |
| endedAt |
String |
クーポン使用終了日 |
| item_id |
String |
アイテムID |
| store_item_id |
String |
アイテム ストア ID |
| count |
int |
アイテム数量 |
例示
要請例
curl --request GET \
--url https://dashboard-api.gamepot.ntruss.com/v1/api/project/12a0f2ff-xxxx-xxxx-xxxx-9c13ef02f5fs/coupon/xxxxxx \
--header 'accept-language: ko' \
--header 'x-api-key: 86dcgffae0641745432as02a8801ce5a5475f764fxxxxxxxxx'
応答例
{
"status": 1,
"result": {
"id": "xxxxxxxxxxxxxxxx",
"status": false,
"enable": 1,
"number": "xxxxxxxxxxxxxxxx",
"userdata": "",
"usedAt": null,
"createdAt": "Wed May 13 2020 12:12:04 GMT+0900 (Korean Standard Time)",
"request": null,
"response": null,
"coupon_id": {
"id": "xxxxxxxxxxxxxxxx",
"enable": 1,
"type": "normal",
"keyword": null,
"desc": "시즌2 업데이트 사전예약 보상",
"used": 1,
"count": 2010,
"length": 7,
"limit": null,
"prefix": "",
"suffix": "",
"store_id": "",
"startedAt": "Sun May 10 2020 16:35:00 GMT+0900 (Korean Standard Time)",
"endedAt": "Sat May 23 2020 16:35:00 GMT+0900 (Korean Standard Time)",
"items": [
{
"item_id": "xxxxxxxxxxxxxxxx",
"store_item_id": "xxxxxxxxxxxxxxxx",
"count": 10
},
{
"item_id": "xxxxxxxxxxxxxxxx",
"store_item_id": "xxxxxxxxxxxxxxxx",
"count": 1
}
]
}
}
}
エラーコード
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."
}