GetPastLeaderboard

public BackendUserPastLeaderboardReturnObject GetPastLeaderboard(string leaderboardUuid, int limit = 10, int offset = 0)

Parameters

Value	Type	Description	Default
leaderboardUuid	string	uuid of the leaderboard to look up	-
limit	int	Number of leaderboard users to load (1 - 100)	10
offset	int	조회할 리더보드의 uuid(0이상)	0

Description

Loads the last leaderboard ranking before the renewal of the leaderboard that has been measured for leaderboard rewards.

• This is only possible for leaderboards with rewards.
• Only the past leaderboards for users who have received leaderboard rewards are displayed.
  • 리더보드 보상이 10등까지에게만 주어질 경우, 11등부터의 과거 리더보드은 불러올 수 없습니다.
  • Users who are outside the ranking but still within the overall reward range are also not displayed on past leaderboards.
• You cannot load the past leaderboard for a certain user or for yourself.
• Among the past leaderboards, the latest past leaderboard will be loaded.
  • 일간 리더보드일 경우, 1일 전 과거 리더보드 데이터를 불러오게 되며 2일 전 리더보드은 불러오지 못합니다.
• limit을 0이하로 입력할 경우 1로 적용됩니다. 100이상일 경우에는 100으로 적용됩니다.
• offset을 0이하로 입력할 경우 0으로 적용됩니다.
• Users without nicknames will be marked as "".
• This method cannot be called using SendQueue.

For withdrawn users

If there are withdrawn users in the past leaderboard list, the user’s nickname and inDate columns will not exist.\ jsonData.ContainsKey("nickname")으로 컬럼을 확인한 뒤에 데이터를 가공해주세요.

Withdrawn user

{"score":"7835","rank":1}

General user

{"score":"7833","rank":3,"nickname":"user1","inDate":"2024-03-06T05:59:53.523Z"}

BackendUserPastLeaderboardReturnObject

namespace BackEnd.Leaderboard
{
    public class UserPastLeaderboardItem
    {
        public string nickname;
        public string inDate;
        public string  score;
        public string  rank;
    }

    public class BackendUserPastLeaderboardReturnObject : BackendReturnObject
    {    
        public List<UserPastLeaderboardItem> GetUserPastLeaderboardList();
    }
}

Example

Synchronous

// 리더보드 1위 부터 10위까지
BackEnd.Leaderboard.BackendUserPastLeaderboardReturnObject bro = Backend.Leaderboard.User.GetPastLeaderboard("01920445-a435-759e-bc3b-048a1e7a87aa");

foreach(BackEnd.Leaderboard.UserPastLeaderboardItem item in bro.GetUserPastLeaderboardList())
{
    string name = $"[{item.rank}] {item.nickname} : {item.score}";
    Debug.Log(item);
}

// 리더보드 11위(offset + 1) 부터 111위까지((offset + 1 + limit)
Backend.Leaderboard.User.GetPastLeaderboard("a61c6980-db5f-11ee-95a9-73cbb1225013", 100, 10);

Asynchronous

Backend.Leaderboard.User.GetPastLeaderboard("a61c6980-db5f-11ee-95a9-73cbb1225013", 10, 0, callback => {
    foreach(BackEnd.Leaderboard.UserPastLeaderboardItem item in callback.GetUserPastLeaderboardList())
    {
        string name = $"[{item.rank}] {item.nickname} : {item.score}";
        Debug.Log(item);
    }
});

ReturnCase

Success cases

When the lookup is successful\ statusCode : 200\ message : Success\ returnValue : Refer to GetReturnValuetoJSON

Error cases

If reward calculation has not been conducted for the past leaderboard\ statusCode : 200\ message : Success\ returnValue : {"rows":[]}

When uuid is null or string.Empty\ statusCode : 400\ errorCode : ValidationException\ message : leaderboardUuid is null or empty

존재하지 않는 uuid로 조회를 시도한 경우\ statusCode : 404\ errorCode : NotFoundException\ message : leaderboard not found, leaderboard을(를) 찾을 수 없습니다

When attempting to look up the past leaderboards for the cumulative leaderboard\ statusCode : 428\ errorCode : Precondition Required\ message : Precondition Required rank initial type

GetReturnValuetoJSON

{
    "rows": [
        {
            "score": "7835", // The nickname and inDate will not be printed for withdrawn users.
            "rank": 1
        }
        {
            "score": "5834",
            "rank": 2,
            "nickname": "user2",// Users without nicknames will be printed as "".
            "inDate": "2024-03-06T05:59:53.523Z"
        },
        {
            "score": "5121",
            "rank": 3,
            "nickname": "user3",
            "inDate": "2024-03-06T05:59:51.568Z"
        }
    ]
}