Zum Inhalt springen
/
Promocode löschen

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

Promocode-Aktion erstellenServer-sideAdmin

Anfrage

Erstellt eine Promocode-Aktion.

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 null(Promotions_coupon_bonus)
discountobject or null
Beispiel: {"percent":"10.10"}
discounted_itemsArray of objects or null(Promotions_discounted_items)

Liste der Artikel, die durch einen Promocode rabattiert werden.

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]
external_idstring(Promotions_coupon-external_id)erforderlich

Eindeutige Werbeaktions-ID. Die external_id darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten.

Standard "coupon_external_id"
Beispiel: "coupon_external_id"
item_price_conditionsArray of objects or null(item_price_conditions_promocode)

Objekt-Array mit Bedingungen für die Preisspanne, innerhalb der die Werbeaktion auf bestimmte Artikel im Warenkorb angewandt wird.
Der Preis der einzelnen Artikel im Warenkorb des Nutzers wird mit der in der Bedingung angegebenen Preisspanne verglichen. Boni und Rabatte werden nur auf die Artikel im Warenkorb angewendet, deren Preis die Bedingung erfüllt.
Wenn Sie dieses Array übermitteln, müssen Sie den Wert des Arrays discounted_items auf null setzen.

nameobject(Promotions_coupon_name)erforderlich

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.

Standard {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
Beispiel: {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
name.​property name*stringzusätzliche Eigenschaft
price_conditionsArray of objects or null(price_conditions_promocode)

Objekt-Array mit Bedingungen für die Preisspanne, innerhalb der die Werbeaktion auf den gesamten Warenkorb angewandt wird.
Der Gesamtpreis aller Artikel im Warenkorb des Nutzers wird mit der in der Bedingung angegebenen Preisspanne verglichen. Boni und Rabatte werden auf alle Artikel im Warenkorb angewandt, wenn die Warenkorbsumme die festgelegte Bedingung erfüllt.
Wenn Sie dieses Array übermitteln, müssen Sie den Wert des Arrays discounted_items 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.

redeem_code_limitinteger or null(Promotions_redeem_code_limit)

Anzahl der Einlösungen pro Code.

Standard 10
Beispiel: 10
redeem_total_limitinteger or null(Promotions_coupon-redeem_total_limit)

Begrenzt die Gesamtzahl der Gutscheine.

Standard 10
Beispiel: 10
redeem_user_limitinteger or null(Promotions_coupon-redeem_user_limit)

Begrenzt, wie oft ein einzelner Nutzer Gutscheine einlösen darf.

Standard 10
Beispiel: 10
curl -i -X POST \
  -u <username>:<password> \
  https://store.xsolla.com/api/v3/project/44056/admin/promocode \
  -H 'Content-Type: application/json' \
  -d '{
    "attribute_conditions": [
      {
        "attribute": "account_status",
        "can_be_missing": false,
        "operator": "eq",
        "type": "string",
        "value": "golden"
      }
    ],
    "discount": {
      "percent": "10.10"
    },
    "external_id": "coupon_external_id",
    "name": {
      "de-DE": "Neujahrsrabatt",
      "en-US": "New Year Discount"
    },
    "promotion_periods": [
      {
        "date_from": "2020-04-15T18:16:00+05:00",
        "date_until": "2020-04-25T18:16:00+05:00"
      }
    ],
    "redeem_code_limit": 1,
    "redeem_total_limit": 100,
    "redeem_user_limit": 1
  }'

Antworten

Promocode wurde erfolgreich erstellt.

Bodyapplication/json
external_idstring(Promotions_coupon-external_id)

Eindeutige Werbeaktions-ID. Die external_id darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten.

Standard "coupon_external_id"
Beispiel: "coupon_external_id"
Antwort
application/json
{
  "external_id": "coupon_external_id"
}

Promocode löschenServer-sideAdmin

Anfrage

Löscht eine Promocode-Aktion. 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 oder Artikel kaufen.

Nach der Löschung kann die Werbeaktion nicht wiederhergestellt werden. Promocodes aus der gelöschten Aktion können bestehenden Aktionen hinzugefügt werden.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
external_idintegererforderlich

Externe ID der Werbeaktion. Eindeutige Werbeaktionskennung innerhalb des Projekts.

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

Antworten

Die Promocode-Aktion wurde erfolgreich gelöscht.

Antwort
Kein Inhalt

Promocode-Aktion abrufenServer-sideAdmin

Anfrage

Ruft eine angegebene Promocode-Aktion ab.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
external_idintegererforderlich

Externe ID der Werbeaktion. Eindeutige Werbeaktionskennung innerhalb des Projekts.

Beispiel: coupon_44056_1
curl -i -X GET \
  -u <username>:<password> \
  https://store.xsolla.com/api/v3/project/44056/admin/promocode/coupon_44056_1

Antworten

Promocode wurde erfolgreich empfangen.

Bodyapplication/json
attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(promotion_user-attribute_conditions_model-get)[ 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 null(Promotions_coupon_bonus)
discountobject or null
Beispiel: {"discount":{"percent":"10.99"}}
discounted_itemsArray of objects or null(Promotions_discounted_items)

Liste der Artikel, die durch einen Promocode rabattiert werden.

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]
external_idstring(Promotions_coupon-external_id)

Eindeutige Werbeaktions-ID. Die external_id darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten.

Standard "coupon_external_id"
Beispiel: "coupon_external_id"
is_enabledboolean(Promotions_coupon-is_enabled)
Standard true
item_price_conditionsArray of objects or null(item_price_conditions_promocode)

Objekt-Array mit Bedingungen für die Preisspanne, innerhalb der die Werbeaktion auf bestimmte Artikel im Warenkorb angewandt wird.
Der Preis der einzelnen Artikel im Warenkorb des Nutzers wird mit der in der Bedingung angegebenen Preisspanne verglichen. Boni und Rabatte werden nur auf die Artikel im Warenkorb angewendet, deren Preis die Bedingung erfüllt.
Wenn Sie dieses Array übermitteln, müssen Sie den Wert des Arrays discounted_items auf null setzen.

nameobject(Promotions_coupon_name)

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.

Standard {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
Beispiel: {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
price_conditionsArray of objects or null(price_conditions_promocode)

Objekt-Array mit Bedingungen für die Preisspanne, innerhalb der die Werbeaktion auf den gesamten Warenkorb angewandt wird.
Der Gesamtpreis aller Artikel im Warenkorb des Nutzers wird mit der in der Bedingung angegebenen Preisspanne verglichen. Boni und Rabatte werden auf alle Artikel im Warenkorb angewandt, wenn die Warenkorbsumme die festgelegte Bedingung erfüllt.
Wenn Sie dieses Array übermitteln, müssen Sie den Wert des Arrays discounted_items 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.

redeem_code_limitinteger or null(Promotions_redeem_code_limit)

Anzahl der Einlösungen pro Code.

Standard 10
Beispiel: 10
redeem_total_limitinteger or null(Promotions_coupon-redeem_total_limit)

Begrenzt die Gesamtzahl der Gutscheine.

Standard 10
Beispiel: 10
redeem_user_limitinteger or null(Promotions_coupon-redeem_user_limit)

Begrenzt, wie oft ein einzelner Nutzer Gutscheine einlösen darf.

Standard 10
Beispiel: 10
total_limit_stateobject or null(Promotions_promocode_total_limit_state)

Limits für jeden einzelnen Promocode.

Antwort
application/json
{
  "bonus": [
    { … }
  ],
  "discount": {
    "percent": "10.99"
  },
  "discounted_items": null,
  "excluded_promotions": [
    23,
    45
  ],
  "external_id": "summer20221",
  "is_enabled": true,
  "name": {
    "en-US": "Coupon name",
    "ru-RU": "Название купона"
  },
  "promotion_periods": [
    { … },
    { … }
  ],
  "redeem_code_limit": 1,
  "redeem_total_limit": 100,
  "redeem_user_limit": null,
  "total_limit_state": {
    "available": 50,
    "reserved": 10,
    "used": 40
  }
}

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

Verwaltung

Operationen

Client

Operationen

Clans-Client

Operationen

Verwaltung

Operationen

Client

Operationen

Verwaltung

Operationen

Client

Operationen

Verwaltung

Operationen

Client

Operationen