Projekt-ID.
LiveOps API (2.0.0)
- Version: 2.0.0
- Server:
https://store.xsolla.com/api - Kontakt per E-Mail
- Kontakt-URL: https://xsolla.com/
- Erforderliche TLS-Version: 1.2
LiveOps ist ein Toolkit, mit dem sich durch Werbeaktionen und personalisierte Angebote die Spielerbindung kontinuierlich verbessern lässt.
Mit der API lassen sich die folgenden Funktionen verwalten:
- Werbeaktionen – Erstellen und verwalten Sie Gutscheine, Promocodes, Rabatte und Bonusaktionen.
- Personalisierung – Legen Sie für bestimmte autorisierte Nutzer Bedingungen fest, gemäß denen der Artikelkatalog und Sonderangebote angezeigt werden sollen.
- Werbaktionslimits – Begrenzen Sie, wie oft ein Nutzer eine Werbeaktion in Anspruch nehmen darf, und legen Sie fest, wie häufig das Limit zurückgesetzt werden soll.
- Belohnungsketten und Wertpunkte – Konfigurieren Sie Belohnungsstufen, die an das Sammeln von Wertpunkten geknüpft sind.
- Tägliche Ketten – Richten Sie tägliche Belohnungen ein, um Nutzer zu motivieren, sich regelmäßig anzumelden.
- Angebotsketten – Erstellen Sie aufeinander aufbauende Kaufangebote mit gestaffelten Preisen und optionalen kostenlosen Belohnungen.
- Upselling – eine Verkaufsmethode, bei der dem Nutzer angeboten wird, einen Artikel mit einem Mehrwert zu erwerben.
Die API ist in die folgenden Gruppen unterteilt:
Admin – Aufrufe zum Erstellen, Aktualisieren, Aktivieren und Löschen von Kampagnen und Ketten. Die Authentifizierung erfolgt über die Basisauthentifizierung und Ihre Händler- oder Projekt-Anmeldedaten.Client – Aufrufe zum Abrufen verfügbarer Werbeaktionen, zum Abrufen aktiver Ketten, zum Einlösen von Codes und zur Inanspruchnahme von Belohnung im Namen authentifizierter Nutzer. Die Authentifizierung erfolgt über den Benutzer-JWT.
OpenAPI-Beschreibung herunterladen
Sprachen
Server
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/de/api/liveops/
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promotion/item
- Mock serverhttps://xsolla.redocly.app/_mock/de/api/liveops/v3/project/{project_id}/admin/promotion/item
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://store.xsolla.com/api/v3/project/{project_id}/admin/promotion/item?limit=0&offset=0'Antwort
application/json
{ "active_promotions_count": 4, "inactive_promotions_count": 0, "promotions": [ { … }, { … }, { … }, { … } ], "total_promotions_count": 4 }
Pfad
Bodyapplication/jsonerforderlichProjekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt.
Beispiel: 44056
Objekt mit Werbeaktionsdaten.
attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(promotion_user-attribute_conditions_model-post)[ 1 .. 100 ] items
Bedingungen für die Validierung von Nutzerattributen. Steuert die Verfügbarkeit der Werbeaktion basierend darauf, ob die Nutzerattribute alle angegebenen Bedingungen erfüllen.
Liste der IDs der Werbeaktionen, die bei der Anwendung dieser Werbeaktion ausgeschlossen werden sollen.
Example: [12, 789]
Beispiel: [12,789]
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.
Beispiel: {"en-US":"Promotion","ru-RU":"Акция"}
Objekt-Array 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 items auf null setzen.
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promotion/item
- Mock serverhttps://xsolla.redocly.app/_mock/de/api/liveops/v3/project/{project_id}/admin/promotion/item
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://store.xsolla.com/api/v3/project/44056/admin/promotion/item \
-H 'Content-Type: application/json' \
-d '{
"attribute_conditions": [
{
"attribute": "race",
"operator": "eq",
"type": "string",
"value": "ork"
},
{
"attribute": "level",
"can_be_missing": true,
"operator": "eq",
"type": "number",
"value": "10"
}
],
"discount": {
"percent": "24.00"
},
"is_enabled": true,
"items": [],
"name": {
"en-US": "Ork set discount",
"ru-RU": "Скидка на набор для орка"
},
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
]
}'Antwort
application/json
{ "promotion_id": 2384756 }
Anfrage
Löscht eine Rabattaktion. Die gelöschte Aktion:
- verschwindet aus der Liste der in Ihrem Projekt eingerichteten Werbeaktionen.
- wird nicht mehr auf den Artikelkatalog und den Warenkorb angewendet. Nutzer können im Rahmen dieser Werbeaktion keine Artikel kaufen.
Nach der Löschung kann die Werbeaktion nicht wiederhergestellt werden.
Sicherheit
basicAuth
Pfad
Projekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt.
Beispiel: 44056
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promotion/{promotion_id}/item
- Mock serverhttps://xsolla.redocly.app/_mock/de/api/liveops/v3/project/{project_id}/admin/promotion/{promotion_id}/item
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
-u <username>:<password> \
https://store.xsolla.com/api/v3/project/44056/admin/promotion/111425/itemPersonalisierter Katalog
Diese API ermöglicht es, Regeln für Benutzerattribute festzulegen. Wenn der Nutzer alle Bedingungen einer konkreten Regel erfüllt, werden personalisierte Artikel angezeigt.
Für personalisierte Werbeaktionen siehe Abschnitt Werbeaktionen.
Um Attribute vor einem Kauf zu übermitteln, können Sie die Xsolla Login API verwenden oder die Attribute in der Eigenschaft user.attributes übermitteln, während Sie den Token mit der Pay Station API generieren.
Operationen