Zum Inhalt springen
/
Katalogfilterregel patche...

LiveOps API (2.0.0)

Overview

  • Version: 2.0.0
  • Servers: https://store.xsolla.com/api
  • Contact Us by Email
  • Contact URL: https://xsolla.com/
  • Required TLS version: 1.2

LiveOps API bietet Endpunkte zur Förderung des Spieler-Engagements.

OpenAPI-Beschreibung herunterladen
index.json
index.yaml
Sprachen
Server
Mock server
https://xsolla.redocly.app/_mock/de/api/liveops/
https://store.xsolla.com/api/

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

Katalogfilterregel abrufenServer-sideAdmin

Anfrage

Bestimmte für Benutzerattribute geltende Regel abrufen

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
rule_idnumbererforderlich

Regel-ID.

Beispiel: 1
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/de/api/liveops/v2/project/44056/admin/user/attribute/rule/1

Antworten

Die Regel wurde erfolgreich empfangen.

Bodyapplication/json
attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(personalized-catalog_user-attribute_conditions_model-get)[ 1 .. 100 ] itemserforderlich

Bedingungen für die Validierung von Nutzerattributen. Steuert die Artikelverfügbarkeit im Katalog basierend darauf, ob die Nutzerattribute alle angegebenen Bedingungen erfüllen.

One of:
attribute_conditions[].​attributestring(user-attribute_conditions_properties_attribute)[ 1 .. 255 ] characters^[-_.\d\w]+$

Benutzerattributcode.

attribute_conditions[].​can_be_missingboolean(user-attribute_conditions_properties_can_be_missing)

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.

attribute_conditions[].​operatorstring(user-attribute_conditions_properties_operator_string)

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

Enum WertBeschreibung
eq

Gleich

ne

Ungleich

attribute_conditions[].​typestring(user-attribute_conditions_properties_type-string)

Benutzerattributtyp.

Wert"string"
attribute_conditions[].​valuestring(user-attribute_conditions_properties_value)<= 255 characters

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

is_enabledbooleanerforderlich

Wenn die Regel aktiviert ist.

is_satisfied_for_unauthboolean

Ob der Artikel nicht autorisierten Nutzern angezeigt wird. Ist true festgelgt, wird der Artikel dem nicht autorisierten Nutzer unabhängig von den Kataloganzeigeregeln angezeigt. Standardmäßig ist false festgelgt.

itemsArray of objectserforderlich
items[].​bundle_typestring

Bündeltyp. Wird zurückgegeben, wenn der Artikeltyp ein Bündel ist.

Enum"standard""virtual_currency_package"
items[].​item_idnumber

Artikel-ID.

items[].​namestring

Artikelname.

items[].​skustring

Artikel-SKU.

items[].​typestring

Artikeltyp.

Enum"virtual_good""virtual_currency""bundle""physical_good""unit"
namestringerforderlich

Verständlicher Name einer Regel. Dient dazu, eine Regel im Kundenportal anzuzeigen.

rule_idnumbererforderlich

Regel-ID.

Antwort
application/json
{
  "attribute_conditions": [
    { … }
  ],
  "is_enabled": true,
  "is_satisfied_for_unauth": true,
  "items": [
    { … }
  ],
  "name": "Ork race armor rule",
  "rule_id": 1
}

Katalogfilterregel patchenServer-sideAdmin

Anfrage

Aktualisiert eine bestimmte Regel, die für Benutzerattribute gilt. Bei einer unbestimmten Eigenschaft wird der aktuelle Wert verwendet.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
rule_idnumbererforderlich

Regel-ID.

Beispiel: 1
Bodyapplication/json
attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(personalized-catalog_user-attribute_conditions_model-post)[ 1 .. 100 ] items

Bedingungen für die Validierung von Nutzerattributen. Steuert die Artikelverfügbarkeit im Katalog basierend darauf, ob die Nutzerattribute alle angegebenen Bedingungen erfüllen.

is_enabledboolean

Wenn die Regel aktiviert ist.

is_satisfied_for_unauthboolean

Ob der Artikel nicht autorisierten Nutzern angezeigt wird. Ist true festgelgt, wird der Artikel dem nicht autorisierten Nutzer unabhängig von den Kataloganzeigeregeln angezeigt. Standardmäßig ist false festgelgt.

itemsArray of objects[ 1 .. 100 ] items
namestring[ 1 .. 255 ] characters^\S

Verständlicher Name einer Regel. Dient dazu, eine Regel im Kundenportal anzuzeigen.

curl -i -X PATCH \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/de/api/liveops/v2/project/44056/admin/user/attribute/rule/1 \
  -H 'Content-Type: application/json' \
  -d '{
    "is_enabled": false
  }'

Antworten

Update war erfolgreich.

Antwort
Kein Inhalt

Katalogfilterregel aktualisierenServer-sideAdmin

Anfrage

Aktualisiert eine bestimmte Regel, die für Benutzerattribute gilt. Bei einer unbestimmten Eigenschaft wird der Standardwert verwendet (wenn die Eigenschaft nicht erforderlich ist).

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
rule_idnumbererforderlich

Regel-ID.

Beispiel: 1
Bodyapplication/json
attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(personalized-catalog_user-attribute_conditions_model-post)[ 1 .. 100 ] itemserforderlich

Bedingungen für die Validierung von Nutzerattributen. Steuert die Artikelverfügbarkeit im Katalog basierend darauf, ob die Nutzerattribute alle angegebenen Bedingungen erfüllen.

One of:
attribute_conditions[].​attributestring(user-attribute_conditions_properties_attribute)[ 1 .. 255 ] characters^[-_.\d\w]+$erforderlich

Benutzerattributcode.

attribute_conditions[].​can_be_missingboolean(user-attribute_conditions_properties_can_be_missing)

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.

attribute_conditions[].​operatorstring(user-attribute_conditions_properties_operator_string)erforderlich

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

Enum WertBeschreibung
eq

Gleich

ne

Ungleich

attribute_conditions[].​typestring(user-attribute_conditions_properties_type-string)erforderlich

Benutzerattributtyp.

Wert"string"
attribute_conditions[].​valuestring(user-attribute_conditions_properties_value)<= 255 characterserforderlich

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

is_enabledbooleanerforderlich

Wenn die Regel aktiviert ist.

is_satisfied_for_unauthboolean

Ob der Artikel nicht autorisierten Nutzern angezeigt wird. Ist true festgelgt, wird der Artikel dem nicht autorisierten Nutzer unabhängig von den Kataloganzeigeregeln angezeigt. Standardmäßig ist false festgelgt.

itemsArray of objects[ 1 .. 100 ] itemserforderlich
One of:

Artikel, die einem Nutzer angezeigt werden, sofern ihre Attributwerte Bedingungen erfüllen.

items[].​item_idnumbererforderlich

Artikel-ID.

namestring[ 1 .. 255 ] characters^\Serforderlich

Verständlicher Name einer Regel. Dient dazu, eine Regel im Kundenportal anzuzeigen.

curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/de/api/liveops/v2/project/44056/admin/user/attribute/rule/1 \
  -H 'Content-Type: application/json' \
  -d '{
    "attribute_conditions": [
      {
        "attribute": "race",
        "can_be_missing": false,
        "operator": "eq",
        "type": "string",
        "value": "ork"
      }
    ],
    "is_enabled": true,
    "is_satisfied_for_unauth": false,
    "items": [
      {
        "item_id": 1
      }
    ],
    "name": "Ork race armor rule"
  }'

Antworten

Erfolgreiche Aktualisierung.

Antwort
Kein Inhalt

Verwaltung

Operationen

Verwaltung

Operationen

Client

Operationen

Clans-Client

Operationen

Verwaltung

Operationen

Client

Operationen

Verwaltung

Operationen

Client

Operationen

Verwaltung

Operationen

Client

Operationen