Apps
Schema
Rufe das vollständige Stats- und Erfolge-Schema eines Steam-Spiels ab, inklusive Anzeigenamen, Beschreibungen und Icon-URLs.
Endpunkt
Dieser Endpunkt gibt das vollständige Schema der erfassten Stats und Erfolge eines Steam-Spiels zurück, wie es vom Entwickler auf Steam veröffentlicht wurde. Nutze es, um den internen Bezeichner einer Statistik oder eines Erfolgs (wie ihn der Stats-Endpunkt und der Erfolg-Endpunkt zurückgeben) in einen lokalisierten Anzeigenamen, eine Beschreibung und ein Icon aufzulösen.
GET /v2/steam/apps/{appid}/schema
Erforderliche Parameter
appid
number
Die Steam-Applikations-ID des Spiels, dessen Schema du abrufen möchtest.
Authentifizierung
Übergib deinen API-Schlüssel als x-api-key Request-Header.
x-api-key: YourSecretAPIKey
Antwortfelder
| Feld | Typ | Beschreibung |
|---|---|---|
gameName | string | Der im Schema gemeldete Anzeigename des Spiels. Kann bei manchen Spielen ein leerer String sein. |
gameVersion | string | Die Schema-Version (ein String, typischerweise numerisch). |
availableGameStats | object | Container für die Stats- und Erfolg-Definitionen des Spiels. |
availableGameStats.stats | array | Statistik-Definitionen. Siehe Felder unten. |
availableGameStats.achievements | array | Erfolg-Definitionen. Siehe Felder unten. |
Statistik-Objekt
| Feld | Typ | Beschreibung |
|---|---|---|
name | string | Der interne Bezeichner der Statistik. Dies ist der Wert, den der Stats-Endpunkt als stats[].name zurückgibt. |
defaultvalue | number | Der Standardwert der Statistik. |
displayName | string | Menschenlesbarer Anzeigename der Statistik. Kann ein leerer String sein, wenn der Entwickler keinen definiert hat. |
Erfolg-Objekt
| Feld | Typ | Beschreibung |
|---|---|---|
name | string | Der interne Bezeichner des Erfolgs. Dies ist der Wert, den der Erfolg-Endpunkt als achievements[].name zurückgibt. |
defaultvalue | number | Der Standardwert des Erfolgs (typischerweise 0). |
displayName | string | Menschenlesbarer Anzeigename des Erfolgs. |
hidden | number | Ob der Erfolg bis zur Freischaltung versteckt ist. 0 = sichtbar, 1 = versteckt. |
description | string|undefined | Beschreibungstext des Erfolgs. Bei den meisten versteckten Erfolgen (hidden: 1) nicht vorhanden. |
icon | string | URL zum Icon des freigeschalteten Zustands. |
icongray | string | URL zum Icon des gesperrten Zustands. |
Antwortbeispiel
Beispielausgabe für diesen Endpunkt. Zur Übersichtlichkeit wurden die meisten Stats und Erfolge weggelassen.
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"
}
]
}
}
}