Steamworks-dokumentaatio
GetAssetClassInfo/v0001
Tämä palauttaa tiedot, joita käyttäjä tarvitsee nähdäkseen elementtiluokan. Kaikkien tavaraluettelon elementtien kohdalla metodia kutsutaan vähintään kerran. Se on tallennettu tehokkaasti välimuistiin, joten sitä voidaan kutsua harvemmin kuin kerran yhtä elementin näkymää kohti. Jos sinun pitää tyhjentää välimuisti, voit muuttaa sovelluksesi elementtiluokkaversion Talous-välilehden teknisistä tiedoista.

Yleensä elementtiin sisältyvä peli määrittää kokonaan luokkatunnisteet. Ainoa poikkeus on valuutta. Steamin talouspalvelin voi kutsua GetAssetClassInfo-käyttöliittymää yhdellä "currencyid"-tunnisteella, jonka arvo vastaa haettavan valuutan tunnusta. Elementtipalvelimen pitäisi tällöin palauttaa elementin näyttötietojen sijaan valuutan tiedot.

Kutsuja: Tavaraluettelon käyttöliittymä

HTTP-metodi: GET

Parametrit:

NimiTyyppiPakollinenKuvaus
keystringTämä on elementtipalvelimen tunnus, jonka annoit sovelluksesi kumppanisivulla Steam-talouden asetuksissa.
appiduint3232-bittinen sovellustunnus (AppID) sovellukselle, joka liittyy elementteihin.
class_countuint32Määritettyjen luokkatunnisteiden määrä.
class_name #stringTunnisteen nimi. Jokaiselle numerolle välillä 0 ja class_count-1 on yksi parametri (esim. class_name0, class_name1, class_name2).
class_value #stringTunnisteen arvo. Jokaiselle numerolle välillä 0 ja class_count-1 on yksi parametri (esim. class_value0, class_value1, class_value2).
languagestringPalautettavien merkkijonojen ISO 639-1-kielikoodi ja kaksikirjaiminen ISO 3166-1-maakoodi. Esimerkiksi: en_US, de_DE, zh_CN ja ko_KR. Oletus: en_US.

Paluuarvot

Metodin palautuksen tulisi olla koodattu JSON-muodossa.

Vastaus:
  • result
    • success – true (tosi), jos metodi toimi. Jos elementtipalvelin palauttaa arvon false (epätosi), sen on määritettävä merkkijonoon syyn ilmaiseva error.
    • error – merkkijono, joka kertoo syyn kutsun epäonnistumiselle. Tämä viesti tallennetaan virhelokiin, joka on saatavana Steamworks-sivuston Talous-välilehdeltä.
    • asset – objekti, joka sisältää määritettyjen elementtiluokkatunnisteiden näyttötiedot.

Näyttötiedot:

  • color (valinnainen) – merkkijonona esitetty RGB-väriarvo.
  • icon_url – elementin kuvake. Kuvan tulee tulee olla JPEG-, GIF- tai PNG-muodossa.
    Suosittelemme PNG- ja GIF-kuvatiedostoja, koska ne tukevat läpinäkyvyyttä. Pelit voivat toimittaa tämän kentän kautta yhden koon kuvakkeesta, ja Steam sovittaa sen käyttöliittymään. Kuvakkeen koon tulee olla vähintään 200 x 200 pikseliä. Steam tarjoaa CDN-jakelun kaikille kuville, kun ne näytetään käyttäjille, joten tämän URL-osoitteen hakuosumien määrä on suhteellisen pieni.
  • icon_url_large (valinnainen) – kuvausten suuri kuvake. Kuvamuotosäännöt ovat samat kuin icon_url-kohdassa.
    Suuren kuvakkeen tulee olla kooltaan vähintään 330 x 192 pikseliä. Jos icon_url_large -kuvakokoa ei tarjota, sen sijaan käytetään: icon_url.
    Steam tarjoaa CDN-jakelun kaikille kuville, kun ne näytetään käyttäjille, joten tämän URL-osoitteen hakuosumien määrä on suhteellisen pieni.
  • descriptions – elementistä näytettävä kuvaustaulukko. Nämä näytetään siinä järjestyksessä, jossa ne esiintyvät taulukon työkaluvihjeissä ja yksityiskohtaisissa kohdekuvauksissa.
    • type (valinnainen) – type-kenttä hallinnoi sitä, miten value-kenttä renderöidään.
      Se voi olla mikä tahansa seuraavista arvoista:
      • text – arvo tulkitaan raakakäännettynä tekstinä, joka on käännetty määritetyllä kielellä. Osa merkeistä (kuten pienempi kuin, suurempi kuin) muunnetaan HTML-entiteeteiksi, jottei niitä vahingossa tulkittaisi tunnisteiksi. Jokainen rivinvaihtomerkki muunnetaan <br>-merkiksi.
        Tätä tyyppiä tulee käyttää käyttäjän tarjoamiin tietoihin. text on oletustyyppi, jos tyyppiä ei ole määritetty.
      • html – arvo on sivulla HTML-koodina, eikä tunnisteisiin kosketa.
    • image – arvo on tässä kuvauksessa näytettävän kuvan URL-osoite. Steam asettaa CDN-arvon kuvan eteen, jolloin URL-osoitteen saamien osumien määrä on suhteellisen pieni.
    • value – kuvauksessa näytettävä, käännetty merkkijono.
    • color (valinnainen) – arvolle määritetty RGB-väriarvo. Käytä mitä tahansa väriä, jolla tiedot näytetään pelinsisäisessä käyttöliittymässä. Kenttä koskee vain arvoja, joiden tyyppi on text.
    • label (valinnainen) – jos tämä kenttä esiintyy, selite on kuvausarvon etuliitteenä.
  • tags (valinnainen) – elementissä käytettävä tunnistetaulukko. Nämä näytetään suodatusasetuksina käyttäjälle eri puolilla käyttöliittymää, mukaan lukien yhteisön kauppapaikalla ja käyttäjien tavaraluetteloissa.
    • internal_name – nimi tunnisteen identifioimiseksi. Sisäistä nimeä ei näytetä käyttäjälle. Älä käytä välilyöntejä, muita kuin tulostettavissa olevia tai ASCII-merkkejä sisäisessä nimessä internal_name.
    • name – tunnisteen lokalisoitu nimi. Näytetään käyttäjälle.
    • category – kategoria, johon tämä tunniste sijoitetaan. Tätä käytetään vain sisäisesti ryhmittelyyn, eikä sitä näytetä käyttäjälle. Älä käytä välilyöntejä, muita kuin tulostettavissa olevia tai ASCII-merkkejä kategoriassa category.
    • category_name – kategorian lokalisoitu nimi. Näytetään käyttäjälle.
    • color (valinnainen) – tunnisteen nimelle määritetty RGB-väriarvo.
  • tradable (valinnainen) – jos arvo on true (tosi), kohde näkyy vaihtojen käyttöliittymässä. (Oletus: false (epätosi).)
  • marketable (valinnainen) – jos tämä on true (tosi), kohdetta voidaan myydä Steam-yhteisön kauppapaikalla. (Oletus: false (epätosi).)

    HUOMAA! Yhteisön kauppapaikan listauksia ei voi testata tällä hetkellä. Jos kohde listataan yhteisön kauppapaikalle, se näkyy välittömästi, vaikka pelin talous olisi yksityisenä.
  • market_name (vaaditaan, jos esine myytävissä) – jos kyseessä on myytävissä oleva esine, tätä nimeä käytetään kohteiden ryhmittelyyn, ja se näkyy yhteisön kauppapaikalla. Tämä tulee mahdollisuuksien mukaan lokalisoida.
  • market_hash_name (vaaditaan, jos esine myytävissä) – tämän on aina oltava market_name-tunnisteen englanninkielinen arvo. Tätä käytetään, jotta eri versiot vastaisivat toisiaan. Arvolla näytetään hintahistoria ja muita tietoja.
  • market_fee (valinnainen) – jos kyseessä on myytävissä oleva esine, maksutapahtumasta perittävä pelimaksun osuus (oletuksena 10 %). Esineen ostaja maksaa sen maksutapahtuman aikana, ja se palautetaan julkaisijalle osana heidän kuukausimaksuaan. Ilmaistaan desimaalilukuna välillä 0–0.95 (suositellaan kuitenkin tätä kohtuullisempaa maksua). (Oletus: 0.10)
  • commodity (valinnainen) – psoittaa, että jokainen samanniminen market_hash_name-esine on täysin samanlainen. Käyttäjätasolla ei pitäisi olla eroavaisuuksia. Tämä muuttaa kauppapaikan käyttöliittymää tällaiselle esineelle ja mahdollistaa käyttäjien tilaukset. Käyttäjät eivät voi hallita, keneltä tai minkä kauppapaikalla olevan esineen he ostavat. On tärkeää, että kaikki kohteet, joilla on sama market_hash_name-nimi, ovat identtisiä, kun commodity-arvo on true (tosi). (Oletus: false (epätosi).)
  • market_tradable_restriction (valinnainen) – kuinka monta päivää oston jälkeen esine ei ole vaihdettavissa. Voit asettaa ostetuille esineille vaihtorajoituksen, jotta käyttäjien on vaikeampi tehdä luottokorttipetoksia. Valven peleissä käytetään arvoa 7. (Oletus: 0)
    HUOMAA! Tämä arvo ei ole pakollinen. Steam ei pakota sinua käyttämään tätä rajoitusta. Tämän kentän arvoa käytetään vain siihen, että käyttäjille ilmoitetaan rajoituksen olemassaolosta. Kun esine on ostettu, elementtipalvelimen tehtävänä on asettaa vaihtorajoitus uudelle esineelle. Elementtipalvelin voi tehdä tämän, kun TradeSetOwned/v0001-metodia on kutsuttu ja is_market-arvoksi on määritetty 1 ja audit_action-arvoksi 101.
  • market_marketable_restriction (valinnainen) – muistuttaa market_tradable_restriction-rajoitusta. Se ilmaisee, moneenko päivään esinettä ei voi myydä viimeisimmän oston jälkeen. Valven peleissä käytetään arvoa 7. (Oletus: 0)
    HUOMAA! Tämä arvo ei ole ehdoton. Steam ei pakota sinua käyttämään tätä rajoitusta. Tämän kentän arvoa käytetään vain siihen, että käyttäjille ilmoitetaan rajoituksen olemassaolosta. Kun kohde on ostettu, elementtipalvelimen tehtävänä on asettaa uudelle esineelle kauppapaikan rajoitus. Elementtipalvelin voi tehdä tämän, kun kutsutaan TradeSetOwned/v0001 ja is_market-arvoksi on asetettu 1 ja audit_action -arvoksi 101.
  • actions – toiminnoista (linkeistä) koostuva taulukko, jonka tarkoituksena on yleensä näyttää lisätietoja elementistä. Nämä näytetään tavaraluettelosivulla painikkeina kuvauksen alla. Nämä linkit avataan käyttäjän oletusselaimessa.
    • link – URL-osoite, johon siirrytään painikkeen klikkaamisen jälkeen. Tunnisteet %assetid%, %contextid% ja %appid% korvataan elementti-, konteksti- ja omalla sovellustunnuksella.
    • name – painikkeessa näytettävä teksti.
  • owner_descriptions – taulukko, joka koostuu kuvauksista, jotka näytetään vain elementin omistajalle. Tämän taulukon sisältö vastaa täysin kohteen descriptions sisältöä. Nämä kaksi listaa eroavat toisistaan vain sen suhteen, kuka voi nähdä kuvaukset.
  • owner_actions – taulukko, joka koostuu toiminnoista, jotka näytetään vain elementin omistajalle. Sen on oltava samassa muodossa kuin actions. Nämä edustavat elementin omistajan erityistoimintoja, kuten elementin aktivointia tai muokkaamista.
  • fraudwarnings – taulukko, joka koostuu huijausvaroitusten merkkijonoista, jotka näytetään, jos esine lisätään vaihdettavaksi.
    Nämä näytetään punaisella, jos kohde lisätään vaihdettavaksi.
  • name – esinelistan ensimmäinen rivi.
  • name_color – nimelle määritetty RGB-väriarvo. Tämän on vastattava pelisi elementtien nimien harvinaisuusastetta tai laatuun perustuvaa värikoodausta.
  • name – esinelistan toinen rivi.
  • contained_item (valinnainen) – solmuun tulisi sisältyä kokonainen elementtilohko esineelle. Tätä käytetään Source-pelien paketoiduissa lahjoissa, mutta se ei välttämättä sovi pelillesi.
  • cache_expiration (valinnainen) – RFC 3339 UTC -muodossa ilmoitettu aika, jolloin vastauksen Steamin välimuisti on mitätöitävä. Käytä ainoastaan, kun jokin GetAssetClassInfo-vastauksen osa muuttuu myöhemmin, vaikka elementtiluokan ominaisuudet eivät muuttuisi. Jos esineen voi vaihtaa myöhemmin, tästä voi olla hyötyä. Suosittelemme, että pyöristät elementtiluokkaominaisuuksien aikoja (myös tässä kentässä) päivä- tai tuntirajoihin, millä parannat Steamin elementtikuvausten tallennuskykyä välimuistiin.
  • item_expiration (valinnainen) – RFC 3339 UTC -muodossa ilmoitettu aika, jolloin kohdetta ei voi enää käyttää. Mitään kauppapaikalle listattua esinettä ei voi ostaa tämän ajankohdan jälkeen, ja listaus peruutetaan automaattisesti.

    Esimerkki koodista

    { "result": { "asset": { "descriptions": [ { "name": "attribute", "value": "+50% fire damage resistance on wearer", "color": "99ccff" }, { "name": "attribute", "value": "+40% explosive damage resistance on wearer", "color": "99ccff" }, { "name": "attribute", "value": "Alt-Fire: Gain increased attack power by\ncharging toward your enemies." } ] , "fraudwarnings": [ "This item has been renamed.\nOriginal name: \"Chargin' Targe\"" ] , "tradable": true, "background_color": "3C352E", "icon_url": "http://media.steampowered.com/apps/440/icons/c_targe_large.b7d8c75ecfc9b04cc49d2c61ddc77996d7ec2f3a.png", "name": "''Awesome Targe''", "type": "Level 10 Shield", "name_color": "7D6D00", "actions": [ { "name": "Item Wiki Page...", "link": "http://wiki.teamfortress.com/scripts/itemredirect.php?id=131&lang=en_US" } ] }, "success": true } }

    economy_asset_tooltip.png

    economy_asset_icon.png