Zum Inhalt springen
/
Bonusaktion erstellen

LiveOps API (2.0.0)

Überblick

  • 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.

API-Aufrufe

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
index.json
index.yaml
Sprachen
Server
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/de/api/liveops/

Allgemeines

Operationen

Gutscheine

Mit dieser API können Sie Gutscheine verwalten.

Operationen

Promocodes

Diese API ermöglicht die Verwaltung von Promocodes.

Operationen

Katalogsonderangebote

Mit dieser API können Sie Katalogsonderangebote verwalten.

Operationen

Rabatte

Mit dieser API können Sie Rabattaktionen verwalten.

Operationen

Boni

Diese API ermöglicht die Verwaltung von Bonusaktionen.

Operationen

Liste der Bonusaktionen abrufenServer-sideAdmin

Anfrage

Ruft die Liste der Bonusaktionen eines Projekts ab.

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

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
Abfrage
limitinteger>= 1

Begrenzung der Elementanzahl auf der Seite.

Beispiel: limit=50
offsetinteger>= 0

Elementnummer, aus der die Liste generiert wird (die Zählung beginnt bei 0).

Beispiel: offset=0
curl -i -X GET \
  -u <username>:<password> \
  'https://store.xsolla.com/api/v3/project/44056/admin/promotion/bonus?limit=50&offset=0'

Antworten

Die Liste der Bonusaktionen wurde erfolgreich empfangen.

Bodyapplication/json
active_promotions_countinteger(active_promotions_count)

Anzahl der aktiven Werbeaktionen.

inactive_promotions_countinteger(inactive_promotions_count)

Anzahl der deaktivierten Werbeaktionen.

promotionsArray of objects(Promotions_200-get-bonus-promotion-model)
total_promotions_countinteger(total_promotions_count)

Gesamtzahl der Werbeaktionen.

Antwort
application/json
{
  "active_promotions_count": 2,
  "inactive_promotions_count": 0,
  "promotions": [
    { … },
    { … }
  ],
  "total_promotions_count": 2
}

Bonusaktion erstellenServer-sideAdmin

Anfrage

Erstellt die Bonusaktion.

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

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
Bodyapplication/json
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.

bonusArray of objects or nullerforderlich
bonus[].​quantitynumber

Artikelmenge.

Standard 1
bonus[].​skustring

Artikel-SKU.

Standard "elven_shield"
conditionArray of objects or nullerforderlich

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.

condition[].​skustring

Artikel-SKU.

Standard "elven_sword"
excluded_promotionsArray of integers(excluded_promotions)

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

Beispiel: [12,789]
idinteger

Werbeaktions-ID. Eindeutige Werbeaktionskennung innerhalb des Projekts.

is_enabledboolean(Promotions_is_enabled)

Ob die Werbeaktion aktiviert ist oder nicht.

Beispiel: true
limitsobject(Promotions_promotion_limits)

Werbebeschränkungen.

nameobjecterforderlich

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: {"de-DE":"Sommersaison Bonus","en-US":"Summer season bonus"}
name.​property name*stringzusätzliche Eigenschaft
price_conditionsArray of objects or null(price_conditions_bonus)

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 condition auf null setzen.

promotion_periodsArray of objects(promotion_periods)

Gültigkeitszeitraum der Werbeaktion. Wenn mehrere Zeiträume angegeben sind, sind sowohl date_from als auch date_until erforderlich.

curl -i -X POST \
  -u <username>:<password> \
  https://store.xsolla.com/api/v3/project/44056/admin/promotion/bonus \
  -H 'Content-Type: application/json' \
  -d '{
    "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"
      }
    ],
    "name": {
      "de-DE": "Neujahrsbonus",
      "en-US": "New Year Bonus"
    },
    "promotion_periods": [
      {
        "date_from": "2020-04-15T18:16:00+05:00",
        "date_until": "2020-04-25T18:16:00+05:00"
      }
    ]
  }'

Antworten

Werbeaktion wurde erfolgreich erstellt.

Bodyapplication/json
promotion_idinteger

Werbeaktions-ID. Eindeutige Werbeaktionskennung innerhalb des Projekts.

Antwort
application/json
{
  "promotion_id": 2384756
}

Bonusaktion löschenServer-sideAdmin

Anfrage

Löscht Bonusaktion. Die gelöschte Werbeaktion:

  • 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 Bonusartikel erhalten.

Nach der Löschung kann die Werbeaktion nicht wiederhergestellt werden.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
promotion_idintegererforderlich

Werbeaktions-ID. Eindeutige Werbeaktionskennung innerhalb des Projekts.

Beispiel: 111425
curl -i -X DELETE \
  -u <username>:<password> \
  https://store.xsolla.com/api/v3/project/44056/admin/promotion/111425/bonus

Antworten

Die Werbeaktion wurde erfolgreich gelöscht.

Antwort
Kein Inhalt

Personalisierter 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

Verwaltung

Operationen

Verwaltung

Operationen

Client

Operationen

Clans-Client

Operationen

Verwaltung

Operationen

Client

Operationen

Verwaltung

Operationen

Client

Operationen

Verwaltung

Operationen

Client

Operationen