Saltar al contenido
/
Revisar regla de filtro d...

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 ofrece endpoints para impulsar la participación de los jugadores.

Descargar descripción de OpenAPI
index.json
index.yaml
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/es/api/liveops/
https://store.xsolla.com/api/

Común

Operaciones

Cupones

Esta API le permite gestionar cupones.

Operaciones

Códigos promocionales

Esta API permite gestionar códigos promocionales.

Operaciones

Ofertas únicas por catálogo

Esta API le permite gestionar ofertas de catálogo únicas.

Operaciones

Descuentos

Esta API le permite gestionar promociones de descuento.

Operaciones

Bonificaciones

Esta API permite gestionar promociones de bonificaciones.

Operaciones

Catálogo personalizado

Esta API permite especificar reglas para los atributos de usuario. Si el usuario cumple todas las condiciones de una regla específica, se mostrarán los elementos personalizados.

Para promociones personalizadas, consulte la sección Promotions.

Para transmitir atributos antes de una compra, puede utilizar Xsolla Login API o transmitirlos a la propiedad user.attributes mientras se genera el token utilizando Pay Station API.

Operaciones

Obtener regla de filtro del catálogoServer-sideAdmin

Solicitud

Obtiene una regla específica que se aplica a los atributos del usuario.

Seguridad
basicAuth
Ruta
project_idintegerrequerido

ID del proyecto. Encontrará este parámetro en su Cuenta del editor junto al nombre del proyecto.

Ejemplo: 44056
rule_idnumberrequerido

ID de regla.

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

Respuestas

La regla se recibió correctamente.

Cuerpoapplication/json
attribute_conditionsArray of tipo = string (object) or tipo = number (object) or tipo = date (object)(personalized-catalog_user-attribute_conditions_model-get)[ 1 .. 100 ] itemsrequerido

Condiciones para validar los atributos de usuario. Determina la disponibilidad de artículos en el catálogo en función de si los atributos de usuario cumplen todas las condiciones especificadas.

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

Código de atributo de usuario.

attribute_conditions[].​can_be_missingboolean(user-attribute_conditions_properties_can_be_missing)

Indica que se cumple la condición aunque falte el atributo en los atributos del usuario. Transmita true para mostrar el elemento a los usuarios que no tengan este atributo. Los usuarios que tengan el atributo, pero el valor no coincida con el especificado en la condición, no verán el artículo. false - Los usuarios que tengan el atributo, pero el valor no coincida con el especificado en la condición, o falte el atributo, no verán el artículo.

attribute_conditions[].​operatorstring(user-attribute_conditions_properties_operator_string)

Tipo de operación realizada por condición. Para el tipo de atributo string.

Enumeración ValorDescripción
eq

Igual que

ne

No es igual que

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

Tipo de atributo de usuario.

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

Valor de la condición con el que se comparará el valor de atributo del usuario. El tipo depende del tipo de atributo.

is_enabledbooleanrequerido

Si la regla está habilitada.

is_satisfied_for_unauthboolean

Si el artículo se muestra a usuarios no autorizados. Si es true, el artículo se muestra al usuario no autorizado independientemente de las reglas de visualización del catálogo. Es false por defecto.

itemsArray of objectsrequerido
items[].​bundle_typestring

Tipo de lote. Se devuelve si el tipo de artículo es un lote.

Enumeración"standard""virtual_currency_package"
items[].​item_idnumber

ID del artículo.

items[].​namestring

Nombre del artículo.

items[].​skustring

SKU del artículo.

items[].​typestring

Tipo de artículo.

Enumeración"virtual_good""virtual_currency""bundle""physical_good""unit"
namestringrequerido

Nombre legible de una regla. Se utiliza para visualizar una regla en Cuenta del editor.

rule_idnumberrequerido

ID de regla.

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

Revisar regla de filtro del catálogoServer-sideAdmin

Solicitud

Actualiza una regla específica que se aplica a los atributos de usuario. Se utilizará el valor actual para una propiedad no especificada.

Seguridad
basicAuth
Ruta
project_idintegerrequerido

ID del proyecto. Encontrará este parámetro en su Cuenta del editor junto al nombre del proyecto.

Ejemplo: 44056
rule_idnumberrequerido

ID de regla.

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

Condiciones para validar los atributos de usuario. Determina la disponibilidad de artículos en el catálogo en función de si los atributos de usuario cumplen todas las condiciones especificadas.

is_enabledboolean

Si la regla está habilitada.

is_satisfied_for_unauthboolean

Si el artículo se muestra a usuarios no autorizados. Si es true, el artículo se muestra al usuario no autorizado independientemente de las reglas de visualización del catálogo. Es false por defecto.

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

Nombre legible de una regla. Se utiliza para visualizar una regla en Cuenta del editor.

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

Respuestas

La actualización se realizó correctamente.

Respuesta
Sin contenido

Actualizar regla de filtro del catálogoServer-sideAdmin

Solicitud

Actualiza una regla específica que se aplica a los atributos de usuario. Se utilizará el valor por defecto para una propiedad no especificada (si la propiedad no es obligatoria).

Seguridad
basicAuth
Ruta
project_idintegerrequerido

ID del proyecto. Encontrará este parámetro en su Cuenta del editor junto al nombre del proyecto.

Ejemplo: 44056
rule_idnumberrequerido

ID de regla.

Ejemplo: 1
Cuerpoapplication/json
attribute_conditionsArray of tipo = string (object) or tipo = number (object) or tipo = date (object)(personalized-catalog_user-attribute_conditions_model-post)[ 1 .. 100 ] itemsrequerido

Condiciones para validar los atributos de usuario. Determina la disponibilidad de artículos en el catálogo en función de si los atributos de usuario cumplen todas las condiciones especificadas.

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

Código de atributo de usuario.

attribute_conditions[].​can_be_missingboolean(user-attribute_conditions_properties_can_be_missing)

Indica que se cumple la condición aunque falte el atributo en los atributos del usuario. Transmita true para mostrar el elemento a los usuarios que no tengan este atributo. Los usuarios que tengan el atributo, pero el valor no coincida con el especificado en la condición, no verán el artículo. false - Los usuarios que tengan el atributo, pero el valor no coincida con el especificado en la condición, o falte el atributo, no verán el artículo.

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

Tipo de operación realizada por condición. Para el tipo de atributo string.

Enumeración ValorDescripción
eq

Igual que

ne

No es igual que

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

Tipo de atributo de usuario.

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

Valor de la condición con el que se comparará el valor de atributo del usuario. El tipo depende del tipo de atributo.

is_enabledbooleanrequerido

Si la regla está habilitada.

is_satisfied_for_unauthboolean

Si el artículo se muestra a usuarios no autorizados. Si es true, el artículo se muestra al usuario no autorizado independientemente de las reglas de visualización del catálogo. Es false por defecto.

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

Artículos que se muestran a un usuario si sus valores de atributos cumplen unas condiciones.

items[].​item_idnumberrequerido

ID del artículo.

namestring[ 1 .. 255 ] characters^\Srequerido

Nombre legible de una regla. Se utiliza para visualizar una regla en Cuenta del editor.

curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/es/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"
  }'

Respuestas

Actualización realizada correctamente.

Respuesta
Sin contenido

Gestión

Operaciones

Admin

Operaciones

Cliente

Operaciones

Cliente de clanes

Operaciones

Admin

Operaciones

Cliente

Operaciones

Admin

Operaciones

Cliente

Operaciones

Admin

Operaciones

Cliente

Operaciones