Virtuelle Währung erstellen

Virtuelle Währung erstellenServer-sideAdmin

post/v2/project/{project_id}/admin/items/virtual_currency

Erstellt eine virtuelle Währung.

Request

path Parameters

project_id

required

integer

Projekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt.

Example: 44056

Request Body schema: application/json

sku

required

string [ 1 .. 255 ] characters ^[a-zA-Z0-9_\\-–.]*$

Eindeutige Artikel-ID. Die SKU darf nur lateinische alphanumerische Kleinbuchstaben, Punkte, Bindestriche und Unterstriche enthalten.

required

object

Objekt mit lokalisierten Namen des Artikels. Sprachencode bestehend aus zwei Kleinbuchstaben.

ar	string or null
bg	string or null
cn	string or null
cs	string or null
de	string or null
en	string or null
es	string or null
fr	string or null
he	string or null
it	string or null
ja	string or null
ko	string or null
pl	string or null
pt	string or null
ro	string or null
ru	string or null
th	string or null
tr	string or null
tw	string or null
vi	string or null

Array of objects <= 20 items

Liste der Attribute.

Achtung: Sie können für den Artikel maximal 20 Attribute angeben. Jeder Versuch, das Limit zu überschreiten, führt zu einem Fehler.

Array (<= 20 items)

external_id

required

string [ 1 .. 255 ] characters ^[a-zA-Z0-9-_]+$

Eindeutige Attribut-ID. Die external_id darf nur lateinische Kleinbuchstaben, alphanumerische Zeichen, Binde- und Unterstriche enthalten.

required

Array of objects

Achtung: Sie können für jedes Attribut maximal 6 Werte erstellen. Jeder Versuch, das Limit zu überschreiten, führt zu einem Fehler.

Array

required

object

Default: {"de":"Strategie","en":"Strategy"}

Objekt mit lokalisierten Wertnamen. Schlüssel sind in ISO 3166-1 spezifiziert.

property name*

additional property

string

external_id

required

string [ 1 .. 255 ] characters ^[-_.\d\w]+$

Eindeutige Wert-ID für ein Attribut. Die external_id darf nur lateinische Kleinbuchstaben, alphanumerische Zeichen, Binde- und Unterstriche enthalten.

object

Default: {"de":"Genre","en":"Genre"}

Objekt mit lokalisierten Attributnamen. Schlüssel sind in ISO 3166-1 spezifiziert.

property name*

additional property

string

custom_attributes

object <json> <= 500 characters

Ein JSON-Objekt mit den Artikelattributen und ‑werten. Attribute ermöglichen es Ihnen, Artikeln weitere Informationen hinzuzufügen, z. B. das Mindestlevel des Spielers, um den Artikel verwenden zu können. Attribute bereichern die interne Logik Ihres Spiels und sind über spezielle GET-Methoden und Webhooks abrufbar.

object

Objekt mit lokalisierten Beschreibungen des Artikels. Sprachencode bestehend aus zwei Kleinbuchstaben.

ar	string or null
bg	string or null
cn	string or null
cs	string or null
de	string or null
en	string or null
es	string or null
fr	string or null
he	string or null
it	string or null
ja	string or null
ko	string or null
pl	string or null
pt	string or null
ro	string or null
ru	string or null
th	string or null
tr	string or null
tw	string or null
vi	string or null

Array of objects

Default: []

Gruppen, zu denen der Artikel gehört.

Array

external_id

string

object

Default: {"en":"Horror"}

Name des Artikels. Sollte Schlüssel-Wert-Paare enthalten, wobei der Schlüssel ein Gebietsschema im Format "^[a–z]{2}" und der Wert ein String ist.

additionalProperties

string

image_url

string

is_deleted

boolean

is_enabled

boolean

is_free

boolean

Default: false

Ist true eingestellt, ist der Artikel kostenlos.

is_hard

boolean

is_show_in_store

boolean

object

Artikelbeschränkungen.

per_item

integer or null

Globale Artikelbeschränkung.

per_user

integer or null

Artikelbeschränkung für einen separaten Benutzer.

object or null

Aktualisierungszeitraum begrenzen.

interval_type = daily (object) or interval_type = weekly (object) or interval_type = monthly (object)

One of:

Tägliche Aktualisierung der Benutzerlimits.

interval_type required	string Wiederkehrender Aktualisierungszeitraum. Value: "daily"
time required	string((0[0-9]\|1[0-9]\|2[0-3]):00:00)(\+\|-)(0[0-9]\|1... Zeitpunkt der Limitaktualisierung in der gewünschten Zeitzone (auf Stunden gerundet).

object

Objekt mit lokalisierten langen Beschreibungen des Artikels. Sprachencode bestehend aus zwei Kleinbuchstaben.

ar	string or null
bg	string or null
cn	string or null
cs	string or null
de	string or null
en	string or null
es	string or null
fr	string or null
he	string or null
it	string or null
ja	string or null
ko	string or null
pl	string or null
pt	string or null
ro	string or null
ru	string or null
th	string or null
tr	string or null
tw	string or null
vi	string or null

Array of objects

Zusätzliche Medieninhalte des Artikels wie Screenshots, Gameplay-Videos usw.

Array

type	string Medieninhaltstyp: `image`/`video`. Enum: "image" "video"
url	string Ressourcendatei.

order

integer

Definiert die Anordnungsreihenfolge.

Array of objects or null

Artikelangebotszeitraum.

Array

date_from	string <date-time> Datum, an dem der angegebene Artikel zum Verkauf angeboten wird.
date_until	string or null <date-time> Datum, an dem der angegebene Artikel nicht mehr zum Verkauf angeboten wird. Möglich ist: `null`.

object

release_date required	string or null <date-time>
is_enabled required	boolean
description	string or null

Array of objects

Array

amount required	number > 0 Betrag.
currency required	string Währung des Artikelpreises. Dreistelliger Code pro ISO 4217. Detaillierte Informationen zu Von Xsolla unterstützte Währungen.
country_iso	string or null Land, in dem dieser Preis gilt. Code bestehend aus zwei Buchstaben gemäß ISO 3166-1 Alpha 2.
is_default	boolean Default: false
is_enabled	boolean Default: true

Array of objects

Array

id	integer >= 1

Array of objects

Array

amount required	integer
is_default required	boolean Default: false
is_enabled required	boolean Default: false Der Preis ist aktiviert.
sku	string Eindeutige Artikel-ID. Die SKU darf nur lateinische alphanumerische Kleinbuchstaben, Punkte, Bindestriche und Unterstriche enthalten.

Responses

201

Virtueller Gegenstand wurde erfolgreich erstellt.

422

Ungültige Anfrage.

Request samples

application/json

{"attributes": [{"external_id": "material",
"name": {"en-US": "Material"
},
"values": [{"external_id": "gold",
"value": {"en-US": "Gold"
}
}
]
}
],
"custom_attributes": {"attr": "value",
"purchased": 0
},
"description": {"de-DE": "Die Hauptwährung deines Königreichs",
"en-US": "The main currency of your kingdom"
},
"groups": ["gold"
],
"is_enabled": true,
"is_free": false,
"limits": {"per_item": 10000,
"per_user": 5
},
"name": {"de-DE": "Goldmünze",
"en-US": "Gold coin"
},
"order": 1,
"periods": [{"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"prices": [{"amount": 100,
"currency": "USD",
"is_default": true,
"is_enabled": true
}
],
"sku": "coin"
}

Response samples

application/json

{"sku": "new-sku"
}