Zum Inhalt springen
/
Werbeaktionslimit für ang...

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

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

Werbeaktionslimit für angegebenen Benutzer herabsetzenServer-sideAdmin

Anfrage

Verringert die Anzahl der verbleibenden Male, die der angegebene Nutzer eine Werbeaktion innerhalb des geltenden Limits in Anspruch nehmen darf.

Mit der entsprechenden API (User limit API) können Sie begrenzen, wie oft ein Nutzer eine Werbeaktion in Anspruch nehmen kann. Um das Nutzerlimit zu konfigurieren, wechseln Sie zum Bereich "Verwaltung" der gewünschten Werbeaktionsart:

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
Bodyapplication/json
availableinteger(User-limit_available)>= 1erforderlich

Wie viele Artikel der Nutzer noch erhalten kann bzw. wie oft der Nutzer Werbeaktionen innerhalb des geltenden Limits noch in Anspruch nehmen darf.

userobject(User-limit_user)erforderlich
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$erforderlich

Externe Benutzer-ID.

curl -i -X DELETE \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/user/limit/promotion/id/111425 \
  -H 'Content-Type: application/json' \
  -d '{
    "available": 1,
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

Antworten

Werbeaktionslimits für einen Nutzer wurden erfolgreich abgerufen.

Bodyapplication/json
per_userobject
Antwort
application/json
{
  "per_user": {
    "available": 9,
    "total": 10
  }
}

Werbeaktionslimit für angegebenen Benutzer abrufenServer-sideAdmin

Anfrage

Ruft ab, wie oft die der angegebene Nutzer die Werbeaktion innerhalb des geltenden Limits noch in Anspruch nehmen darf.

Mit der entsprechenden API (User limit API) können Sie begrenzen, wie oft ein Nutzer eine Werbeaktion in Anspruch nehmen kann. Um das Nutzerlimit zu konfigurieren, wechseln Sie zum Bereich "Verwaltung" der gewünschten Werbeaktionsart:

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
Abfrage
user_external_idstringerforderlich

Externe Benutzer-ID

Beispiel: user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f
curl -i -X GET \
  -u <username>:<password> \
  'https://store.xsolla.com/api/v2/project/44056/admin/user/limit/promotion/id/111425?user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f'

Antworten

Werbeaktionslimits für einen Nutzer wurden erfolgreich abgerufen.

Bodyapplication/json
per_userobject
Antwort
application/json
{
  "per_user": {
    "available": 9,
    "total": 10
  }
}

Werbeaktionslimit für angegebenen Benutzer erhöhenServer-sideAdmin

Anfrage

Erhöht die Anzahl der verbleibenden Male, die der angegebene Nutzer die Werbeaktion innerhalb des geltenden Limits in Anspruch nehmen darf.

Mit der entsprechenden API (User limit API) können Sie begrenzen, wie oft ein Nutzer eine Werbeaktion in Anspruch nehmen kann. Um das Nutzerlimit zu konfigurieren, wechseln Sie zum Bereich "Verwaltung" der gewünschten Werbeaktionsart:

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
Bodyapplication/json
availableinteger(User-limit_available)>= 1erforderlich

Wie viele Artikel der Nutzer noch erhalten kann bzw. wie oft der Nutzer Werbeaktionen innerhalb des geltenden Limits noch in Anspruch nehmen darf.

userobject(User-limit_user)erforderlich
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$erforderlich

Externe Benutzer-ID.

curl -i -X POST \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/user/limit/promotion/id/111425 \
  -H 'Content-Type: application/json' \
  -d '{
    "available": 1,
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

Antworten

Werbeaktionslimits für einen Nutzer wurden erfolgreich abgerufen.

Bodyapplication/json
per_userobject
Antwort
application/json
{
  "per_user": {
    "available": 9,
    "total": 10
  }
}

Verwaltung

Operationen

Client

Operationen

Clans-Client

Operationen

Verwaltung

Operationen

Client

Operationen

Verwaltung

Operationen

Client

Operationen

Verwaltung

Operationen

Client

Operationen