更新玩家統計資料定義

Updates a player statistic configuration for the title, optionally allowing the developer to specify a reset interval.

Error codes

This operation may return the following PlayFab errors:

Error	Code
ProductDisabledForTitle	1609
StatisticNotFound	1195
StatisticUpdateInProgress	1276

POST

Admin

UpdatePlayerStatisticDefinition

Update Player Statistic Definition

curl --request POST \
  --url https://{titleId}.playfabapi.com/Admin/UpdatePlayerStatisticDefinition \
  --header 'Content-Type: application/json' \
  --header 'X-SecretKey: <api-key>' \
  --data '
{
  "StatisticName": "headshots",
  "VersionChangeInterval": "Day"
}
'

import requests

url = "https://{titleId}.playfabapi.com/Admin/UpdatePlayerStatisticDefinition"

payload = {
    "StatisticName": "headshots",
    "VersionChangeInterval": "Day"
}
headers = {
    "X-SecretKey": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-SecretKey': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({StatisticName: 'headshots', VersionChangeInterval: 'Day'})
};

fetch('https://{titleId}.playfabapi.com/Admin/UpdatePlayerStatisticDefinition', 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/Admin/UpdatePlayerStatisticDefinition",
  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([
    'StatisticName' => 'headshots',
    'VersionChangeInterval' => 'Day'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-SecretKey: <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/Admin/UpdatePlayerStatisticDefinition"

	payload := strings.NewReader("{\n  \"StatisticName\": \"headshots\",\n  \"VersionChangeInterval\": \"Day\"\n}")

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

	req.Header.Add("X-SecretKey", "<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/Admin/UpdatePlayerStatisticDefinition")
  .header("X-SecretKey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"StatisticName\": \"headshots\",\n  \"VersionChangeInterval\": \"Day\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Admin/UpdatePlayerStatisticDefinition")

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

request = Net::HTTP::Post.new(url)
request["X-SecretKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"StatisticName\": \"headshots\",\n  \"VersionChangeInterval\": \"Day\"\n}"

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

{
  "code": 200,
  "status": "OK",
  "data": {
    "Statistic": {
      "StatisticName": "headshots",
      "CurrentVersion": 2,
      "VersionChangeInterval": "Day"
    }
  }
}

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

授權

X-SecretKey

string

header

必填

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

主體

application/json

Statistics are numeric values, with each statistic in the title also generating a leaderboard. The ResetInterval enables automatically resetting leaderboards on a specified interval. Upon reset, the statistic updates to a new version with no values (effectively removing all players from the leaderboard). The previous version's statistic values are also archived for retrieval, if needed (see GetPlayerStatisticVersions). Statistics not created via a call to CreatePlayerStatisticDefinition by default have a VersionChangeInterval of Never, meaning they do not reset on a schedule, but they can be set to do so via a call to UpdatePlayerStatisticDefinition. Once a statistic has been reset (sometimes referred to as versioned or incremented), the now-previous version can still be written to for up a short, pre-defined period (currently 10 seconds), to prevent issues with levels completing around the time of the reset. Also, once reset, the historical statistics for players in the title may be retrieved using the URL specified in the version information (GetPlayerStatisticVersions). The AggregationMethod determines what action is taken when a new statistic value is submitted - always update with the new value (Last), use the highest of the old and new values (Max), use the smallest (Min), or add them together (Sum).

StatisticName

string

必填

unique name of the statistic

AggregationMethod

enum<string>

the aggregation method to use in updating the statistic (defaults to last)

可用選項:

Last,

Min,

Max,

Sum

VersionChangeInterval

enum<string>

interval at which the values of the statistic for all players are reset (changes are effective at the next occurance of the new interval boundary)

可用選項:

Never,

Hour,

Day,

Week,

Month

回應

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

Show child attributes

範例:

{
  "Statistic": {
    "StatisticName": "headshots",
    "CurrentVersion": 2,
    "VersionChangeInterval": "Day"
  }
}

最後修改於 2026年10月6日

⌘I

Update Player Statistic Definition

curl --request POST \
  --url https://{titleId}.playfabapi.com/Admin/UpdatePlayerStatisticDefinition \
  --header 'Content-Type: application/json' \
  --header 'X-SecretKey: <api-key>' \
  --data '
{
  "StatisticName": "headshots",
  "VersionChangeInterval": "Day"
}
'

import requests

url = "https://{titleId}.playfabapi.com/Admin/UpdatePlayerStatisticDefinition"

payload = {
    "StatisticName": "headshots",
    "VersionChangeInterval": "Day"
}
headers = {
    "X-SecretKey": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-SecretKey': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({StatisticName: 'headshots', VersionChangeInterval: 'Day'})
};

fetch('https://{titleId}.playfabapi.com/Admin/UpdatePlayerStatisticDefinition', 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/Admin/UpdatePlayerStatisticDefinition",
  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([
    'StatisticName' => 'headshots',
    'VersionChangeInterval' => 'Day'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-SecretKey: <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/Admin/UpdatePlayerStatisticDefinition"

	payload := strings.NewReader("{\n  \"StatisticName\": \"headshots\",\n  \"VersionChangeInterval\": \"Day\"\n}")

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

	req.Header.Add("X-SecretKey", "<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/Admin/UpdatePlayerStatisticDefinition")
  .header("X-SecretKey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"StatisticName\": \"headshots\",\n  \"VersionChangeInterval\": \"Day\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Admin/UpdatePlayerStatisticDefinition")

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

request = Net::HTTP::Post.new(url)
request["X-SecretKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"StatisticName\": \"headshots\",\n  \"VersionChangeInterval\": \"Day\"\n}"

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

{
  "code": 200,
  "status": "OK",
  "data": {
    "Statistic": {
      "StatisticName": "headshots",
      "CurrentVersion": 2,
      "VersionChangeInterval": "Day"
    }
  }
}

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

PlayFab API

PlayFab REST API References

更新玩家統計資料定義

Error codes

授權

主體

回應