Créer une chaîne d'offres

Conteneur objet contenant les localisations du nom de l'objet (item). Il accepte deux formats de codes de langue : les codes à deux lettres minuscules (comme en) et les codes régionaux à cinq caractères (comme en-US). Les deux formats sont valides en entrée, mais les réponses utilisent toujours le format à deux lettres. Si les deux variantes sont fournies pour une même langue (par exemple, en et en-US), seule la dernière est conservée. Consultez la documentation pour la liste complète des langues prises en charge.

One of:

Codes de langue à deux lettres minuscules.

ar	string or null Arabe
bg	string or null Bulgare
cn	string or null Chinois (simplifié)
cs	string or null Tchèque
de	string or null Allemand
en	string or null Anglais
es	string or null Espagnol (Espagne)
fr	string or null Français
he	string or null Hébreu
id	string or null Indonésien
it	string or null Italien
ja	string or null Japonais
km	string or null Khmer
ko	string or null Coréen
lo	string or null Laotien
my	string or null Birman
ne	string or null Népalais
ph	string or null Philippin
pl	string or null Polonais
pt	string or null Portugais
ro	string or null Roumain
ru	string or null Russe
th	string or null Thaï
tr	string or null Turc
tw	string or null Chinois (traditionnel)
vi	string or null Vietnamien

date_start

required

string <date-time>

Date de début de la chaîne d'offres.

required

Array of objects

Array

step_number

required

integer >= 1

Numéro de l'étape.

is_free

required

boolean

Indique si l'étape de la chaîne d'offres est gratuite :

Si true, l'étape doit être réclamée à l'aide de l'appel Réclamer une étape de chaîne d'offres gratuite.
Si false, elle doit être achetée à l'aide de l'appel Créer une commande pour une étape payante de la chaîne d'offres.

required

Array of objects non-empty

Array (non-empty)

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 et majuscules, des points, des tirets et des traits bas.
quantity required	integer >= 1 Quantité d'objets de récompense pour cette étape de la chaîne.
order	integer or null >= 0 Ordre des récompenses pour l'étape de la chaîne d'offres.

is_enabled

required

boolean

Array of type = string (object) or type = number (object) or type = date (object) [ 1 .. 100 ] items

Conditions de validation des attributs utilisateur. Déterminez la disponibilité de la chaîne selon la correspondance des attributs utilisateur avec l'ensemble des conditions définies.

Array ([ 1 .. 100 ] items)

One of:

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>

Date de fin de la chaîne d’offres. Peut être null. Si date_end est null, la chaîne d'offres n'a pas de limite de temps.

(two-letter (object or null)) or (five-letter (object or null))

Conteneur objet contenant les localisations de la description de l'objet (item). Il accepte deux formats de codes de langue : les codes à deux lettres minuscules (comme en) et les codes régionaux à cinq caractères (comme en-US). Les deux formats sont valides en entrée, mais les réponses utilisent toujours le format à deux lettres. Si les deux variantes sont fournies pour une même langue (par exemple, en et en-US), seule la dernière est conservée. Consultez la documentation pour la liste complète des langues prises en charge.

One of:

Codes de langue à deux lettres minuscules.

ar	string or null Arabe
bg	string or null Bulgare
cn	string or null Chinois (simplifié)
cs	string or null Tchèque
de	string or null Allemand
en	string or null Anglais
es	string or null Espagnol (Espagne)
fr	string or null Français
he	string or null Hébreu
id	string or null Indonésien
it	string or null Italien
ja	string or null Japonais
km	string or null Khmer
ko	string or null Coréen
lo	string or null Laotien
my	string or null Birman
ne	string or null Népalais
ph	string or null Philippin
pl	string or null Polonais
pt	string or null Portugais
ro	string or null Roumain
ru	string or null Russe
th	string or null Thaï
tr	string or null Turc
tw	string or null Chinois (traditionnel)
vi	string or null Vietnamien

is_always_visible

boolean

Default: true

Détermine la visibilité de la chaîne pour tous les utilisateurs :

Si true, la chaîne s'affiche toujours, indépendamment du statut d'authentification ou des attributs de l'utilisateur.
Si false, la chaîne s'affiche uniquement si aucune chaîne personnalisée ne correspond ; par exemple, si l'utilisateur n'est pas authentifié ou si ses attributs ne correspondent à aucune chaîne personnalisée.

S'applique seulement dans le cadre des chaînes personnalisées et uniquement si le tableau attribute_conditions n'est pas passé.

order

integer

Définit l'ordre d'empilement.

(interval_type = weekly (object or null)) or (interval_type = monthly (object or null)) or (interval_type = hourly (object or null))

Période de réinitialisation de la chaîne d'offres.

One of:

Réinitialisation hebdomadaire de la chaîne d'offres.

interval_type required	string Fréquence de réinitialisation de la chaîne d'offres. Value: "weekly"
time required	string((0[0-9]\|1[0-9]\|2[0-3]):00:00)(\+\|-)(0[0-9]\|1... Heure à laquelle la chaîne d'offres est réinitialisée dans le fuseau horaire spécifié (arrondi aux heures). Par exemple, si l'heure de réinitialisation est fixée à 1 h, heure de Kuala Lumpur (GMT+8), la valeur du paramètre `time` est `01:00:00+08:00`.
day_of_week required	integer [ 1 .. 7 ] Jour de la semaine où la chaîne d'offres est réinitialisée, où `1` est le lundi et `7`, le dimanche.

Responses

201

Chaîne d'offres 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

Configuration de la chaîne d'offres non valide.

Request samples

application/json

{"date_end": null,
"date_start": "2023-04-15T18:16:00+05:00",
"description": {"de": "Eine kurze Beschreibung einer regulären Angebotskette",
"en": "A short description of a regular offer chain",
"fr": "Une brève description d'une chaîne d'offres régulière",
"it": "Una breve descrizione di una catena di offerte regolare",
"ru": "Краткое описание обычной цепочки предложений"
},
"is_always_visible": true,
"is_enabled": true,
"name": {"de": "Neue Angebotskette",
"en": "New offer chain",
"fr": "Nouvelle chaîne d'offres",
"it": "Nuova catena di offerte",
"ru": "Новая цепочка предложений"
},
"order": 4,
"recurrent_schedule": null,
"steps": [{"is_free": false,
"items": [{"quantity": 2,
"sku": "chain_step_1_paid_bundle_sku"
}
],
"step_number": 1
},
{"is_free": true,
"items": [{"quantity": 1,
"sku": "chain_step_2_free_virtual_good_sku"
}
],
"step_number": 2
},
{"is_free": false,
"items": [{"quantity": 5,
"sku": "chain_step_3_paid_virtual_currency_package_sku"
}
],
"step_number": 3
},
{"is_free": true,
"items": [{"quantity": 1,
"sku": "chain_step_4_free_bundle_sku"
}
],
"step_number": 4
}
]
}

Response samples

application/json

{"offer_chain_id": 10
}