Criar definição de placar

Creates a new leaderboard definition.

Allowed entity token types: title, game_server

Error codes

This operation may return the following PlayFab errors:

Error	Code
ApiNotEnabledForTitle	1520
DuplicateColumnNameFound	1585
DuplicateLinkedStatisticColumnNameFound	1589
EntityTypeMismatchWithStatDefinition	1582
ExternalEntityNotAllowedForTier	1580
InvalidBaseTimeForInterval	1581
LeaderboardCountLimitExceeded	1574
LeaderboardNameConflict	1569
LeaderboardSizeLimitExceeded	1575
LinkedStatisticColumnMismatch	1570
LinkedStatisticColumnNotFound	1586
LinkedStatisticColumnRequired	1587
LinkingStatsNotAllowedForEntityType	1573
MaxQueryableVersionsExceeded	23015
MaxQueryableVersionsValueNotAllowedForTier	1591
MultipleLinkedStatisticsNotAllowed	1588
PlayFabErrorEventNotSupportedForEntityType	23013
StatDefinitionAlreadyLinkedToLeaderboard	1572
StatisticNotFound	1195
VersionConfigurationIsRequired	23005

POST

Leaderboard

CreateLeaderboardDefinition

Create Leaderboard Definition

curl --request POST \
  --url https://{titleId}.playfabapi.com/Leaderboard/CreateLeaderboardDefinition \
  --header 'Content-Type: application/json' \
  --header 'X-EntityToken: <api-key>' \
  --data '
{
  "Name": "HighestScoresByLevel",
  "EntityType": "title_player_account",
  "VersionConfiguration": {
    "MaxQueryableVersions": 1
  },
  "Columns": [
    {
      "Name": "Hits"
    }
  ],
  "SizeLimit": 1000,
  "EventEmissionConfig": {
    "VersionEndConfig": {},
    "EntityRankOnVersionEndConfig": {
      "RankLimit": 1
    }
  }
}
'

import requests

url = "https://{titleId}.playfabapi.com/Leaderboard/CreateLeaderboardDefinition"

payload = {
    "Name": "HighestScoresByLevel",
    "EntityType": "title_player_account",
    "VersionConfiguration": { "MaxQueryableVersions": 1 },
    "Columns": [{ "Name": "Hits" }],
    "SizeLimit": 1000,
    "EventEmissionConfig": {
        "VersionEndConfig": {},
        "EntityRankOnVersionEndConfig": { "RankLimit": 1 }
    }
}
headers = {
    "X-EntityToken": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Name: 'HighestScoresByLevel',
    EntityType: 'title_player_account',
    VersionConfiguration: {MaxQueryableVersions: 1},
    Columns: [{Name: 'Hits'}],
    SizeLimit: 1000,
    EventEmissionConfig: {VersionEndConfig: {}, EntityRankOnVersionEndConfig: {RankLimit: 1}}
  })
};

fetch('https://{titleId}.playfabapi.com/Leaderboard/CreateLeaderboardDefinition', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Leaderboard/CreateLeaderboardDefinition",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'Name' => 'HighestScoresByLevel',
    'EntityType' => 'title_player_account',
    'VersionConfiguration' => [
        'MaxQueryableVersions' => 1
    ],
    'Columns' => [
        [
                'Name' => 'Hits'
        ]
    ],
    'SizeLimit' => 1000,
    'EventEmissionConfig' => [
        'VersionEndConfig' => [
                
        ],
        'EntityRankOnVersionEndConfig' => [
                'RankLimit' => 1
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-EntityToken: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Leaderboard/CreateLeaderboardDefinition"

	payload := strings.NewReader("{\n  \"Name\": \"HighestScoresByLevel\",\n  \"EntityType\": \"title_player_account\",\n  \"VersionConfiguration\": {\n    \"MaxQueryableVersions\": 1\n  },\n  \"Columns\": [\n    {\n      \"Name\": \"Hits\"\n    }\n  ],\n  \"SizeLimit\": 1000,\n  \"EventEmissionConfig\": {\n    \"VersionEndConfig\": {},\n    \"EntityRankOnVersionEndConfig\": {\n      \"RankLimit\": 1\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-EntityToken", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Leaderboard/CreateLeaderboardDefinition")
  .header("X-EntityToken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"Name\": \"HighestScoresByLevel\",\n  \"EntityType\": \"title_player_account\",\n  \"VersionConfiguration\": {\n    \"MaxQueryableVersions\": 1\n  },\n  \"Columns\": [\n    {\n      \"Name\": \"Hits\"\n    }\n  ],\n  \"SizeLimit\": 1000,\n  \"EventEmissionConfig\": {\n    \"VersionEndConfig\": {},\n    \"EntityRankOnVersionEndConfig\": {\n      \"RankLimit\": 1\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Leaderboard/CreateLeaderboardDefinition")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"Name\": \"HighestScoresByLevel\",\n  \"EntityType\": \"title_player_account\",\n  \"VersionConfiguration\": {\n    \"MaxQueryableVersions\": 1\n  },\n  \"Columns\": [\n    {\n      \"Name\": \"Hits\"\n    }\n  ],\n  \"SizeLimit\": 1000,\n  \"EventEmissionConfig\": {\n    \"VersionEndConfig\": {},\n    \"EntityRankOnVersionEndConfig\": {\n      \"RankLimit\": 1\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "code": 123,
  "status": "<string>",
  "data": {}
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

Autorizações

X-EntityToken

string

header

obrigatório

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Corpo

application/json

Columns

object[]

obrigatório

Leaderboard columns describing the sort directions, cannot be changed after creation. A maximum of 5 columns are allowed.

Show child attributes

EntityType

string

obrigatório

The entity type being represented on the leaderboard. If it doesn't correspond to the PlayFab entity types, use 'external' as the type.

Name

string

obrigatório

A name for the leaderboard, unique per title.

SizeLimit

number

obrigatório

Maximum number of entries on this leaderboard

CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

EventEmissionConfig

object

[In Preview]: The configuration for the events emitted by this leaderboard. If not specified, no events will be emitted.

Show child attributes

VersionConfiguration

object

The version reset configuration for the leaderboard definition.

Show child attributes

Resposta

code

integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status

string

The Http status code as a string.

data

object

Última modificação em 6 de outubro de 2026

⌘I

Create Leaderboard Definition

curl --request POST \
  --url https://{titleId}.playfabapi.com/Leaderboard/CreateLeaderboardDefinition \
  --header 'Content-Type: application/json' \
  --header 'X-EntityToken: <api-key>' \
  --data '
{
  "Name": "HighestScoresByLevel",
  "EntityType": "title_player_account",
  "VersionConfiguration": {
    "MaxQueryableVersions": 1
  },
  "Columns": [
    {
      "Name": "Hits"
    }
  ],
  "SizeLimit": 1000,
  "EventEmissionConfig": {
    "VersionEndConfig": {},
    "EntityRankOnVersionEndConfig": {
      "RankLimit": 1
    }
  }
}
'

import requests

url = "https://{titleId}.playfabapi.com/Leaderboard/CreateLeaderboardDefinition"

payload = {
    "Name": "HighestScoresByLevel",
    "EntityType": "title_player_account",
    "VersionConfiguration": { "MaxQueryableVersions": 1 },
    "Columns": [{ "Name": "Hits" }],
    "SizeLimit": 1000,
    "EventEmissionConfig": {
        "VersionEndConfig": {},
        "EntityRankOnVersionEndConfig": { "RankLimit": 1 }
    }
}
headers = {
    "X-EntityToken": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Name: 'HighestScoresByLevel',
    EntityType: 'title_player_account',
    VersionConfiguration: {MaxQueryableVersions: 1},
    Columns: [{Name: 'Hits'}],
    SizeLimit: 1000,
    EventEmissionConfig: {VersionEndConfig: {}, EntityRankOnVersionEndConfig: {RankLimit: 1}}
  })
};

fetch('https://{titleId}.playfabapi.com/Leaderboard/CreateLeaderboardDefinition', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Leaderboard/CreateLeaderboardDefinition",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'Name' => 'HighestScoresByLevel',
    'EntityType' => 'title_player_account',
    'VersionConfiguration' => [
        'MaxQueryableVersions' => 1
    ],
    'Columns' => [
        [
                'Name' => 'Hits'
        ]
    ],
    'SizeLimit' => 1000,
    'EventEmissionConfig' => [
        'VersionEndConfig' => [
                
        ],
        'EntityRankOnVersionEndConfig' => [
                'RankLimit' => 1
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-EntityToken: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Leaderboard/CreateLeaderboardDefinition"

	payload := strings.NewReader("{\n  \"Name\": \"HighestScoresByLevel\",\n  \"EntityType\": \"title_player_account\",\n  \"VersionConfiguration\": {\n    \"MaxQueryableVersions\": 1\n  },\n  \"Columns\": [\n    {\n      \"Name\": \"Hits\"\n    }\n  ],\n  \"SizeLimit\": 1000,\n  \"EventEmissionConfig\": {\n    \"VersionEndConfig\": {},\n    \"EntityRankOnVersionEndConfig\": {\n      \"RankLimit\": 1\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-EntityToken", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Leaderboard/CreateLeaderboardDefinition")
  .header("X-EntityToken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"Name\": \"HighestScoresByLevel\",\n  \"EntityType\": \"title_player_account\",\n  \"VersionConfiguration\": {\n    \"MaxQueryableVersions\": 1\n  },\n  \"Columns\": [\n    {\n      \"Name\": \"Hits\"\n    }\n  ],\n  \"SizeLimit\": 1000,\n  \"EventEmissionConfig\": {\n    \"VersionEndConfig\": {},\n    \"EntityRankOnVersionEndConfig\": {\n      \"RankLimit\": 1\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Leaderboard/CreateLeaderboardDefinition")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"Name\": \"HighestScoresByLevel\",\n  \"EntityType\": \"title_player_account\",\n  \"VersionConfiguration\": {\n    \"MaxQueryableVersions\": 1\n  },\n  \"Columns\": [\n    {\n      \"Name\": \"Hits\"\n    }\n  ],\n  \"SizeLimit\": 1000,\n  \"EventEmissionConfig\": {\n    \"VersionEndConfig\": {},\n    \"EntityRankOnVersionEndConfig\": {\n      \"RankLimit\": 1\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "code": 123,
  "status": "<string>",
  "data": {}
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

PlayFab API

PlayFab REST API References

Criar definição de placar

Error codes

Autorizações

Corpo

Resposta