CreateLeaderboard

{
    "packetId": 1,
    "messages": [
        {
            "service": "leaderboard",
            "operation": "CREATE_LEADERBOARD",
            "data": {
                "leaderboardId": "default",
                "leaderboardType": "HIGH_VALUE",
                "rotationType": "WEEKLY",
                "rotationReset": "31-01-2015 15:00",
                "rotationResetTime": 1437478586586,
                "retainedCount": 2,
                "data": {
                    "street": "1309 Carling"
                }
            }
        }
    ]
}

Creates a leaderboard under the context of the current game. You can optionally send a user-defined json string of data with the created leaderboard. This string could include information relevant to the created leaderboard.

Service	Operation
leaderboard	CREATE_LEADERBOARD

Method Parameters

Parameter	Description
leaderboardId	A leaderboard id.
leaderboardType	The leaderboard type.
rotationType	Type of rotation.
rotationResetTime	Date to start the rotation (Date is in millis.)
retainedCount	How many previous rotations to keep.
numDaysToRotate	How many previous rotations to keep.
data	Optional user-defined data to post with the score.

Usage

http://localhost:3000

C#

// S2S call: to view example, switch to the Cloud Code or Raw tab.

C++

// S2S call: to view example, switch to the Cloud Code or Raw tab.

Objective-C

// S2S call: to view example, switch to the Cloud Code or Raw tab.

Java

// S2S call: to view example, switch to the Cloud Code or Raw tab.

JavaScript

// S2S call: to view example, switch to the Cloud Code or Raw tab.

Dart

// S2S call: to view example, switch to the Cloud Code or Raw tab.

Cloud Code

var leaderboardId = "testCreate";
var type = "HIGH_VALUE";
var rotationType = "WEEKLY";
var rotationReset = Date.now();
var versionsToRetain = 6;
var data = { "test": 1234 };

var leaderboardProxy = bridge.getLeaderboardServiceProxy();
var retVal = leaderboardProxy.createLeaderboard(
    leaderboardId,
    type,
    rotationType,
    rotationReset,
    versionsToRetain,
    data
);

//For DAYS rotation type

var leaderboardId = "testCreate";
var type = "HIGH_VALUE";
var rotationType = "DAYS";
var rotationReset = Date.now();
var versionsToRetain = 6;
var data = { "test": 1234 };
var numDaysToRotate = 3;

var leaderboardProxy = bridge.getLeaderboardServiceProxy();
var retVal = leaderboardProxy.createLeaderboard(
    leaderboardId,
    type,
    rotationType,
    rotationReset,
    versionsToRetain,
    data,
    numDaysToRotate
);

Raw

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

JSON Response

{
    "packetId": 1,
    "messageResponses": [
        {
            "status": 200,
            "data": null
        }
    ]
}