Crear una cadena de recompensas

Xsolla Developers

A Cuenta del editor

Crear una cadena de recompensasServer-sideAdmin

post/v2/project/{project_id}/admin/reward_chain

Crea una cadena de recompensas.

SecuritybasicAuth

Request

path Parameters

project_id

required

integer

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

Example: 44056

Request Body schema: application/json

One of:

Una cadena de recompensas.

required

(two-letter (object or null)) or (five-letter (object or null))

Objeto con traducciones para la descripción del artículo. Acepta valores en uno de estos dos formatos: códigos de idioma de dos letras en minúscula (p. ej., en) o códigos de idioma de cinco caracteres (p. ej., en-US). Aunque ambos formatos se aceptan como entradas, las respuestas devuelven códigos de idioma de dos letras en minúscula. Cuando se facilitan ambas opciones para el mismo idioma (p. ej. en y en-US), se almacena el último valor proporcionado. Puede consultar la lista completa de idiomas admitidos en la documentación.

One of:

Códigos lingüísticos de dos letras minúsculas.

ar	string or null Árabe
bg	string or null Búlgaro
cn	string or null Chino (simplificado)
cs	string or null Checo
de	string or null Alemán
en	string or null Inglés
es	string or null Español (España)
fr	string or null Francés
he	string or null Hebreo
id	string or null Indonesio
it	string or null Italiano
ja	string or null Japonés
km	string or null Jemer
ko	string or null Coreano
lo	string or null Lao
my	string or null Birmano
ne	string or null Nepalí
ph	string or null Filipino
pl	string or null Polaco
pt	string or null Portugués
ro	string or null Rumano
ru	string or null Ruso
th	string or null Tailandés
tr	string or null Turco
tw	string or null Chino (tradicional)
vi	string or null Vietnamita

required

object

sku

required

string [ 1 .. 255 ] characters ^[a-zA-Z0-9_\-–.]*$

ID único del artículo. El SKU solo puede contener caracteres alfanuméricos latinos en minúsculas y mayúsculas, puntos, guiones y guiones bajos.

date_start

required

string <date-time>

Fecha de inicio de su cadena de recompensas.

required

Array of objects

Array

required

(two-letter (object or null)) or (five-letter (object or null))

One of:

Códigos lingüísticos de dos letras minúsculas.

ar	string or null Árabe
bg	string or null Búlgaro
cn	string or null Chino (simplificado)
cs	string or null Checo
de	string or null Alemán
en	string or null Inglés
es	string or null Español (España)
fr	string or null Francés
he	string or null Hebreo
id	string or null Indonesio
it	string or null Italiano
ja	string or null Japonés
km	string or null Jemer
ko	string or null Coreano
lo	string or null Lao
my	string or null Birmano
ne	string or null Nepalí
ph	string or null Filipino
pl	string or null Polaco
pt	string or null Portugués
ro	string or null Rumano
ru	string or null Ruso
th	string or null Tailandés
tr	string or null Turco
tw	string or null Chino (tradicional)
vi	string or null Vietnamita

required

object

amount

required

integer

Precio del paso en puntos de valor.

required

Array of objects

Array

sku

required

string [ 1 .. 255 ] characters ^[a-zA-Z0-9_\-–.]*$

ID único del artículo. El SKU solo puede contener caracteres alfanuméricos latinos en minúsculas y mayúsculas, puntos, guiones y guiones bajos.

quantity

required

integer

Cantidad del artículo.

Array of tipo = string (objects) or Array of tipo = date (objects) or Array of tipo = number (objects)

One of:

[ 1 .. 100 ] items

Array ([ 1 .. 100 ] items)

attribute

required

string [ 1 .. 255 ] characters ^[-_.\d\w]+$

Código de atributo de usuario.

operator

required

string

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

Enum:	Description
eq	Igual que
ne	No es igual que

value

required

string <= 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.

type

required

string

Tipo de atributo de usuario.

Value: "string"

can_be_missing

boolean

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.

image_url

string or null

URL de la imagen.

is_enabled

required

boolean

Array of tipo = string (objects) or Array of tipo = date (objects) or Array of tipo = number (objects)

One of:

[ 1 .. 100 ] items

Array ([ 1 .. 100 ] items)

attribute

required

string [ 1 .. 255 ] characters ^[-_.\d\w]+$

Código de atributo de usuario.

operator

required

string

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

Enum:	Description
eq	Igual que
ne	No es igual que

value

required

string <= 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.

type

required

string

Tipo de atributo de usuario.

Value: "string"

can_be_missing

boolean

date_end

string or null <date-time>

Fecha en la que finaliza la promoción de su cadena de recompensas. Puede ser null. Si date_end es null, la cadena de recompensas será ilimitada en el tiempo.

(two-letter (object or null)) or (five-letter (object or null))

Objeto con traducciones para la descripción del artículo. Acepta valores en uno de dos formatos: códigos de idioma de dos letras en minúscula (p. ej., en) o códigos de configuración regional de cinco caracteres (p. ej., en-US). Aunque ambos formatos se aceptan como entradas, las respuestas devuelven códigos de idioma de dos letras en minúscula. Cuando se facilitan ambas opciones para el mismo idioma (p. ej. en y en-US), se almacena el último valor proporcionado. Puede consultar la lista completa de idiomas admitidos en la documentación.

One of:

Códigos lingüísticos de dos letras minúsculas.

ar	string or null Árabe
bg	string or null Búlgaro
cn	string or null Chino (simplificado)
cs	string or null Checo
de	string or null Alemán
en	string or null Inglés
es	string or null Español (España)
fr	string or null Francés
he	string or null Hebreo
id	string or null Indonesio
it	string or null Italiano
ja	string or null Japonés
km	string or null Jemer
ko	string or null Coreano
lo	string or null Lao
my	string or null Birmano
ne	string or null Nepalí
ph	string or null Filipino
pl	string or null Polaco
pt	string or null Portugués
ro	string or null Rumano
ru	string or null Ruso
th	string or null Tailandés
tr	string or null Turco
tw	string or null Chino (tradicional)
vi	string or null Vietnamita

image_url

string or null

URL de la imagen.

is_always_visible

boolean

Default: true

Si todos los usuarios pueden ver la cadena de recompensas:

Si es true, la cadena aparece siempre, independientemente del estado de autenticación o los atributos del usuario.
Si es false, la cadena aparece solo si no se encuentra ninguna cadena de recompensas adecuada. Por ejemplo, si el usuario no está autenticado o sus atributos no coinciden con ninguna cadena personalizada.

Solo se aplica en el contexto de cadenas de recompensas personalizadas y se utiliza si no se transmite la matriz attribute_conditions.

(two-letter (object or null)) or (five-letter (object or null))

Objeto con traducciones para la descripción larga del artículo. Acepta valores en uno de estos dos formatos: códigos de idioma de dos letras en minúscula (p. ej., en) o códigos de configuración regional de cinco caracteres (p. ej., en-US). Aunque ambos formatos se aceptan como entradas, las respuestas devuelven códigos de idioma de dos letras en minúscula. Cuando se facilitan ambas opciones para el mismo idioma (p. ej. en y en-US), se almacena el último valor proporcionado. Puede consultar la lista completa de idiomas admitidos en la documentación.

Any of:

Códigos lingüísticos de dos letras minúsculas.

ar	string or null Árabe
bg	string or null Búlgaro
cn	string or null Chino (simplificado)
cs	string or null Checo
de	string or null Alemán
en	string or null Inglés
es	string or null Español (España)
fr	string or null Francés
he	string or null Hebreo
id	string or null Indonesio
it	string or null Italiano
ja	string or null Japonés
km	string or null Jemer
ko	string or null Coreano
lo	string or null Lao
my	string or null Birmano
ne	string or null Nepalí
ph	string or null Filipino
pl	string or null Polaco
pt	string or null Portugués
ro	string or null Rumano
ru	string or null Ruso
th	string or null Tailandés
tr	string or null Turco
tw	string or null Chino (tradicional)
vi	string or null Vietnamita

order

integer

Define el orden de disposición.

(interval_type = weekly (object or null)) or (interval_type = monthly (object or null))

Periodo de reinicio recurrente de la cadena de recompensas.

One of:

Tipo semanal de actualización de la cadena de recompensas.

interval_type required	string Frecuencia del reinicio recurrente de la cadena de recompensas. Value: "weekly"
time required	string((0[0-9]\|1[0-9]\|2[0-3]):00:00)(\+\|-)(0[0-9]\|1... Hora a la que se restablece la cadena de recompensas en la zona horaria deseada (redondeo a horas). Por ejemplo, la hora establecida para el reinicio de la cadena de recompensas es la 01:00 para la zona horaria de Kuala Lumpur (GMT+8). En este caso, el valor del parámetro `time` es `01:00:00+08:00`.
day_of_week required	integer [ 1 .. 7 ] Día de la semana en que se reinicia la cadena de recompensas; en cuyo sistema el "1" es lunes y el "7" es domingo.

Responses

201

La cadena de recompensas se creó correctamente.

401

Autenticación básica no superada o errónea. Asegúrese de haber utilizado la autenticación básica o las credenciales correctas.

422

Solicitud no válida.

Request samples

application/json

{"clan_type": "guild",
"date_end": "2021-04-15T18:16:00+05:00",
"date_start": "2020-04-15T18:16:00+05:00",
"description": {"en": "Clan reward chain description."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"is_enabled": true,
"long_description": {"en": "Clan reward chain long description."
},
"name": {"en": "Clan reward chain"
},
"order": 1,
"popup_header": {"en": "How to unlock rewards"
},
"popup_image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"popup_instruction": {"en": "You must be a clan member to get clan rewards. You join a clan when a clan member invites you to the clan, and you accept the invite. You can also create your own clan."
},
"recurrent_schedule": {"day_of_week": 1,
"interval_type": "weekly",
"time": "01:00:00+08:00"
},
"steps": [{"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"name": {"en": "First step of the reward chain"
},
"price": {"amount": 10
},
"reward": [{"quantity": 5,
"sku": "com.xsolla.item_1"
},
{"quantity": 1,
"sku": "com.xsolla.item_2"
}
]
},
{"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"name": {"en": "Second step of the reward chain"
},
"price": {"amount": 15
},
"reward": [{"quantity": 5,
"sku": "com.xsolla.item_3"
},
{"quantity": 1,
"sku": "com.xsolla.item_4"
}
]
}
],
"value_point": {"sku": "com.xsolla.clan_value_point_1"
}
}

Response samples

application/json

{"reward_chain_id": 10
}