跳转到内容

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提供用于提升玩家参与度的端点。

下载 OpenAPI 描述
语言
服务器
Mock server
https://xsolla.redocly.app/_mock/zh/api/liveops/
https://store.xsolla.com/api/
操作

优惠券

此API让您可以管理优惠券。

操作

促销码

此API让您可以管理促销码。

操作

特别目录优惠

此API让您可以管理特别目录优惠活动。

操作

折扣

此API让您可以管理折扣促销活动。

操作

奖励

此API让您可以管理奖励促销活动。

操作

创建奖励促销活动Server-sideAdmin

请求

创建奖励促销活动。

促销活动对进行购买的用户给予免费的奖励商品。 促销活动可以应用于项目中的任何购买或包含特定商品的购买。

安全
basicAuth
路径
project_idinteger必需

项目ID。您可以在您的发布商帐户项目名称旁边找到。

示例: 44056
正文application/json
attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(promotion_user-attribute_conditions_model-post)[ 1 .. 100 ] items

用户属性验证条件。 根据用户属性是否满足所有指定条件来确定促销活动可用性。

bonusArray of objects or null必需
bonus[].​quantitynumber

商品数量。

默认值 1
bonus[].​skustring

商品SKU。

默认值 "elven_shield"
conditionArray of objects or null必需

要应用促销必须在购买项中包含的一组商品。如果此参数为null,则促销将应用于项目内的任何购买。

condition[].​skustring

商品SKU。

默认值 "elven_sword"
excluded_promotionsArray of integers(excluded_promotions)

应用此促销活动时要排除的促销活动ID列表。
Example:[12, 789]

示例: [12,789]
idinteger

促销活动ID。项目内的唯一促销活动标识符。

is_enabledboolean(Promotions_is_enabled)

是否启用了促销活动。

示例: true
limitsobject(Promotions_promotion_limits)

促销活动限制。

nameobject必需

促销活动名称。应包含键/值对,其中键是"^[a-z]{2}-[A-Z]{2}$"格式的区域设置,值是字符串。

示例: {"de-DE":"Sommersaison Bonus","en-US":"Summer season bonus"}
name.​property name*string附加属性
price_conditionsArray of objects or null(price_conditions_bonus)

包含条件的对象数组,用于设置应用促销活动的价格范围。
促销活动仅应用于价格符合数组中所有条件的商品。如果传递此数组,请将condition对象的值设置为null

promotion_periodsArray of objects(promotion_periods)

促销活动有效期。若指定了多个时间段,则date_fromdate_until均为必需。

curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/zh/api/liveops/v3/project/44056/admin/promotion/bonus \
  -H 'Content-Type: application/json' \
  -d '{
    "attribute_conditions": [
      {
        "attribute": "account_status",
        "can_be_missing": false,
        "operator": "eq",
        "type": "string",
        "value": "golden"
      }
    ],
    "bonus": [
      {
        "quantity": 50000,
        "sku": "com.xsolla.mp_credits"
      }
    ],
    "condition": [
      {
        "sku": "com.xsolla.year_1_season_pass"
      }
    ],
    "name": {
      "de-DE": "Neujahrsbonus",
      "en-US": "New Year Bonus"
    },
    "promotion_periods": [
      {
        "date_from": "2020-04-15T18:16:00+05:00",
        "date_until": "2020-04-25T18:16:00+05:00"
      }
    ]
  }'

响应

促销活动已成功创建。

正文application/json
promotion_idinteger

促销活动ID。项目内的唯一促销活动标识符。

响应
application/json
{ "promotion_id": 2384756 }

删除奖励促销活动Server-sideAdmin

请求

删除奖励促销活动。删除的促销活动将:

  • 从您项目中设置的促销活动列表中消。失
  • 不再适用于商品目录和购物车。用户无法通过该促销活动获得奖励商品。

删除后,该促销活动无法恢复。

安全
basicAuth
路径
project_idinteger必需

项目ID。您可以在您的发布商帐户项目名称旁边找到。

示例: 44056
promotion_idinteger必需

促销活动ID。项目内的唯一促销活动标识符。

示例: 111425
curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/zh/api/liveops/v3/project/44056/admin/promotion/111425/bonus

响应

成功删除促销活动。

响应
无内容

获取奖励促销活动Server-sideAdmin

请求

获取奖励促销活动。

促销活动对进行购买的用户给予免费的奖励商品。 促销活动可以应用于项目中的任何购买或包含特定商品的购买。

安全
basicAuth
路径
project_idinteger必需

项目ID。您可以在您的发布商帐户项目名称旁边找到。

示例: 44056
promotion_idinteger必需

促销活动ID。项目内的唯一促销活动标识符。

示例: 111425
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/zh/api/liveops/v3/project/44056/admin/promotion/111425/bonus

响应

奖励促销活动已成功收到。

正文application/json
attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(promotion_user-attribute_conditions_model-get)[ 1 .. 100 ] items

用户属性验证条件。 根据用户属性是否满足所有指定条件来确定促销活动可用性。

bonusArray of objects or null
conditionArray of objects or null

要应用促销必须在购买项中包含的一组商品。如果此参数为null,则促销将应用于项目内的任何购买。

excluded_promotionsArray of integers(excluded_promotions)

应用此促销活动时要排除的促销活动ID列表。
Example:[12, 789]

示例: [12,789]
idinteger

促销活动ID。项目内的唯一促销活动标识符。

is_enabledboolean
默认值 true
limitsobject(Promotions_promotion_limits_response)

促销活动限制。

nameobject

促销活动名称。应包含键/值对, 其中键是"^[a-z]{2}-[A-Z]{2}$"格式的区域设置,值是字符串。

示例: {"de-DE":"Sommersaison Bonus","en-US":"Summer season bonus"}
price_conditionsArray of objects or null(price_conditions_bonus)

包含条件的对象数组,用于设置应用促销活动的价格范围。
促销活动仅应用于价格符合数组中所有条件的商品。如果传递此数组,请将condition对象的值设置为null

promotion_periodsArray of objects(promotion_periods)

促销活动有效期。若指定了多个时间段,则date_fromdate_until均为必需。

响应
application/json
{ "bonus": [ {}, {}, {} ], "condition": [ {}, {} ], "excluded_promotions": [ 23, 45 ], "id": 1, "is_enabled": true, "limits": { "per_item": null, "per_user": {}, "recurrent_schedule": {} }, "name": { "de-DE": "Neujahrsbonus", "en-US": "New Year Bonus" }, "price_conditions": [ {}, {} ], "promotion_periods": [ {} ] }

个性化目录

此API可让您针对用户属性指定规则。如果用户满足具体规则的所有条件,则会显示个性化商品。

有关个性化促销活动的信息,请参阅促销活动部分

要在购买前传递属性,您可以使用艾克索拉Login API或在使Pay Station API生成令牌时将它们传入user.attributes属性

操作
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作