SysCreateLeaderboard

caution

WARNING: This call, SysCreateLeaderboard(), has been deprecated and replaced with SysCreateLeaderboardConfig().

Create a new player or group entry leaderboard configuration.

Service	Operation
leaderboard	SYS_CREATE_LEADERBOARD

Method Parameters

Parameter	Description
leaderboardId	Unique ID of the leaderboard configuration to create.
entryType	Type of leaderboard entry. Valid values: 'PLAYER', 'GROUP'.
leaderboardType	Type of leaderboard. Valid values: 'LAST_VALUE', 'HIGH_VALUE', 'LOW_VALUE', 'CUMULATIVE', 'ARCADE_HIGH', 'ARCADE_LOW'.
rotationType	Type of rotation. Valid values: 'NEVER', 'DAILY', 'DAYS', 'WEEKLY', 'MONTHLY', 'YEARLY'.
numDaysToRotate	Optional parameter. Required only if 'DAYS' rotation type; otherwise, null.
rotationResetTimestampUtcMillis	UTC timestamp, in milliseconds, at which to rotate the leaderboard.
retainedCount	The number of rotations (versions) of the leaderboard to retain.
data	Optional parameter. Developer-defined data relevant to the created leaderboard.

Usage

http://localhost:3000

C#

//cloud code only

C++

//cloud code only

Objective-C

//cloud code only

Java

//cloud code only

JavaScript

//cloud code only

Dart

// Cloud Code only. To view example, switch to the Cloud Code tab

Cloud Code

var leaderboardId = "default";
var entryType = "PLAYER",
var leaderboardType = "HIGH_VALUE";
var rotationType = "DAYS";
var numDaysToRotate = 5;
var rotationResetTimestampUtcMillis = Date.now();
var retainedCount = 2;
var data = { "street": "1309 Carling" };

var leaderboardProxy = bridge.getLeaderboardServiceProxy();
var retVal = leaderboardProxy.sysCreateLeaderboard(
    leaderboardId,
    entryType,
    leaderboardType,
    rotationType,
    numDaysToRotate,
    rotationResetTimestampUtcMillis,
    retainedCount,
    data
);

Raw

{
    "service": "leaderboard",
    "operation": "SYS_CREATE_LEADERBOARD",
    "data": {
        "leaderboardId": "default",
        "entryType": "PLAYER",
        "leaderboardType": "HIGH_VALUE",
        "rotationType": "DAYS",
        "numDaysToRotate": 5,
        "rotationResetTimestampUtcMillis": "[[#ts+60000]]",
        "retainedCount": 2,
        "data": {
            "street": "1309 Carling"
        }
    }
}

JSON Response

{
    "status": 200,
    "data": null
}