Приложения
Schema
Получи полную схему статистики и достижений Steam-игры, включая отображаемые имена, описания и URL-ы иконок.
Эндпоинт
Этот endpoint возвращает полную схему отслеживаемой статистики и достижений Steam-игры, опубликованную разработчиком в Steam. Используй её, чтобы сопоставить внутренний идентификатор статы или достижения (как его возвращают endpoint статистики и endpoint достижений) с локализованным отображаемым именем, описанием и иконкой.
GET /v2/steam/apps/{appid}/schema
Обязательные параметры
appid
number
Steam application ID игры, чью схему ты хочешь получить.
Аутентификация
Включи свой API-ключ в request header x-api-key.
x-api-key: YourSecretAPIKey
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
gameName | string | Отображаемое имя игры, как сообщает схема. Для некоторых игр может быть пустой строкой. |
gameVersion | string | Версия схемы (строка, обычно числовая). |
availableGameStats | object | Контейнер определений статистики и достижений игры. |
availableGameStats.stats | array | Определения статистики. См. поля ниже. |
availableGameStats.achievements | array | Определения достижений. См. поля ниже. |
Объект статистики
| Поле | Тип | Описание |
|---|---|---|
name | string | Внутренний идентификатор статистики. Это значение, которое endpoint статистики возвращает как stats[].name. |
defaultvalue | number | Значение статистики по умолчанию. |
displayName | string | Читаемое отображаемое имя статистики. Может быть пустой строкой, если разработчик не задал его. |
Объект достижения
| Поле | Тип | Описание |
|---|---|---|
name | string | Внутренний идентификатор достижения. Это значение, которое endpoint достижений возвращает как achievements[].name. |
defaultvalue | number | Значение достижения по умолчанию (обычно 0). |
displayName | string | Читаемое отображаемое имя достижения. |
hidden | number | Скрыто ли достижение до разблокировки. 0 = видимо, 1 = скрыто. |
description | string|undefined | Текст описания достижения. Отсутствует у большинства скрытых достижений (hidden: 1). |
icon | string | URL иконки разблокированного состояния достижения. |
icongray | string | URL иконки заблокированного состояния достижения. |
Пример ответа
Пример вывода для этого endpoint'а. Для краткости большинство стат и достижений опущено.
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"
}
]
}
}
}