Aplikacje
Schema
Pobierz pełny schemat statystyk i osiągnięć gry Steam, wraz z nazwami wyświetlanymi, opisami i URL-ami ikon.
Endpoint
Ten endpoint zwraca pełny schemat śledzonych statystyk i osiągnięć gry Steam, opublikowany przez dewelopera na Steam. Użyj go, aby rozwiązać wewnętrzny identyfikator statystyki lub osiągnięcia (taki jaki zwraca endpoint statystyk i endpoint osiągnięć) na zlokalizowaną nazwę wyświetlaną, opis i ikonę.
GET /v2/steam/apps/{appid}/schema
Wymagane parametry
appid
number
Steam application ID gry, której schemat chcesz pobrać.
Uwierzytelnianie
Dołącz swój klucz API jako header x-api-key.
x-api-key: YourSecretAPIKey
Pola odpowiedzi
| Pole | Typ | Opis |
|---|---|---|
gameName | string | Nazwa wyświetlana gry zgłoszona w schemacie. Dla niektórych gier może być pustym stringiem. |
gameVersion | string | Wersja schematu (string, zazwyczaj numeryczny). |
availableGameStats | object | Kontener na definicje statystyk i osiągnięć gry. |
availableGameStats.stats | array | Definicje statystyk. Patrz pola poniżej. |
availableGameStats.achievements | array | Definicje osiągnięć. Patrz pola poniżej. |
Obiekt statystyki
| Pole | Typ | Opis |
|---|---|---|
name | string | Wewnętrzny identyfikator statystyki. Jest to wartość, którą endpoint statystyk zwraca jako stats[].name. |
defaultvalue | number | Domyślna wartość statystyki. |
displayName | string | Czytelna nazwa wyświetlana statystyki. Może być pustym stringiem, jeśli deweloper jej nie zdefiniował. |
Obiekt osiągnięcia
| Pole | Typ | Opis |
|---|---|---|
name | string | Wewnętrzny identyfikator osiągnięcia. Jest to wartość, którą endpoint osiągnięć zwraca jako achievements[].name. |
defaultvalue | number | Domyślna wartość osiągnięcia (zazwyczaj 0). |
displayName | string | Czytelna nazwa wyświetlana osiągnięcia. |
hidden | number | Czy osiągnięcie jest ukryte do momentu odblokowania. 0 = widoczne, 1 = ukryte. |
description | string|undefined | Tekst opisu osiągnięcia. Nieobecny dla większości ukrytych osiągnięć (hidden: 1). |
icon | string | URL do ikony odblokowanego stanu osiągnięcia. |
icongray | string | URL do ikony zablokowanego stanu osiągnięcia. |
Przykład odpowiedzi
Przykładowy output dla tego endpointu. Dla zwięzłości większość statystyk i osiągnięć została pominięta.
response.json
{
"success": true,
"result": {
"gameName": "",
"gameVersion": "98",
"availableGameStats": {
"stats": [
{ "name": "deaths", "defaultvalue": 0, "displayName": "Deaths" },
{ "name": "bullet_fired", "defaultvalue": 0, "displayName": "Bullets Fired" },
{ "name": "kill_bear", "defaultvalue": 0, "displayName": "" }
],
"achievements": [
{
"name": "COLLECT_100_WOOD",
"defaultvalue": 0,
"displayName": "Collect Wood",
"hidden": 0,
"description": "Collect 100 Wood",
"icon": "https://steamcdn-a.akamaihd.net/steamcommunity/public/images/apps/252490/d896ed9975dc2b03acc89625ed7b70827354f625.jpg",
"icongray": "https://steamcdn-a.akamaihd.net/steamcommunity/public/images/apps/252490/6187dce1ff97cc7c07633f2d709f286fa8b4c719.jpg"
},
{
"name": "GLUTTON",
"defaultvalue": 0,
"displayName": "Glutton",
"hidden": 1,
"icon": "https://steamcdn-a.akamaihd.net/steamcommunity/public/images/apps/252490/3b9d9664a85847891233384f230e0b2ecfc92e01.jpg",
"icongray": "https://steamcdn-a.akamaihd.net/steamcommunity/public/images/apps/252490/07db7c83c3514799bd57ed7781ffeceb2dc90fe9.jpg"
}
]
}
}
}