Créer une monnaie virtuelle

Créer une monnaie virtuelleServer-sideAdmin

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

Crée une monnaie virtuelle.

Request

path Parameters

project_id

required

integer

ID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.

Example: 44056

Request Body schema: application/json

sku

required

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

ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules, des points, des tirets et des traits bas.

required

object

Objet contenant les versions localisées du nom de l'objet. Code de langue à deux lettres minuscules.

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 des attributs.

Attention. La création de plus de 20 attributs pour un objet n'est pas autorisée. Toute tentative de dépassement entraîne une erreur.

Array (<= 20 items)

external_id

required

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

ID unique de l'attribut. Le paramètre external_id ne peut comprendre que des caractères alphanumériques latins minuscules, des tirets et des traits bas.

required

Array of objects

Attention. La création de plus de 6 valeurs pour un attribut n'est pas autorisée. Toute tentative de dépassement entraînera une erreur.

Array

required

object

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

Objet contenant des versions localisées du nom de la valeur. Les clés sont spécifiées selon la norme ISO 3166-1.

property name*

additional property

string

external_id

required

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

ID unique de la valeur d'un attribut. Le external_id ne peut comprendre que des caractères alphanumériques latins minuscules, des tirets et des tirets bas.

object

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

Objet contenant des versions localisées du nom de l'attribut. Les clés sont spécifiées selon la norme ISO 3166-1.

property name*

additional property

string

custom_attributes

object <json> <= 500 characters

Un JSON contenant les attributs de l'objet et leurs valeurs. Les attributs permettent d'ajouter des informations supplémentaires aux objets, telles que le niveau requis du joueur pour utiliser l'objet. Les attributs enrichissent la logique interne de votre jeu et sont accessibles via des méthodes GET et des webhooks spécifiques.

object

Objet contenant les versions localisées de la description de l'objet. Code de langue à deux lettres minuscules.

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: []

Groupes auxquels l'objet appartient.

Array

external_id

string

object

Default: {"en":"Horror"}

Nom de l'objet. Doit comprendre des paires clé/valeur où la clé est une région au format "^[a-z]{2}", la valeur est une chaîne.

additionalProperties

string

image_url

string

is_deleted

boolean

is_enabled

boolean

is_free

boolean

Default: false

Si ce paramètre est défini sur true, l'objet est gratuit.

is_hard

boolean

is_show_in_store

boolean

object

Limites d'objets.

per_item

integer or null

Limites globales d'objets.

per_user

integer or null

Limites d'objets pour un utilisateur spécifique.

object or null

Délai d'actualisation des limites.

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

One of:

Type quotidien d'actualisation des limites pour l'utilisateur.

interval_type required	string Délai d'actualisation récurrent. Value: "daily"
time required	string((0[0-9]\|1[0-9]\|2[0-3]):00:00)(\+\|-)(0[0-9]\|1... Heure d'actualisation des limites dans le fuseau horaire souhaité (arrondie en heures).

object

Objet contenant les versions localisées de la description détaillée de l'objet. Code de langue à deux lettres minuscules.

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

Ressources supplémentaires de l'objet, telles que des captures d'écran, des vidéos de gameplay, etc.

Array

type	string Type de média : `image`/`video`. Enum: "image" "video"
url	string Fichier de ressources.

order

integer

Définit l'ordre d'empilement.

Array of objects or null

Période de vente d'objets.

Array

date_from	string <date-time> Date de mise en vente de l'objet spécifié.
date_until	string or null <date-time> Date de retrait de la vente de l'objet spécifié. Peut prendre la valeur `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 Montant.
currency required	string Devise du prix de l'article. Code à trois lettres selon ISO 4217. Consultez la documentation pour obtenir des informations détaillées sur les devises prises en charge par Xsolla.
country_iso	string or null Pays où ce prix est disponible. Code à deux lettres selon la norme 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 Le prix est activé.
sku	string ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules, des points, des tirets et des traits bas.

Responses

201

L'objet virtuel a été créé avec succès.

422

Requête non valide.

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