Steamworks-dokumentaatio
GetContexts/v0001
Tämä palauttaa kontekstit, jotka määritetyllä käyttäjällä on.

Kutsuja: Tuen työkalu, vaihtokauppojen käyttöliittymä, tavaraluettelokäyttöliittymä

HTTP-metodi: GET

Parametrit:

NimiTyyppiPakollinenKuvaus
keystringTämä on elementtipalvelimen tunnus, jonka annoit kumppanisivulla, sovelluksesi Steam-talouden asetuksissa.
appiduint32Konteksteihin liittyvän sovelluksen 32-bittinen AppID-sovellustunnus.
steamiduint64Käyttäjän 64-bittinen SteamID-tunnus, jolla kontekstit palautetaan.
parentuint64Pääkontekstin 64-bittinen tunnus, jolla palautetaan alikonteksteja. Jos parametrin arvo on nolla, se palauttaa päätason kontekstit.
categorystringJos parametriä kutsutaan tukityökalulla, luokka on history (historia) tai assets (elementit). Jos kutsu tehdään vaihtokaupan tai tavaraluettelon käyttöliittymästä, luokka on trading (vaihtokauppa). Tästä voi olla hyötyä, jos sinulla on konteksteja, joita on järkevää käyttää vain tietyissä luokissa. Koska jotkin kontekstikomennot ovat hyödyllisiä vain silloin, kun niitä käytetään tietyissä luokissa, voit suodattaa lähettämiäsi komentoja luokan perusteella. Jos et käytä tukityökalun ohjelmointirajapintoja, voit käsitellä kaikkia luokkia samalla tavalla.
commandsboolJos kontekstikomennot on tarkoitus palauttaa, arvon tulee olla true (tosi).
languagestringPalautettavien merkkijonojen ISO 639-1 -kielikoodi ja kaksikirjaiminen ISO 3166-1 alpha-2 -maakoodi. Esimerkiksi en_US, de_DE, zh_CN tai ko_KR. Oletusarvo on en_US.

Paluuarvot:

Metodin palautuksen tulisi olla koodattu JSON-muodossa.

Vastaus:
  • result
    • success – True (tosi), jos metodi onnistui. Jos elementtipalvelin palauttaa false (epätosi), tulisi se määrittää error merkkijonoon, joka selittää sen syyn.
    • error – Merkkijono, joka kertoo syyn kutsun epäonnistumiselle. Tämä viesti tallennetaan virhelokiin, joka on saatavilla Steamworks-sivuston Talous-välilehdeltä.
    • contexts – kontekstien taulukko, jotka ovat tietyn isäntien alikohteita.
      • id – 64-bittinen kontekstitunnus tietyn pelin SteamID-tunnukselle. Lisätietoja: Steam-talouden kontekstitunnukset.
      • name – kontekstin nimi. Tämä näytetään Steamin tuen asiakaspalvelijalle. Jos user_facing on true (tosi), se näkyy myös käyttäjille.
      • nested – Jos tämä on true (tosi), seuraava GetContexts-kutsu, jossa konteksti on isäntänä, palauttaa kontekstilistan, joka ei ole tyhjä.
      • asset_count – Käyttäjän omistamien elementtien ja valuuttojen määrä tässä kontekstissa. Luku näytetään käyttäjälle. Konteksti, jonka asset_count on nolla, piilotetaan yleensä käyttäjältä.
      • user_facing – Jos tämä on true (tosi) ja konteksti sisältää elementtejä, se näytetään esinevaihto- tai tavaraluettelokäyttöliittymässä.
      • commands – Valitun kontekstin komennot sisältävä taulukko, joka on näkyvissä tukityökalun Talous-sivulla. Jäljempänä on lisätietoja komennoista.
    • alerts (valinnainen) – Ilmoitusten taulukko, jota voidaan näyttää pelin esinevaihtojen käyttöliittymässä. Tämä solmu ohitetaan, jos luokka ei ole "trading".
      • text – Lokalisoitu merkkijono, joka näytetään pelin esinevaihtojen käyttöliittymässä.
      • color (valinnainen) – Ilmoituksen värin heksadesimaalivärikoodi.
    • trade_permissions (valinnainen) – Käyttäjän esinevaihto-oikeudet. Tilan tulee olla yksi seuraavista: NONE, RECEIVEONLY, SENDONLY, SENDONLY_FULLINVENTORY, FULL.
      Jos käyttäjällä on arvona NONE, hän ei voi vaihtaa eikä vastaanottaa pelin elementtejä. Jos käyttäjällä on RECEIVEONLY-tila, hän voi vastaanottaa muttei lisätä omia elementtejä vaihdettaviksi. Jos käyttäjällä on SENDONLY-tila, hän voi lisätä elementtejä vaihdettaviksi muttei voi vastaanottaa niitä. SENDONLY_FULLINVENTORY-tilassa on samat rajoitukset kuin SENDONLY-tilassa, mutta käyttäjälle ilmoitetaan, että rajoitukset johtuvat siitä, että pelin tavaraluettelo on täynnä. Jos käyttäjällä on täydet FULL-oikeudet ja esineet on merkitty vaihtokelpoisiksi, hän voi lisätä omia tai vastaanottaa esineitä vaihtokumppanilta. Tämä solmu ohitetaan, jos luokka ei ole "trading". Oletus: FULL.

Komennot

Tuen asiakaspalvelijat voivat kunkin kontekstin komennoilla käsitellä käyttäjän elementtejä. Ne näkyvät vain tukityökalun Talous-sivulla. Komennoilla lisätään uusia esineitä, ladataan tili uudelleen ja poistetaan esineitä. Kun komento on suoritettu, kutsutaan ContextCommand/v0001. Jokainen komento on määritetty seuraavasti:
  • name – Komennon nimi. Tämä näytetään tuen työkalussa ja palautetaan ContextCommand-komentoon.
  • description – Kuvaus komennon toiminnosta. Tämä näkyy tuen asiakaspalvelijalle vahvistusikkunassa.
  • record_note – Jos tämä on true (tosi), tuen asiakaspalvelijaa pyydetään kirjaamaan huomio ylös tilin asiakastukihistoriaan.
    False (epätosi) tulisi palauttaa komennoille, jotka eivät tee muutoksia käyttäjän tietoihin (esim. käyttäjätietojen uudelleenlatauskomento tietokannasta).
    (Oletus: true)
  • asset_command(valinnainen) – Jos tämä on true (tosi), komento näkyy kontekstin sijaan kontekstin jokaisessa elementissä.
    Jos tuen asiakaspalvelija suorittaa komennon kontekstissa, lisätään assetid syntyvän kutsuun, jossa kutsutaan ContextCommand.

  • options – Asetusten taulukko, joka näytetään vahvistusikkunassa.
    • name – Asetuksen nimi.
    • type – Asetuksen ohjaintyyppi. Tukityyppejä ovat valintaruutu, pudotusvalikko, numeroin ilmaistava ja type_picker.
    • default – Oletuksena tässä asetuksessa. Tämä on valintaruudun Boolen-totuusarvo ja pudotusvalikoiden arvon nimi.
    • supervisor_only – True (tosi), jos vain rajallisella määrällä asiakastukihenkilöillä on käyttöoikeus tähän asetukseen. Muiden asiakastuen henkilöiden kohdalla käytetään oletusarvoa.
    • values – Taulukko pudotusvalikon vaihtoehtojen mahdollisista arvoista. Ei voi käyttää muissa asetustyypeissä.
      • name – Arvon nimi, joka näytetään asiakastuen henkilölle.
      • value – Arvo joka palautetaan komennossa ContextCommand, jos tämä valitaan pudotusvalikosta.

    • types – Valikoima tyyppejä, jotka näytetään type_picker-asetuksissa. Nämä eivät ole voimassa muille asetustyypeille.
      • name – Tyypin nimi.
      • value – Tälle tyypille palautettava arvo.
      • icon_url – Kuvakkeen URL-osoite, joka näytetään ohjausobjektin tyypin vieressä.
      • tags – Tunnistetaulukko, joka näytetään nimen alla tyyppivalitsimessa.

Esimerkki koodista

{ "result": { "success": true, "contexts": [ { "id": 2, "name": "Backpack", "nested": false, "commands": [ { "name": "Reload", "description": "Reload the user's information from the database.", "record_note": false }, { "name": "Delete All", "description": "Delete all of the user's items.", "options": [ { "name": "Delete Purchased Items", "type": "checkbox", "default": false } ] }, { "name": "Add Item", "description": "Adds an item for the user. Please don't set Quality, Particle Effect, or Level unless you know what you're doing.", "options": [ { "name": "Quality", "type": "dropdown", "default": "unique", "values": [ { "name": "Any", "value": "Any" }, { "name": "Normal", "value": "normal" }, { "name": "Genuine", "value": "rarity1" }, { "name": "Vintage", "value": "vintage" }, { "name": "Unusual", "value": "rarity4" } ] }, { "name": "Particle Effect", "type": "dropdown", "default": "none", "values": [ { "name": "None", "value": 0 }, { "name": "burningplayer_red", "value": 1 }, { "name": "burningplayer_flyingbits", "value": 2 } ] }, { "name": "Level", "type": "numeric", "default": 0 }, { "name": "Not Tradable", "type": "checkbox", "default": false }, { "name": "Not Usable In Crafting", "type": "checkbox", "default": false }, { "name": "Item Type", "type": "type_picker", "types": [ { "value": "The Kritzkrieg", "icon_url": "http://media.steampowered.com/apps/440/icons/c_overhealer.b5ed539b534216652b45694e19c78d2aaebcfe5e.png", "name": "Kritzkrieg", "tags": [ "Slot: secondary", "Used By: Medic" ] }, { "value": "The Blutsauger", "icon_url": "http://media.steampowered.com/apps/440/icons/c_leechgun.198c5a7943a16f08b5227f2e84d165c153ed0223.png", "name": "Blutsauger", "tags": [ "Slot: primary", "Used By: Medic" ] } ] } ] }, { "name": "Delete Item", "asset_command": true, "description": "Delete an item" } ] , "asset_count": 180, "user_facing": true }, { "id": 3, "name": "Recipes", "nested": false, "asset_count": 0, "user_facing": false } ] , "alerts": [ ] , "trade_permissions": "FULL" } }