Créer une campagne

Xsolla Developers

Créer une campagneServer-sideAdmin

post/merchants/{merchant_id}/coupon_promotions

Créez une nouvelle campagne de coupons.

Remarque

Cet appel API ne contient pas le paramètre de cheminproject_id, vous devez donc utiliser la clé API valide dans tous les projets de l'entreprise pour l'autorisation.

SecuritybasicAuth

Request

path Parameters

merchant_id

required

integer

ID de commerçant.

Request Body schema: application/json

campaign_code

required

string

Nom de campagne.

project_id

required

integer

ID de projet.

required

object

Noms localisés de la campagne.

ar	string Arabe.
bg	string Bulgare.
cn	string Chinois (simplifié).
cs	string Tchèque.
de	string Allemand.
en	string Anglais.
es	string Espagnol.
fr	string Français.
he	string Hébreu.
it	string Italien.
ja	string Japonais.
ko	string Coréen.
pl	string Polonais.
pt	string Portugais.
ro	string Roumain.
ru	string Russe.
th	string Thaïlandais.
tr	string Turc.
tw	string Chinois (traditionnel).
vi	string Vietnamien.

campaign_redeems_count_for_user

integer

Nombre maximal de coupons que l'utilisateur peut échanger dans le cadre de la campagne. Si null est passé, le nombre d'utilisations est illimité.

expiration_date

string <datetime>

Date de fin de la campagne au format YYYY-MM-DD’T’HH:MM:SS selon la norme ISO 8601.

redeems_count

integer

Nombre maximal de coupons à échanger. Si null est passé, le nombre d'utilisations est illimité.

redeems_count_for_user

integer

Nombre maximal de coupons que l'utilisateur peut échanger. Si null est passé, le nombre d'utilisations est illimité.

object

Paramètres de l'abonnement dans la récompense.

plan_id required	integer ID de plan d'abonnement.
product_id required	integer ID du produit d'abonnement.
trial_period required	integer Durée de la période d'essai en jours.

virtual_currency_amount

number <float>

Quantité de la monnaie virtuelle dans la récompense.

object

Tableau des paramètres des objets virtuels dans la récompense.

sku required	string UGS de l'objet virtuel.
quantity required	integer Quantité d'objets virtuels.

Responses

201

Created.

Request samples

application/json

{"campaign_code": "sample_campaign",
"campaign_names": {"en": "Campaign Name",
"ru": "Название кампании"
},
"campaign_redeems_count_for_user": 1,
"expiration_date": "2019-12-31",
"project_id": 12345,
"redeems_count": 10,
"redeems_count_for_user": 1,
"subscription_coupon": {"plan_id": 123,
"product_id": 456,
"trial_period": 30
},
"virtual_currency_amount": 200
}

Response samples

application/json

{"id": 9134
}