Mettre à jour une promotion par bonus

Note

Les nouvelles données remplaceront les anciennes. Si vous souhaitez mettre à jour une promotion partiellement, assurez-vous de passer toutes les données requises dans la requête.

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
promotion_id required	integer ID de la promotion. Identifiant unique de la promotion au sein du projet. Example: 111425

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.

object

Délai d'actualisation des limites pour un utilisateur.

day_of_month	integer or null [ 1 .. 31 ] Jour du mois où les limites sont actualisées. Si aucun jour du mois n'est sélectionné en raison d'un mois plus court, l'actualisation aura lieu le dernier jour du mois. Ne prend pas la valeur `null`. Uniquement pour le type de délai d'actualisation de limites `monthly`.
day_of_week	integer or null [ 1 .. 7 ] Jour de la semaine où les limites sont actualisées. Où 1 correspond au lundi et 7 au dimanche. Ne prend pas la valeur `null`. Uniquement pour le type de délai d'actualisation de limites `weekly`.
displayable_reset_next_date	string <date-time> Date et heure de réinitialisation des limites (ISO 8601).
displayable_reset_start_date	string <date-time> Date et heure de la première actualisation des limites (ISO 8601).
interval_type	string Type de délai d'actualisation récurrent. Enum: "daily" "weekly" "monthly"
reset_next_date	integer Date et heure d'actualisation des limites (horodatage Unix).
time	string <full-time> 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

204

La promotion a été mise à jour 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

Demande 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

{"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred",
"statusCode": 401
}