Uygulamalar

Şema

Bir Steam oyununun istatistik ve başarımlarının tam şemasını, görüntü adları, açıklamalar ve ikon URL'leriyle birlikte al.

Endpoint

Bu endpoint, bir Steam oyununun takip edilen istatistik ve başarımlarının tam şemasını, geliştiricinin Steam'de yayımladığı şekilde döndürür. Bir istatistik ya da başarımın dahili tanımlayıcısını (stats endpoint'inin ve başarımlar endpoint'inin döndürdüğü gibi) yerelleştirilmiş görüntü adına, açıklamaya ve ikona eşlemek için kullan.

GET   /v2/steam/apps/{appid}/schema

Gerekli parametreler

appid
number
Şemasını getirmek istediğin oyunun Steam application ID'si.

Kimlik Doğrulama

API anahtarını x-api-key request header'ı olarak ekle.

x-api-key: YourSecretAPIKey

Yanıt alanları

AlanTipAçıklama
gameNamestringŞemada bildirilen oyun görüntü adı. Bazı oyunlarda boş string olabilir.
gameVersionstringŞema sürümü (string; genellikle sayısal).
availableGameStatsobjectOyuna ait istatistik ve başarım tanımlarının container'ı.
availableGameStats.statsarrayİstatistik tanımları. Aşağıdaki alanlara bak.
availableGameStats.achievementsarrayBaşarım tanımları. Aşağıdaki alanlara bak.

İstatistik nesnesi

AlanTipAçıklama
namestringİstatistiğin dahili tanımlayıcısı. Stats endpoint'inin stats[].name olarak döndürdüğü değerdir.
defaultvaluenumberİstatistiğin varsayılan değeri.
displayNamestringİstatistiğin okunabilir görüntü adı. Geliştirici tanımlamadıysa boş string olabilir.

Başarım nesnesi

AlanTipAçıklama
namestringBaşarımın dahili tanımlayıcısı. Başarımlar endpoint'inin achievements[].name olarak döndürdüğü değerdir.
defaultvaluenumberBaşarımın varsayılan değeri (genellikle 0).
displayNamestringBaşarımın okunabilir görüntü adı.
hiddennumberBaşarım açılana kadar gizli mi. 0 = görünür, 1 = gizli.
descriptionstring|undefinedBaşarımın açıklama metni. Çoğu gizli başarımda (hidden: 1) bulunmaz.
iconstringAçılmış durum ikonuna URL.
icongraystringKilitli durum ikonuna URL.

Yanıt örneği

Bu endpoint için örnek çıktı. Kısalık için çoğu istatistik ve başarım atlanmıştır.

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"
        }
      ]
    }
  }
}