Créer une promotion par bonus

La promotion ajoute des objets bonus gratuits à l'achat effectué par l'utilisateur. La promotion peut être appliquée à chaque achat au sein d'un projet ou à un achat comprenant des objets particuliers.

SecuritybasicAuth

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

required

Array of objects or null

Ensemble d'objets devant être inclus dans l'achat pour l'application d'une promotion. Si ce paramètre est défini sur null, la promotion s'applique à tous les achats effectués dans au sein du projet.

Array

sku	string Default: "elven_sword" UGS de l'objet.

required

Array of objects or null

Array

quantity	number Default: 1 Quantité de l'objet.
sku	string Default: "elven_shield" UGS de l'objet.

required

object

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

property name*

additional property

string

Array of type = string (objects) or Array of type = date (objects) or Array of type = number (objects)

One of:

[ 1 .. 100 ] items

Array ([ 1 .. 100 ] items)

attribute

required

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

Code d'attribut utilisateur.

operator

required

string

Type d'opération effectuée par la condition. Pour le type d'attribut string.

Enum:	Description
eq	Égal
ne	Différent de

value

required

string <= 255 characters

Valeur de la condition à laquelle la valeur de l'attribut utilisateur sera comparée. Le type dépend du type d'attribut.

type

required

string

Type d'attribut utilisateur.

Value: "string"

can_be_missing

boolean

Indique que la condition est remplie même si l'attribut est absent des attributs de l'utilisateur. Passez true pour afficher l'objet pour les utilisateurs ne possédant pas cet attribut. Les utilisateurs ayant l'attribut, mais dont la valeur ne correspond pas à celle définie dans la condition ne verront pas l'objet. Si vous passez false, les utilisateurs dont l'attribut est manquant ou dont la valeur ne correspond pas à celle spécifiée dans la condition ne verront pas l'objet.

date_end

string or null <date-time>

Default: "2020-04-15T18:16:00+05:00"

Date de fin de la promotion. Peut prendre la valeur null. Si date_end est défini sur null, la promotion sera illimitée dans le temps.

date_start

string or null <date-time>

Default: "2020-04-15T18:16:00+05:00"

Date de début de la promotion.

excluded_promotions

Array of integers

Liste des ID de promotion à exclure lors de l'application de cette promotion.
Example: [12, 789]

integer

ID de la promotion. Identifiant unique de la promotion au sein du projet.

object

Limites de la promotion.

per_user

integer or null

Limites de la promotion 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).

Array of objects or null

Tableau d'objets avec des conditions définissant la fourchette de prix pour l'application de la promotion.
La promotion ne s'applique qu'aux biens dont le prix répond à toutes les conditions du tableau. Si vous passez ce tableau, définissez la valeur de l'objet condition sur null.

Array

operator

required

string

Opérateur de comparaison pour définir la fourchette de prix pour l'application de la promotion.

Enum:	Description
eq	Égal
ge	Supérieur ou égal
gt	Supérieure à
le	Inférieur ou égal
lt	Inférieur à
ne	Différent de

value

required

string^\\d+(\\.\\d{1,4})?$

Valeur permettant de déterminer la fourchette de prix pour l'application de la promotion.

Responses

201

La promotion a été créée avec succès.

401

L'authentification de base n'a pas été passée ou est incorrecte. Vérifiez que vous avez utilisé l'authentification de base ou des informations d'identification correctes.

422

Requête non valide.

Request samples

application/json

{"attribute_conditions": [{"attribute": "account_status",
"can_be_missing": false,
"operator": "eq",
"type": "string",
"value": "golden"
}
],
"bonus": [{"quantity": 50000,
"sku": "com.xsolla.mp_credits"
}
],
"condition": [{"sku": "com.xsolla.year_1_season_pass"
}
],
"date_end": "2020-04-25T18:16:00+05:00",
"date_start": "2020-04-15T18:16:00+05:00",
"name": {"de-DE": "Neujahrsbonus",
"en-US": "New Year Bonus"
}
}

Response samples

application/json

{"promotion_id": 2384756
}