Add

post https://us-central1-readysandbox.cloudfunctions.net/leaderboardV2-add

Add a new leaderboard

Body Params

appId

string

required

Application identifier

string

Unique id of the leaderboard.

appIds

array of strings

required

List of application ids where this leaderboard is used.

appIds*

requestName

string

required

Leaderboard request name. This value can be used to query leaderboards.

tags

name

string

required

Leaderboard name. Is also used to store localization key for the name.

description

string

required

Leaderboard description. Is also used to store localization key for the description.

setBy

string

required

Defines who can set/add scores to the leaderboard:

client - the client and the server can set/add scores to the leaderboard.
server - only the server can set/add scores to the leaderboard.

invertSortOrder

boolean

required

Sorting direction. False for descending order, true for ascending order.

decimalOffset

integer

required

Determines how many digits of the score are displayed after the decimal point.

type

string

Defaults to numeric

The leaderboard type that determines the results unit. Default is 'numeric'.
Possible values:

time - the leaderboard is time-based.
numeric - the leaderboard is numeric-based.

rewardsAtReset

array of objects

Rewards which will be earned at reset period.

rewardsAtReset

rewardsDrawType

string

The leaderboard rewards draw type that determines how the leaderboard should draw rewards, possible values:

placeBased - rewards will be drawn accordingly users places.
scoreBased - rewards will be drawn randomly, but users with higher score will have more chance to win.
scoreBasedOnePerUser - same as the scoreBased, but with limitation for one reward at whole leaderboard per one user.
scoreBasedOnePerUserAndReward - same as the scoreBased, but with limitation for one unique reward per one user
but different rewards could be added to same user.

time

object

required

The time when the leaderboard is available.

requiredToJoin

object

Join leaderboard requirements. To setScore and addScore to the leaderboard.

autoClaim

boolean

Indicates whether the leaderboard rewards are automatically claimed by the user. If false, the rewards must be claimed manually. The time.end is required and optionally time.grace to be set if autoClaim is true.

participationFees

array of objects

List of participation fees for the leaderboard.
The fees are deducted when the user sets or adds a score to the leaderboard for the first time.

participationFees

participationRewards

array of strings

List of achievement ids that are triggered for the first score set or added to the leaderboard.

participationRewards

scoreMultipliers

object

List of score multipliers for the leaderboard.

fakeEntries

object

Fake entries for the leaderboard.

filterEntriesWithZeroScore

boolean

Indicates whether the leaderboard entries with zero score should be filtered out. If true, the entries with zero score are not displayed in the leaderboard.

Responses

400

Invalid input parameters

409

Leaderboard already exists

Language

Credentials

URL


xxxxxxxxxx
14
1
curl --request POST \
2
     --url https://us-central1-readysandbox.cloudfunctions.net/leaderboardV2-add \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "setBy": "client",
8
  "invertSortOrder": true,
9
  "type": "numeric",
10
  "scoreMultipliers": {
11
    "rounding": "floor"
12
  }
13
}
14
'


xxxxxxxxxx
 
1
{
2
  "leaderboardId": "string"
3
}

200Leaderboard added successfully

401Unauthenticated error 401 indicating the user is not authenticated.