リーダーボード API
リーダーボードユーザースコア登録 API
Request
- Method : POST
- URI : https://gamepot.apigw.ntruss.com/gpapps/v2/leaderboardlogs
Header | Type | Required | Description |
---|
X-API-KEY | String | O | GAMEPOTで発行する認証キー |
X-PROJECT-ID | String | O | ダッシュボードプロジェクト ID |
Attribute | Type | Required | Description |
---|
leaderboardId | String | O | ダッシュボードで作成したリーダーボード固有 ID |
userId | String | O | ユーザー ID |
score | Integer | X | スコア |
subscore | Integer | X | サブスコア(必須でない) |
metadata | String | X | 追加情報 |
Response
成功
Attribute | Type | Description |
---|
status | Int | 結果値 (-1 失敗) |
message | String | エラーメッセージ |
leaderboardlog.project_id | String | プロジェクト ID |
leaderboardlog.id | String | 入力 ID |
leaderboardlog.user_id | String | ユーザー ID |
leaderboardlog.score | Int | スコア |
leaderboardlog.subscore | Int | サブスコア |
leaderboardlog.metadata | Int | ユーザー定義データ |
leaderboardlog.expiredAt | String | 満了日 |
失敗
Attribute | Type | Description |
---|
code | Int | 結果値 (1: 成功、失敗時 Error code参照) |
error | String | エラー内容 |
リーダーボードユーザースコア取得 API
Request
- Method : GET
- URI : https://gamepot.apigw.ntruss.com/gpapps/v2/leaderboardlogs
Header | Type | Required | Description |
---|
X-API-KEY | String | O | GAMEPOTで発行する認証キー |
X-PROJECT-ID | String | O | ダッシュボードプロジェクト ID |
Attribute | Type | Required | Description |
---|
leaderboardId | String | O | ダッシュボードで作成したリーダーボード固有 ID |
offset | Integer | X | OFFSET |
per_page | Integer | X | LIMIT |
Response
成功
Attribute | Type | Description |
---|
status | Int | 結果値 (-1 失敗) |
message | String | エラーメッセージ |
rank | Int | ランキング |
project_id | String | プロジェクト ID |
leaderboardId | String | ダッシュボードで作成したリーダーボード固有 ID |
user_id | String | ユーザー ID |
score | Int | スコア |
subscore | Int | サブスコア |
metadata | Int | ユーザー定義データ |
updatedAt | String | アップデート日 |
expiredAt | String | 満了日 |
失敗
Attribute | Type | Description |
---|
status | Int | 結果値 (失敗時 Error code参照) |
message | String | エラー内容 |
特定の検索キーワードを利用したスコア取得 API
Request
- Method : GET
- URI : https://gamepot.apigw.ntruss.com/gpapps/v2/leaderboardlogs
IDによる検索方法
SCORE範囲による検索方法
Header | Type | Required | Description |
---|
X-API-KEY | String | O | GAMEPOTで発行する認証キー |
X-PROJECT-ID | String | O | ダッシュボードプロジェクト ID |
Attribute | Type | Required | Description |
---|
leaderboardId | String | O | ダッシュボードで作成したリーダーボード固有 ID |
offset | Integer | X | OFFSET |
per_page | Integer | X | LIMIT |
Response
成功
失敗
Attribute | Type | Description |
---|
status | Int | 結果値 (失敗時 Error code参照) |
message | String | エラー内容 |
リーダーボード情報およびユーザー数取得 API
Request
- Method : GET
- URI : https://gamepot.apigw.ntruss.com/gpapps/v2/leaderboards?/{leaderboardId}?offset=0&per_page=10
Header | Type | Required | Description |
---|
X-API-KEY | String | O | GAMEPOTで発行する認証キー |
X-PROJECT-ID | String | O | ダッシュボードプロジェクト ID |
Attribute | Type | Required | Description |
---|
leaderboardId | String | O | ダッシュボードで作成したリーダーボード固有 ID |
offset | Integer | X | OFFSET |
per_page | Integer | X | LIMIT |
Response
成功
Attribute | Type | Required | Description |
---|
id | String | O | リーダーボード固有 ID |
projectId | String | O | プロジェクト ID |
status | Boolean | O | 状態 |
is_check_user | Boolean | X | ユーザー IDチェックの有無 |
name | String | X | リーダーボード名 |
description | String | X | 説明 |
icon_url | String | X | アイコン URL |
descending | Boolean | X | ソート |
startedAt | String | X | 開始日 |
expiredAt | String | X | 終了日(seasonの場合) |
timezone | String | X | タイムゾーン |
period_type | String | X | 周期(daily、weekly、monthly、season) |
resetDay | Integer | X | 初期化曜日1: 日曜日、2. 月曜日、3. 火曜日、4. 水曜日、5. 木曜日、6. 金曜日、7. 土曜日(periodTypeが weeklyの場合) |
resetTime | String | X | 初期化時間 |
resetDate | Integer | X | 初期化日1~31(periodTypeが monthlyの場合) |
ranking | String | O | ランキングアップデート基準(latest、accumulated、best) |
tie_breaking | String | O | 同点者処理基準(first、last) |
失敗
Attribute | Type | Description |
---|
status | Int | 結果値 (失敗時 Error code参照) |
message | String | エラー内容 |
リーダーボードでユーザースコア照会 API
Request
- Method : GET
- URI : https://gamepot.apigw.ntruss.com/gpapps/v2/leaderboard/{leaderboardID}/user{userid}
Header | Type | Required | Description |
---|
X-API-KEY | String | O | GAMEPOTで発行する認証キー |
X-PROJECT-ID | String | O | ダッシュボードプロジェクト ID |
Attribute | Type | Required | Description |
---|
leaderboardID | String | O | ダッシュボードで作成したリーダーボード固有 ID |
userid | String | O | ユーザー ID |
Response
成功
Attribute | Type | Description |
---|
status | Int | 結果値 (-1 失敗) |
message | String | エラーメッセージ |
rank | Int | ランキング |
project_id | String | プロジェクト ID |
leaderboardId | String | ダッシュボードで作成したリーダーボード固有 ID |
user_id | String | ユーザー ID |
score | Int | スコア |
subscore | Int | サブスコア |
metadata | Int | ユーザー定義データ |
updatedAt | String | アップデート日 |
expiredAt | String | 満了日 |
失敗
Attribute | Type | Description |
---|
status | Int | 結果値 (失敗時 Error code参照) |
message | String | エラー内容 |
リーダーボード登録ユーザー削除 API
Request
- Method : DELETE
- URI : https://gamepot.apigw.ntruss.com/gpapps/v2/leaderboardlogs
Header | Type | Required | Description |
---|
X-API-KEY | String | O | GAMEPOTで発行する認証キー |
X-PROJECT-ID | String | O | ダッシュボードプロジェクト ID |
Attribute | Type | Required | Description |
---|
leaderboardId | String | X | リーダーボード ID |
userId | String | X | リーダーボードユーザー ID |
Response
成功
Attribute | Type | Description |
---|
status | Int | 結果値 (-1 失敗) |
message | String | エラーメッセージ |
project_id | String | プロジェクト ID |
leaderboardId | String | ダッシュボードで作成したリーダーボード固有 ID |
user_id | String | ユーザー ID |
score | Int | スコア |
subscore | Int | サブスコア |
metadata | Int | ユーザー定義データ |
updatedAt | String | アップデート日 |
expiredAt | String | 満了日 |
失敗
Attribute | Type | Description |
---|
status | Int | 結果値 (失敗時 Error code参照) |
message | String | エラー内容 |
リーダーボード登録 API
Request
- Method : POST
- URI : https://gamepot.apigw.ntruss.com/gpapps/v2/leaderboards
Header | Type | Required | Description |
---|
X-API-KEY | String | O | GAMEPOTで発行する認証キー |
X-PROJECT-ID | String | O | ダッシュボードプロジェクト ID |
Attribute | Type | Required | Description |
---|
id | String | O | リーダーボード固有 ID |
projectId | String | O | プロジェクト ID |
status | Boolean | O | 状態 |
is_check_user | Boolean | X | ユーザー IDチェックの有無 |
name | String | X | リーダーボード名 |
description | String | X | 説明 |
iconUrl | String | X | アイコン URL |
descending | Boolean | X | ソート |
startedAt | String | X | 開始日 |
expiredAt | String | X | 終了日(seasonの場合) |
timezone | String | X | タイムゾーン |
period_type | String | X | 周期(daily、weekly、monthly、season) |
resetDay | Integer | X | 初期化曜日1: 日曜日、2. 月曜日、3. 火曜日、4. 水曜日、5. 木曜日、6. 金曜日、7. 土曜日(periodTypeが weeklyの場合) |
resetTime | String | X | 初期化時間 |
resetDate | Integer | X | 初期化日1~31(periodTypeが monthlyの場合) |
ranking | String | O | ランキングアップデート基準(latest、accumulated、best) |
tie_breaking | String | O | 同点者処理基準(first、last) |
Response
成功
Attribute | Type | Required | Description |
---|
id | String | O | リーダーボード固有 ID |
projectId | String | O | プロジェクト ID |
status | Boolean | O | 状態 |
is_check_user | Boolean | X | ユーザー IDチェックの有無 |
name | String | X | リーダーボード名 |
description | String | X | 説明 |
icon_url | String | X | アイコン URL |
descending | Boolean | X | ソート |
startedAt | String | X | 開始日 |
expiredAt | String | X | 終了日(seasonの場合) |
timezone | String | X | タイムゾーン |
period_type | String | X | 周期(daily、weekly、monthly、season) |
resetDay | Integer | X | 初期化曜日1: 日曜日、2. 月曜日、3. 火曜日、4. 水曜日、5. 木曜日、6. 金曜日、7. 土曜日(periodTypeが weeklyの場合) |
resetTime | String | X | 初期化時間 |
resetDate | Integer | X | 初期化日1~31(periodTypeが monthlyの場合) |
ranking | String | O | ランキングアップデート基準(latest、accumulated、best) |
tie_breaking | String | O | 同点者処理基準(first、last) |
失敗
Attribute | Type | Description |
---|
code | Int | 結果値 (1: 成功、失敗時 Error code参照) |
error | String | エラー内容 |
リーダーボード変更 API
Request
- Method : PUT
- URI : https://gamepot.apigw.ntruss.com/gpapps/v2/leaderboards/{leaderboardId}
Header | Type | Required | Description |
---|
X-API-KEY | String | O | GAMEPOTで発行する認証キー |
X-PROJECT-ID | String | O | ダッシュボードプロジェクト ID |
Attribute | Type | Required | Description |
---|
leaderboardId | String | O | リーダーボード固有 ID |
status | Boolean | O | 状態 |
is_check_user | Boolean | X | ユーザー IDチェックの有無 |
name | String | X | リーダーボード名 |
description | String | X | 説明 |
icon_url | String | X | アイコン URL |
descending | Boolean | X | ソート |
startedAt | String | X | 開始日 |
expiredAt | String | X | 終了日(seasonの場合) |
timezone | String | X | タイムゾーン |
period_type | String | X | 周期(daily、weekly、monthly、season) |
resetDay | Integer | X | 初期化曜日1: 日曜日、2. 月曜日、3. 火曜日、4. 水曜日、5. 木曜日、6. 金曜日、7. 土曜日(periodTypeが weeklyの場合) |
resetTime | String | X | 初期化時間 |
resetDate | Integer | X | 初期化日1~31(periodTypeが monthlyの場合) |
ranking | String | O | ランキングアップデート基準(latest、accumulated、best) |
tie_breaking | String | O | 同点者処理基準(first、last) |
Response
成功
Attribute | Type | Required | Description |
---|
id | String | O | リーダーボード固有 ID |
projectId | String | O | プロジェクト ID |
status | Boolean | O | 状態 |
is_check_user | Boolean | X | ユーザー IDチェックの有無 |
name | String | X | リーダーボード名 |
description | String | X | 説明 |
icon_url | String | X | アイコン URL |
descending | Boolean | X | ソート |
startedAt | String | X | 開始日 |
expiredAt | String | X | 終了日(seasonの場合) |
timezone | String | X | タイムゾーン |
period_type | String | X | 周期(daily、weekly、monthly、season) |
resetDay | Integer | X | 初期化曜日1: 日曜日、2. 月曜日、3. 火曜日、4. 水曜日、5. 木曜日、6. 金曜日、7. 土曜日(periodTypeが weeklyの場合) |
resetTime | String | X | 初期化時間 |
resetDate | Integer | X | 初期化日1~31(periodTypeが monthlyの場合) |
ranking | String | O | ランキングアップデート基準(latest、accumulated、best) |
tie_breaking | String | O | 同点者処理基準(first、last) |
失敗
Attribute | Type | Description |
---|
code | Int | 結果値 (1: 成功、失敗時 Error code参照) |
error | String | エラー内容 |
リーダーボード削除 API
Request
- Method : DELETE
- URI : https://gamepot.apigw.ntruss.com/gpapps/v2/leaderboards/{leaderboardId}
Header | Type | Required | Description |
---|
X-API-KEY | String | O | GAMEPOTで発行する認証キー |
X-PROJECT-ID | String | O | ダッシュボードプロジェクト ID |
Attribute | Type | Required | Description |
---|
leaderboardId | String | O | リーダーボード固有 ID |
Response
成功
成功
Attribute | Type | Required | Description |
---|
id | String | O | リーダーボード固有 ID |
projectId | String | O | プロジェクト ID |
status | Boolean | O | 状態 |
is_check_user | Boolean | X | ユーザー IDチェックの有無 |
name | String | X | リーダーボード名 |
description | String | X | 説明 |
icon_url | String | X | アイコン URL |
descending | Boolean | X | ソート |
startedAt | String | X | 開始日 |
expiredAt | String | X | 終了日(seasonの場合) |
timezone | String | X | タイムゾーン |
period_type | String | X | 周期(daily、weekly、monthly、season) |
resetDay | Integer | X | 初期化曜日1: 日曜日、2. 月曜日、3. 火曜日、4. 水曜日、5. 木曜日、6. 金曜日、7. 土曜日(periodTypeが weeklyの場合) |
resetTime | String | X | 初期化時間 |
resetDate | Integer | X | 初期化日1~31(periodTypeが monthlyの場合) |
ranking | String | O | ランキングアップデート基準(latest、accumulated、best) |
tie_breaking | String | O | 同点者処理基準(first、last) |
失敗
Attribute | Type | Description |
---|
code | Int | 結果値 (1: 成功、失敗時 Error code参照) |
error | String | エラー内容 |
あなたのフィードバックをありがとう!私たちのチームはあなたに戻って取得します