Steamworks-dokumentation
GetContexts/v0001
Returnerer kontekster, der eksisterer for den angivne bruger.

Kaldes af: Supportværktøj, byttegrænseflade, inventargrænseflade

HTTP-metode: GET

Parametre:

NavnTypePåkrævetBeskrivelse
keystringDette er "nøglen til asset serveren", som du tildelte under din apps indstillinger for Steam-økonomi på partnersiden.
appiduint3232-bit app-ID for applikationen, som er forbundet med konteksterne.
steamiduint6464-bit Steam-ID for den bruger, der skal returneres kontekster for.
parentuint6464-bit ID for den overordnede kontekst, der skal returneres underordnede kontekster for. Hvis denne parameter er 0, returneres kontekster på rodniveau.
categorystring"historik" eller "aktiver", hvis dette kaldes fra supportværktøjet. Hvis kaldet sker fra bytte- eller inventargrænsefladen, vil kategorien være "byttehandel". Dette kan være nyttigt, hvis du har kontekster, som det kun giver mening at vise i visse kategorier. Sandsynligvis vil visse kontekstkommandoer også kun give mening i visse kategorier, så du kan filtrere, hvilke kommandoer du sender baseret på kategorien. Hvis du ikke understøtter supportværktøjets API'er, er det i orden at behandle alle kategorierne ens.
commandsboolTrue, hvis kontekstkommandoerne skal inkluderes i outputtet.
languagestringISO639-1-sprogkode samt ISO 3166-1 alpha 2-landekode for det sprog, strengene skal returneres på. Eksempler: en_US, de_DE, zh_CN og ko_KR. Standard: en_US

Returværdier

Resultatet fra denne metode er kodet i JSON-format.

Svar:
  • result
    • success – true, hvis metoden lykkedes. Hvis asset serveren returnerer false, bør den angive error til en streng, som forklarer hvorfor.
    • error – en streng, som beskriver, hvorfor dette kald mislykkedes. Denne besked vil blive optaget i en fejllog, som er tilgængelig under fanen "Økonomi" på Steamworks-siden.
    • context – et array af kontekster, som er underordnet i forhold til den angivne overordende kontekst.
      • id – 64-bit ID for konteksten i dette spil for dette Steam-ID. Se Kontekst-ID'er i Steam-økonomien for mere information.
      • name – navnet på konteksten. Dette vil blive vist for supportmedarbejdere. Hvis user_facing er true, vises det også for brugere.
      • nested – Hvis denne er true, vil et efterfølgende kald til GetContexts med denne kontekst som overordnet kontekst returnere en ikke tom kontekstliste.
      • asset_count – Antallet af aktiver og valutaer, som brugeren ejer i denne kontekst. Dette antal vises for brugeren, og kontekst med asset_count = 0, vil typisk være skjult for brugeren.
      • user_facing – Hvis denne er true, og konteksten indeholder aktiver, vises det i byttegrænsefladen og inventargrænsefladen.
      • commands – Et array af kommandoer, som skal vises for denne kontekst på siden "Økonomi" i supportværktøjet. Se nedenfor for mere information om kommandoer.
    • alerts(valgfri) – Et array af advarsler, som skal vises for dette spil i byttegrænsefladen. Denne node ignoreres for alle kategorier bortset fra "byttehandel"
      • text – Lokaliseret streng, som vises i spillets byttegrænseflade.
      • color (valgfri) – Hex-farvekode for den farve, advarslen skal vises med.
    • trade_permissions (valgfri) – Brugerens tilladelsesniveau. Værdien skal være NONE, RECEIVEONLY, SENDONLY, SENDONLY_FULLINVENTORY eller FULL.
      Brugere med NONE vil ikke kunne gennemføre byttehandler med aktiver fra dette spil. Brugere med RECEIVEONLY vil kunne modtage aktiver for spillet, men ikke tilføje egne aktiver til en byttehandel. Brugere med SENDONLY vil kunne tilføje deres egne aktiver til en byttehandel, men ikke modtage aktiver for spillet. Brugere med SENDONLY_FULLINVENTORY har samme restriktioner som SENDONLY, men brugeren får besked om, at restriktionen skyldes, at personens inventar for spillet er fyldt. Brugere med tilladelsen FULL kan tilføje deres egne genstande til en byttehandel, som er markeret som "kan byttes", eller modtage genstande, som kan byttes, fra deres byttepartner. Denne node ignoreres for alle kategorier bortset fra "byttehandel". Standard: FULL.

Kommandoer

Hver kontekst kan indeholde kommandoer, som gør det muligt for supportmedarbejdere at manipulere brugerens aktiver. Disse vises kun på siden "Økonomi" i supportværktøjet. De bruges til operationer såsom at tilføje nye genstande, genindlæse kontoen og slette genstande. Når en kommando udføres, kaldes ContextCommand/v0001. Hver kommando har følgende parametre:
  • name – navnet på kommandoen. Dette vises i supportværktøjet og returneres til ContextCommand.
  • description – Beskrivelse af, hvad kommandoen gør. Dette vises for supportmedarbejderen i bekræftelsesdialogboksen.
  • record_note – Hvis denne er true, får supportmedarbejderen en prompt om at indtaste en note i aktivitetshistorikken for kontoen.
    False skal returneres for kommandoer, som ikke ændrer brugerens oplysninger (for eksempel en kommando om at genindlæse brugeren fra databasen).
    (Standard: True)
  • asset_command (valgfri) – Hvis denne er true, vises kommandoen på hvert aktiv i konteksten i stedet for på selve konteksten.
    Hvis en supportmedarbejder udfører denne kommando for en kontekst, vil det yderligere argument assetid blive tilføjet til det resulterende kald til ContextCommand.

  • options – Et array af indstillinger, som vises i bekræftelsesdialogen.
    • name – navnet på indstillingen.
    • type – Kontrolelementtypen, der vises for indstillingen. Supporttyperne er: checkbox, dropdown, numeric og type_picker.
    • default – Standard for denne indstilling. Dette er en boolesk værdi for checkbox-indstillinger og navnet på værdien for dropdown-indstillinger.
    • supervisor_only – Denne er true, hvis kun et begrænset sæt supportmedarbejdere skal have adgang til denne indstilling. For alle andre medarbejdere bruges standarden.
    • values – Et array af mulige værdier for dropdown-indstillingerne. Dette bruges ikke til andre indstillingstyper.
      • name – Navnet, som vises for supportmedarbejderen for denne værdi.
      • value – Værdi, der returneres i ContextCommand, hvis denne vælges i rullemenuen.

    • types – Array af typer, der vises i type_picker-indstillingerne. Dette bruges ikke til andre indstillingstyper.
      • name – navnet på typen.
      • value – Værdi, der returneres for denne type.
      • icon_url – URL for ikonet, som vises ved siden af denne type i picker-elementet.
      • tags – Et array af tags, som vises under samme navne i picker-elementet.

Eksempeloutput

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