Bonusaktion erstellen

Die Werbeaktion gewährt dem Benutzer beim Kauf zusätzlich kostenlose Bonusartikel. Die Werbeaktion kann bei jedem Kauf innerhalb eines Projekts oder bei einem Kauf, der bestimmte Artikel umfasst, gelten.

SecuritybasicAuth

Request

path Parameters

project_id

required

integer

Projekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt.

Example: 44056

Request Body schema: application/json

required

Array of objects or null

Die zu kaufenden Artikel, damit eine Werbeaktion greifen kann. Ist dieser Parameter auf null gestellt, greift die Werbeaktion bei allen Käufen innerhalb eines Projekts.

Array

sku	string Default: "elven_sword" Artikel-SKU.

required

Array of objects or null

Array

quantity	number Default: 1 Artikelmenge.
sku	string Default: "elven_shield" Artikel-SKU.

required

object

Name der Werbeaktion. Sollte Schlüssel-Wert-Paare enthalten, wobei der Schlüssel ein Gebietsschema im Format "^[a–z]{2}-[A–Z]{2}$" und der Wert ein String ist.

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]+$

Benutzerattributcode.

operator

required

string

Art der durchgeführten Operation nach Bedingung. Für den Attributtyp string.

Enum:	Description
eq	Gleich
ne	Ungleich

value

required

string <= 255 characters

Bedingungswert, mit dem der Benutzerattributwert verglichen wird. Der Typ hängt vom Attributtyp ab.

type

required

string

Benutzerattributtyp.

Value: "string"

can_be_missing

boolean

Gibt an, dass die Bedingung erfüllt ist, auch wenn das Attribut in den Benutzerattributen fehlt. Übermitteln Sie true, um den Artikel den Nutzern anzuzeigen, die dieses Attribut nicht haben. Nutzer, die das Attribut haben, dessen Wert jedoch nicht mit dem in der Bedingung angegebenen Wert übereinstimmt, sehen den Artikel nicht. false – Nutzer, die das Attribut haben, dessen Wert jedoch nicht mit dem in der Bedingung angegebenen Wert übereinstimmt oder bei denen das Attribut fehlt, sehen den Artikel nicht.

date_end

string or null <date-time>

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

Datum, an dem Ihre Werbeaktion endet. Möglich ist null. Wenn für date_end der Wert null festgelegt ist, läuft die Werbeaktion zeitlich unbegrenzt.

date_start

string or null <date-time>

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

Datum, an dem Ihre Werbeaktion beginnt.

excluded_promotions

Array of integers

Liste der IDs der Werbeaktionen, die bei der Anwendung dieser Werbeaktion ausgeschlossen werden sollen.
Example: [12, 789]

integer

Werbeaktions-ID. Eindeutige Werbeaktionskennung innerhalb des Projekts.

object

Werbebeschränkungen.

per_user

integer or null

Werbebeschränkungen für einen separaten Benutzer.

object or null

Aktualisierungszeitraum begrenzen.

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

One of:

Tägliche Aktualisierung der Benutzerlimits.

interval_type required	string Wiederkehrender Aktualisierungszeitraum. Value: "daily"
time required	string((0[0-9]\|1[0-9]\|2[0-3]):00:00)(\+\|-)(0[0-9]\|1... Zeitpunkt der Limitaktualisierung in der gewünschten Zeitzone (auf Stunden gerundet).

Array of objects or null

Array von Objekten mit Bedingungen für die Preisspanne, innerhalb der die Werbeaktion angewandt wird.
Die Aktion wird nur auf Artikel angewandt, deren Preis alle in dem Array aufgelisteten Bedingungen erfüllt. Wenn Sie dieses Array übermitteln, müssen Sie den Wert des Objekts condition auf null setzen.

Array

operator

required

string

Vergleichsoperator zum Festlegen der Preisspanne für die Anwendung der Werbeaktion.

Enum:	Description
eq	Gleich
ge	Größer oder gleich
gt	Größer als
le	Kleiner oder gleich
lt	Kleiner als
ne	Ungleich

value

required

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

Wert zur Bestimmung der Preisspanne für die Anwendung der Werbeaktion.

Responses

201

Werbeaktion wurde erfolgreich erstellt.

401

Basisauthentifizierung nicht bestanden oder falsch. Prüfen Sie die Anmeldedaten und vergewissern Sie sich, dass Sie die Basisauthentifizierung verwenden.

422

Ungültige Anfrage.

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
}