# LiveOps API # Overview * **Version:** 2.0.0 * **Servers**: `https://store.xsolla.com/api` * **[Contact Us by Email](mailto:integration@xsolla.com)** * **Contact URL:** https://xsolla.com/ * **Required TLS version:** 1.2 LiveOps API提供用于提升玩家参与度的端点。 Version: 2.0.0 ## Servers ``` https://store.xsolla.com/api ``` ## Security ### AuthForCart 销售包含游戏的购物车时，您可以[在未授权状态下调用端点](/zh/doc/buy-button/how-to/set-up-authentication/#guides_buy_button_selling_items_not_authenticated_users)。 具体方法： * 向游戏标头中的`x-unauthorized-id`参数添加一个唯一标识符。 * 将用户的电子邮件添加到游戏标头中的`x-user`参数（根据Base64加密）。 默认情况下使用艾克索拉登录管理器用户JWT（持有者令牌）进行授权。您可以尝试使用艾克索拉登录管理器测试用户JWT令牌来调用此端点：`Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI`。 您也可以用[支付中心访问令牌](https://developers.xsolla.com/zh/api/pay-station/operation/create-token/)作为替代。 Type: http Scheme: bearer ### XsollaLoginUserJWT 默认情况下使用艾克索拉登录管理器用户JWT（持有者令牌）进行授权。您可以尝试使用艾克索拉登录管理器测试用户JWT令牌来调用此端点：`Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI`。 您也可以使用[支付中心访问令牌](https://developers.xsolla.com/zh/api/pay-station/operation/create-token/)作为替代。 Type: http Scheme: bearer Bearer Format: JWT ### basicAuth Xsolla API 使用基本访问身份验证。所有对 API 的请求都必须包含`Authorization: Basic `标题，其中`your_authorization_basic_key`是个`project_id:api_key`根据 Base64 标准进行编码。 您可以使用`merchant_id` 而不是`project_id` 如果需要的话。它不会影响功能。 去[发布商帐户](https://publisher.xsolla.com/)查找参数值： * `merchant_id` 显示为： * 在 **公司设置 > 公司** 部分 * 在任何发布商帐户页面的浏览器地址栏中的 URL 中。URL 的格式如下：`https://publisher.xsolla.com/`。 * `api_key` 创建后仅在发布商帐户中显示一次，并且必须存储在您这边。您可以在以下部分创建新密钥： * **公司设置 > API 密钥** * **项目设置 > API 密钥** * `project_id` 显示为： * 在发布者帐户中，项目名称旁边。 * 在发布者帐户中处理项目时，浏览器地址栏中的 URL。URL 格式如下：`https://publisher.xsolla.com//projects/`。 有关使用 API 密钥的更多信息，请参阅[API 参考](https://developers.xsolla.com/zh/api/getting-started/#api_keys_overview)。 Type: http Scheme: basic ### basicMerchantAuth 艾克索拉API使用基本认证。所有发送到API的请求必须包含`Authorization: Basic `头，其中`your_authorization_basic_key`是根据Base64标准加密的`merchant_id:api_key`对。 去[发布商帐户](https://publisher.xsolla.com/)查找参数值： * `merchant_id` 显示为： * 在 **公司设置 > 公司** 部分 * 在任何发布商帐户页面的浏览器地址栏中的 URL 中。URL 的格式如下：`https://publisher.xsolla.com/` * `api_key` 创建后仅在发布商帐户中显示一次，并且必须存储在您这边。您可以在以下部分创建新密钥： * **公司设置 > API 密钥** * **项目设置 > API 密钥** 有关使用 API 密钥的更多信息，请参阅[API 参考](https://developers.xsolla.com/zh/api/getting-started/#api_keys_overview)。 Type: http Scheme: basic ## Download OpenAPI description [LiveOps API](https://developers.xsolla.com/_bundle/@l10n/zh/api/liveops/index.yaml) ## 通用 ### 激活促销活动 - [PUT /v2/project/{project_id}/admin/promotion/{promotion_id}/activate](https://developers.xsolla.com/zh/api/liveops/promotions-common/activate-promotion.md): 激活促销活动。 ### 停用促销活动 - [PUT /v2/project/{project_id}/admin/promotion/{promotion_id}/deactivate](https://developers.xsolla.com/zh/api/liveops/promotions-common/deactivate-promotion.md): 停用促销活动。 ### 验证促销码 - [GET /v2/project/{project_id}/promotion/code/{code}/verify](https://developers.xsolla.com/zh/api/liveops/promotions-common/verify-promotion-code.md): 确定代码是促销码还是优惠券码以及用户是否可以应用它。 ### 获取所有促销活动列表 - [GET /v3/project/{project_id}/admin/promotion](https://developers.xsolla.com/zh/api/liveops/promotions-common/get-promotion-list.md): 获取项目的促销活动列表。 ### 通过代码获取兑换型促销活动 - [GET /v3/project/{project_id}/admin/promotion/redeemable/code/{code}](https://developers.xsolla.com/zh/api/liveops/promotions-common/get-redeemable-promotion-by-code.md): 通过促销码或优惠券码获取促销活动。 ## 优惠券 此API让您可以管理优惠券。 ### 获取唯一优惠券码限制 - [GET /v2/project/{project_id}/admin/code/limit/coupon/external_id/{external_id}](https://developers.xsolla.com/zh/api/liveops/promotions-coupons/get-coupon-code-limit.md): 获取代码可以使用的剩余次数。要筛选代码，请使用codes查询参数。 要配置代码限制本身，请前往“管理”部分： *优惠券 ### 激活优惠券促销活动 - [PUT /v2/project/{project_id}/admin/coupon/{external_id}/activate](https://developers.xsolla.com/zh/api/liveops/promotions-coupons/activate-coupon.md): 激活优惠券促销活动。 默认情况下创建的优惠券促销活动为禁用状态。 激活之前，不能进行兑换。 使用此端点启用和激活优惠券促销活动。 ### 获取优惠券码 - [GET /v2/project/{project_id}/admin/coupon/{external_id}/code](https://developers.xsolla.com/zh/api/liveops/promotions-coupons/get-coupon-codes.md): 获取优惠券码。 ### 创建优惠券码 - [POST /v2/project/{project_id}/admin/coupon/{external_id}/code](https://developers.xsolla.com/zh/api/liveops/promotions-coupons/create-coupon-code.md): 创建优惠券码。 ### 生成优惠券码 - [PUT /v2/project/{project_id}/admin/coupon/{external_id}/code/generate](https://developers.xsolla.com/zh/api/liveops/promotions-coupons/generate-coupon-codes.md): 生成优惠券码。 ### 停用优惠券促销活动 - [PUT /v2/project/{project_id}/admin/coupon/{external_id}/deactivate](https://developers.xsolla.com/zh/api/liveops/promotions-coupons/deactivate-coupon.md): 停用优惠券促销活动。 默认情况下创建的优惠券促销活动为禁用状态。 激活之前，不能进行兑换。 使用此端点禁用和停用优惠券促销活动。 ### 获取指定用户的优惠券限制 - [GET /v2/project/{project_id}/admin/user/limit/coupon/external_id/{external_id}](https://developers.xsolla.com/zh/api/liveops/promotions-coupons/get-coupon-user-limit.md): 获取指定用户可以使用优惠券的剩余次数。 用户限制API允许您限制用户可以使用优惠券的次数。要配置用户限制数本身，请前往“管理”部分： * 优惠券 ### 获取优惠券奖励 - [GET /v2/project/{project_id}/coupon/code/{coupon_code}/rewards](https://developers.xsolla.com/zh/api/liveops/promotions-coupons/get-coupon-rewards-by-code.md): 通过券码获取优惠券奖励。 可用于允许用户从众多商品中选择一个作为奖励。 通常情况下，如果优惠券包含游戏作为奖励(type=unit)，则为选择一个DRM。 ### 兑换优惠券码 - [POST /v2/project/{project_id}/coupon/redeem](https://developers.xsolla.com/zh/api/liveops/promotions-coupons/redeem-coupon.md): 兑换优惠券码。用户在兑换优惠券后获得奖励。 ### 获取优惠券促销活动列表 - [GET /v3/project/{project_id}/admin/coupon](https://developers.xsolla.com/zh/api/liveops/promotions-coupons/get-coupons.md): 获取项目的优惠券促销活动列表。 ### 创建优惠券促销活动 - [POST /v3/project/{project_id}/admin/coupon](https://developers.xsolla.com/zh/api/liveops/promotions-coupons/admin-create-coupon.md): 创建优惠券促销活动。 ### 删除优惠券促销活动 - [DELETE /v3/project/{project_id}/admin/coupon/{external_id}](https://developers.xsolla.com/zh/api/liveops/promotions-coupons/delete-coupon-promotion.md): 删除优惠券促销活动。删除的促销活动将： * 从您项目中设置的促销活动列表中消失。 * 不再适用于商品目录。用户无法通过该促销活动获得奖励商品。 删除后，该促销活动无法恢复。 已删除促销活动的优惠券代码可以添加到现有的促销活动。 ### 获取优惠券促销活动 - [GET /v3/project/{project_id}/admin/coupon/{external_id}](https://developers.xsolla.com/zh/api/liveops/promotions-coupons/get-coupon.md): 获取指定的优惠券促销活动。 ### 更新优惠券促销活动 - [PUT /v3/project/{project_id}/admin/coupon/{external_id}](https://developers.xsolla.com/zh/api/liveops/promotions-coupons/update-coupon-promotion.md): 更新优惠券促销活动。 ## 促销码 此API让您可以管理促销码。 ### 获取代码的促销码限制 - [GET /v2/project/{project_id}/admin/code/limit/promocode/external_id/{external_id}](https://developers.xsolla.com/zh/api/liveops/promotions-promo-codes/get-promo-code-code-limit.md): 获取代码可以使用的剩余次数。要筛选代码，请使用codes查询参数。 要配置代码限制本身，请前往“管理”部分： *促销码 ### 激活促销码活动 - [PUT /v2/project/{project_id}/admin/promocode/{external_id}/activate](https://developers.xsolla.com/zh/api/liveops/promotions-promo-codes/activate-promo-code.md): 激活促销码活动。 默认情况下创建的促销码活动为禁用状态。 激活之前，不能进行兑换。 使用此端点启用和激活促销码活动。 ### 获取促销码活动的促销码 - [GET /v2/project/{project_id}/admin/promocode/{external_id}/code](https://developers.xsolla.com/zh/api/liveops/promotions-promo-codes/get-promocode-codes.md): 获取促销码活动的促销码。 ### 创建促销码活动的促销码 - [POST /v2/project/{project_id}/admin/promocode/{external_id}/code](https://developers.xsolla.com/zh/api/liveops/promotions-promo-codes/create-promo-code-code.md): 为促销码活动创建促销码。 ### 生成促销码活动的促销码 - [PUT /v2/project/{project_id}/admin/promocode/{external_id}/code/generate](https://developers.xsolla.com/zh/api/liveops/promotions-promo-codes/generate-promo-code-codes.md): 生成促销码活动的促销码。 ### 停用促销码活动 - [PUT /v2/project/{project_id}/admin/promocode/{external_id}/deactivate](https://developers.xsolla.com/zh/api/liveops/promotions-promo-codes/deactivate-promo-code.md): 停用促销码活动。 默认情况下创建的促销码活动为禁用状态。 激活之前，不能进行兑换。 使用此端点禁用和停用促销码活动。 ### 获取指定用户的促销码限制 - [GET /v2/project/{project_id}/admin/user/limit/promocode/external_id/{external_id}](https://developers.xsolla.com/zh/api/liveops/promotions-promo-codes/get-promo-code-user-limit.md): 获取指定用户可以使用促销码的剩余次数。 用户限制API允许您限制用户可以使用促销码的次数。要配置用户限制数本身，请前往“管理”部分： * 促销码 ### 获取促销码奖励 - [GET /v2/project/{project_id}/promocode/code/{promocode_code}/rewards](https://developers.xsolla.com/zh/api/liveops/promotions-promo-codes/get-promo-code-rewards-by-code.md): 通过促销码获取奖励。 可用于允许用户从众多商品中选择一个作为奖励。 通常情况下，如果优惠码包含游戏作为奖励(type=unit)，则为选择一个DRM。 ### 兑换促销码 - [POST /v2/project/{project_id}/promocode/redeem](https://developers.xsolla.com/zh/api/liveops/promotions-promo-codes/redeem-promo-code.md): 兑换促销码活动的促销码。 兑换促销码后，用户将获得免费商品和/或购物车和/或特定商品的价格折扣。 ### 移除购物车的促销码 - [PUT /v2/project/{project_id}/promocode/remove](https://developers.xsolla.com/zh/api/liveops/promotions-promo-codes/remove-cart-promo-code.md): 移除购物车的促销码。 删除促销码后，将重新计算购物车中所有商品的总价，去掉促销码提供的奖励和折扣。 ### 获取促销码活动列表 - [GET /v3/project/{project_id}/admin/promocode](https://developers.xsolla.com/zh/api/liveops/promotions-promo-codes/get-promo-codes.md): 获取项目的促销码列表。 ### 创建促销码活动 - [POST /v3/project/{project_id}/admin/promocode](https://developers.xsolla.com/zh/api/liveops/promotions-promo-codes/create-promo-code.md): 创建促销码活动。 ### 删除促销码活动 - [DELETE /v3/project/{project_id}/admin/promocode/{external_id}](https://developers.xsolla.com/zh/api/liveops/promotions-promo-codes/delete-promo-code.md): 删除促销码活动。删除的促销活动将： * 从您项目中设置的促销活动列表中消失。 * 不再适用于商品目录和购物车。用户无法通过该促销活动获得奖励商品或购买商品。 删除后，该促销活动无法恢复。 已删除促销活动的促销码可以添加到现有的促销活动。 ### 获取促销码活动 - [GET /v3/project/{project_id}/admin/promocode/{external_id}](https://developers.xsolla.com/zh/api/liveops/promotions-promo-codes/get-promo-code.md): 获取指定的促销码活动。 ### 更新促销码活动 - [PUT /v3/project/{project_id}/admin/promocode/{external_id}](https://developers.xsolla.com/zh/api/liveops/promotions-promo-codes/update-promo-code.md): 更新促销码活动。 ## 特别目录优惠 此API让您可以管理特别目录优惠活动。 ### 激活特别目录优惠促销活动 - [PUT /v2/project/{project_id}/admin/unique_catalog_offer/{external_id}/activate](https://developers.xsolla.com/zh/api/liveops/promotions-unique-catalog-offers/activate-unique-catalog-offer.md): 激活特别目录优惠促销活动。 默认情况下创建的特别目录促销活动为禁用状态。 激活之前，不能进行兑换。 使用此端点启用和激活优惠券促销活动。 ### 获取特别目录优惠代码 - [GET /v2/project/{project_id}/admin/unique_catalog_offer/{external_id}/code](https://developers.xsolla.com/zh/api/liveops/promotions-unique-catalog-offers/get-unique-catalog-offer-codes.md): 获取特别目录优惠代码。 ### 创建特别目录优惠代码 - [POST /v2/project/{project_id}/admin/unique_catalog_offer/{external_id}/code](https://developers.xsolla.com/zh/api/liveops/promotions-unique-catalog-offers/create-unique-catalog-offer-code.md): 创建特别目录优惠代码。 ### 生成特别目录优惠代码 - [PUT /v2/project/{project_id}/admin/unique_catalog_offer/{external_id}/code/generate](https://developers.xsolla.com/zh/api/liveops/promotions-unique-catalog-offers/generate-unique-catalog-offer-codes.md): 生成特别目录优惠代码。 ### 停用特别目录优惠促销活动 - [PUT /v2/project/{project_id}/admin/unique_catalog_offer/{external_id}/deactivate](https://developers.xsolla.com/zh/api/liveops/promotions-unique-catalog-offers/deactivate-unique-catalog-offer.md): 停用特别目录优惠促销活动。 默认情况下创建的特别目录促销活动为禁用状态。 激活之前，不能进行兑换。 使用此端点禁用和停用优惠券促销活动。 ### 获取特别目录优惠促销活动列表 - [GET /v3/project/{project_id}/admin/unique_catalog_offer](https://developers.xsolla.com/zh/api/liveops/promotions-unique-catalog-offers/get-unique-catalog-offers.md): 获取项目的特别目录优惠促销活动的列表。 ### 创建特别目录优惠促销活动 - [POST /v3/project/{project_id}/admin/unique_catalog_offer](https://developers.xsolla.com/zh/api/liveops/promotions-unique-catalog-offers/admin-create-unique-catalog-offer.md): 创建一个特别目录优惠促销活动。 ### 删除特别目录优惠促销活动 - [DELETE /v3/project/{project_id}/admin/unique_catalog_offer/{external_id}](https://developers.xsolla.com/zh/api/liveops/promotions-unique-catalog-offers/delete-unique-catalog-offer-promotion.md): 删除特别目录优惠促销活动。删除的促销活动将： * 从您项目中设置的促销活动列表中消失。 * 不再适用于商品目录和购物车。用户无法通过该促销活动购买商品。 删除后，该促销活动无法恢复。 ### 获取特别目录优惠促销活动 - [GET /v3/project/{project_id}/admin/unique_catalog_offer/{external_id}](https://developers.xsolla.com/zh/api/liveops/promotions-unique-catalog-offers/get-unique-catalog-offer.md): 获取指定的特别目录优惠促销活动。 ### 更新特别目录优惠促销活动 - [PUT /v3/project/{project_id}/admin/unique_catalog_offer/{external_id}](https://developers.xsolla.com/zh/api/liveops/promotions-unique-catalog-offers/update-unique-catalog-offer-promotion.md): 更新特别目录优惠促销活动。 ## 折扣 此API让您可以管理折扣促销活动。 ### 获取商品促销活动列表 - [GET /v3/project/{project_id}/admin/promotion/item](https://developers.xsolla.com/zh/api/liveops/promotions-discounts/get-item-promotion-list.md): 获取项目的商品促销列表。 促销活动提供商品折扣(%)。 折扣应用于指定商品的所有价格。 ### 为商品创建折扣促销活动 - [POST /v3/project/{project_id}/admin/promotion/item](https://developers.xsolla.com/zh/api/liveops/promotions-discounts/create-item-promotion.md): 为商品创建折扣促销活动。 促销活动提供商品折扣(%)。 折扣将应用于指定商品的所有价格。 ### 删除商品促销活动 - [DELETE /v3/project/{project_id}/admin/promotion/{promotion_id}/item](https://developers.xsolla.com/zh/api/liveops/promotions-discounts/delete-item-promotion.md): 删除折扣促销活动。删除的促销活动将： * 从您项目中设置的促销活动列表中消失。 * 不再适用于商品目录和购物车。用户无法通过该促销活动购买商品。 删除后，该促销活动无法恢复。 ### 获取商品促销活动 - [GET /v3/project/{project_id}/admin/promotion/{promotion_id}/item](https://developers.xsolla.com/zh/api/liveops/promotions-discounts/get-item-promotion.md): 获取应用于特定商品的促销活动。 促销提供商品折扣 (%)。 折扣将应用于指定商品的所有价格。 ### 更新商品促销活动 - [PUT /v3/project/{project_id}/admin/promotion/{promotion_id}/item](https://developers.xsolla.com/zh/api/liveops/promotions-discounts/update-item-promotion.md): 更新促销活动。 注意新数据将替换旧数据。如果只想更新促销活动的一部分，也应在请求中传输所有必需数据。 促销提供商品折扣(%)。 折扣将应用于指定商品的所有价格。 ## 奖励 此API让您可以管理奖励促销活动。 ### 获取奖励促销活动列表 - [GET /v3/project/{project_id}/admin/promotion/bonus](https://developers.xsolla.com/zh/api/liveops/promotions-bonuses/get-bonus-promotion-list.md): 获取项目的奖励促销活动列表。 促销活动对进行购买的用户给予免费的奖励商品。 促销活动可以应用于项目中的任何购买或包含特定商品的购买。 ### 创建奖励促销活动 - [POST /v3/project/{project_id}/admin/promotion/bonus](https://developers.xsolla.com/zh/api/liveops/promotions-bonuses/create-bonus-promotion.md): 创建奖励促销活动。 促销活动对进行购买的用户给予免费的奖励商品。 促销活动可以应用于项目中的任何购买或包含特定商品的购买。 ### 删除奖励促销活动 - [DELETE /v3/project/{project_id}/admin/promotion/{promotion_id}/bonus](https://developers.xsolla.com/zh/api/liveops/promotions-bonuses/delete-bonus-promotion.md): 删除奖励促销活动。删除的促销活动将： * 从您项目中设置的促销活动列表中消。失 * 不再适用于商品目录和购物车。用户无法通过该促销活动获得奖励商品。 删除后，该促销活动无法恢复。 ### 获取奖励促销活动 - [GET /v3/project/{project_id}/admin/promotion/{promotion_id}/bonus](https://developers.xsolla.com/zh/api/liveops/promotions-bonuses/get-bonus-promotion.md): 获取奖励促销活动。 促销活动对进行购买的用户给予免费的奖励商品。 促销活动可以应用于项目中的任何购买或包含特定商品的购买。 ### 更新奖励促销活动 - [PUT /v3/project/{project_id}/admin/promotion/{promotion_id}/bonus](https://developers.xsolla.com/zh/api/liveops/promotions-bonuses/update-bonus-promotion.md): 更新促销活动。 注意如果只想更新促销活动的一部分，也应在请求中传输所有必需数据。 促销活动对进行购买的用户给予免费的奖励商品。 促销活动可以应用于项目中的任何购买或包含特定商品的购买。 ## 个性化目录 此API可让您针对用户属性指定规则。如果用户满足具体规则的所有条件，则会显示个性化商品。 有关个性化促销活动的信息，请参阅[促销活动部分](/zh/api/shop-builder/tag/promotions-discounts)。 要在购买前传递属性，您可以使用[艾克索拉Login API](/zh/api/login/operation/update-users-attributes-from-server/)或在[使Pay Station API生成令牌时将它们传入user.attributes属性](/zh/api/pay-station/operation/create-token)。 ### 获取目录筛选规则列表 - [GET /v2/project/{project_id}/admin/user/attribute/rule](https://developers.xsolla.com/zh/api/liveops/personalized-catalog/get-filter-rules.md): 获取应用于用户属性的所有规则。 ### 创建目录筛选规则 - [POST /v2/project/{project_id}/admin/user/attribute/rule](https://developers.xsolla.com/zh/api/liveops/personalized-catalog/create-filter-rule.md): 创建用户属性的规则。 ### 获取所有目录规则以供在客户端搜索 - [GET /v2/project/{project_id}/admin/user/attribute/rule/all](https://developers.xsolla.com/zh/api/liveops/personalized-catalog/get-all-filter-rules.md): 获取所有目录规则列表以供在客户端搜索。 注意：仅返回规则ID、名称和is_enabled ### 删除目录筛选规则 - [DELETE /v2/project/{project_id}/admin/user/attribute/rule/{rule_id}](https://developers.xsolla.com/zh/api/liveops/personalized-catalog/delete-filter-rule-by-id.md): 删除指定规则。 ### 获取目录筛选规则 - [GET /v2/project/{project_id}/admin/user/attribute/rule/{rule_id}](https://developers.xsolla.com/zh/api/liveops/personalized-catalog/get-filter-rule-by-id.md): 获取应用于用户属性的指定规则。 ### 补丁目录筛选规则 - [PATCH /v2/project/{project_id}/admin/user/attribute/rule/{rule_id}](https://developers.xsolla.com/zh/api/liveops/personalized-catalog/patch-filter-rule-by-id.md): 更新应用于用户属性的指定规则。当前值将用于未指定的属性。 ### 更新目录筛选规则 - [PUT /v2/project/{project_id}/admin/user/attribute/rule/{rule_id}](https://developers.xsolla.com/zh/api/liveops/personalized-catalog/update-filter-rule-by-id.md): 更新应用于用户属性的指定规则。默认值将用于未指定的属性（如果属性非必需）。 ## 管理 ### 刷新指定用户的所有促销活动限制 - [DELETE /v2/project/{project_id}/admin/user/limit/promotion/all](https://developers.xsolla.com/zh/api/liveops/user-limits-admin/reset-all-user-promotions-limit.md): 刷新指定用户所有促销活动的所有限制，以便其可以再次使用这些促销活动。 用户限制API允许您限制用户可以使用促销活动的次数。要自行配置用户限制，请前往所需促销活动类型的“管理”部分： * 折扣促销活动 * 奖励促销活动 ### 减少指定用户的促销活动限制 - [DELETE /v2/project/{project_id}/admin/user/limit/promotion/id/{promotion_id}](https://developers.xsolla.com/zh/api/liveops/user-limits-admin/remove-user-promotion-limit.md): 减少指定用户在应用的限制内可以使用促销活动的剩余次数。 用户限制API允许您限制用户可以使用促销活动的次数。要自行配置用户限制，请前往所需促销活动类型的“管理”部分： * 折扣促销活动 * 奖励促销活动 ### 获取指定用户的促销活动限制 - [GET /v2/project/{project_id}/admin/user/limit/promotion/id/{promotion_id}](https://developers.xsolla.com/zh/api/liveops/user-limits-admin/get-user-promotion-limit.md): 获取指定用户在应用的限制内可以使用促销活动的剩余次数。 用户限制API允许您限制用户可以使用促销活动的次数。要自行配置用户限制，请前往所需促销活动类型的“管理”部分： * 折扣促销活动 * 奖励促销活动 ### 增加指定用户的促销活动限制 - [POST /v2/project/{project_id}/admin/user/limit/promotion/id/{promotion_id}](https://developers.xsolla.com/zh/api/liveops/user-limits-admin/add-user-promotion-limit.md): 增加指定用户在应用的限制内可以使用促销活动的剩余次数。 用户限制API允许您限制用户可以使用促销活动的次数。要自行配置用户限制，请前往所需促销活动类型的“管理”部分： * 折扣促销活动 * 奖励促销活动 ### 设置指定用户的促销活动限制 - [PUT /v2/project/{project_id}/admin/user/limit/promotion/id/{promotion_id}](https://developers.xsolla.com/zh/api/liveops/user-limits-admin/set-user-promotion-limit.md): 在增加或减少次数后设置指定用户在应用的限制内可以使用促销活动的次数。 用户限制API允许您限制用户可以使用促销活动的次数。要自行配置用户限制，请前往所需促销活动类型的“管理”部分： * 折扣促销活动 * 奖励促销活动 ### 刷新用户的促销活动限制 - [DELETE /v2/project/{project_id}/admin/user/limit/promotion/id/{promotion_id}/all](https://developers.xsolla.com/zh/api/liveops/user-limits-admin/reset-user-promotion-limit.md): 刷新促销活动限制以便用户可以再次使用该促销活动。如果user参数为null，此调用将刷新所有用户的此限制。 用户限制API允许您限制用户可以使用促销的次数。要自行配置用户限制，请前往所需促销活动类型的“管理”部分： * 折扣促销活动 * 奖励促销活动 ## 管理 ### 获取奖励积分列表 - [GET /v2/project/{project_id}/admin/items/value_points](https://developers.xsolla.com/zh/api/liveops/reward-chain-value-points-admin/admin-get-value-points-list.md): 获取项目内的奖励积分列表以用于管理。 ### 创建奖励积分 - [POST /v2/project/{project_id}/admin/items/value_points](https://developers.xsolla.com/zh/api/liveops/reward-chain-value-points-admin/admin-create-value-points.md): 创建一个奖励积分。 ### 删除奖励积分 - [DELETE /v2/project/{project_id}/admin/items/value_points/sku/{item_sku}](https://developers.xsolla.com/zh/api/liveops/reward-chain-value-points-admin/admin-delete-value-point.md): 按SKU删除奖励积分。 ### 获取奖励积分 - [GET /v2/project/{project_id}/admin/items/value_points/sku/{item_sku}](https://developers.xsolla.com/zh/api/liveops/reward-chain-value-points-admin/admin-get-value-point.md): 根据项目中的SKU获取奖励积分以进行管理。 ### 更新奖励积分 - [PUT /v2/project/{project_id}/admin/items/value_points/sku/{item_sku}](https://developers.xsolla.com/zh/api/liveops/reward-chain-value-points-admin/admin-update-value-point.md): 按SKU更新奖励积分。 ### 删除商品的奖励积分 - [DELETE /v2/project/{project_id}/admin/items/{value_point_sku}/value_points/rewards](https://developers.xsolla.com/zh/api/liveops/reward-chain-value-points-admin/admin-delete-items-value-point-reward.md): 删除所有商品的奖励积分奖励。 ### 获取有奖励积分的商品列表 - [GET /v2/project/{project_id}/admin/items/{value_point_sku}/value_points/rewards](https://developers.xsolla.com/zh/api/liveops/reward-chain-value-points-admin/admin-get-items-value-point-reward.md): 获取项目内有奖励积分的商品列表以用于管理。 ### 部分更新商品的奖励积分 - [PATCH /v2/project/{project_id}/admin/items/{value_point_sku}/value_points/rewards](https://developers.xsolla.com/zh/api/liveops/reward-chain-value-points-admin/admin-patch-items-value-point-reward.md): 按照商品SKU来部分更新一个或多个商品的奖励积分数量。用户在购买指定商品后可获得这些奖励积分。 更新奖励积分的原则： * 如果某个商品尚无奖励积分，则在amount字段中发送非零值将创建奖励积分。 * 如果某个商品已有奖励积分，则在amount字段中发送非零值将更新原有值。 * 如果amount设置为0，则会删除该商品的现有奖励积分。 与PUT方法（设置商品的奖励积分）不同，此PATCH方法不会覆盖项目中所有商品的现有奖励积分，它只会更新指定的商品。 单个请求最多可以更新100个商品。同一请求中不能包含重复的商品SKU。 ### 设置商品的奖励积分 - [PUT /v2/project/{project_id}/admin/items/{value_point_sku}/value_points/rewards](https://developers.xsolla.com/zh/api/liveops/reward-chain-value-points-admin/admin-set-items-value-point-reward.md): 按SKU将奖励积分分配给一件或多件商品。用户购买这些商品后将获得奖励积分。 请注意，此PUT请求将覆盖项目中商品所有先前设置的奖励积分。 为了避免无意中删除奖励积分，请在每个PUT请求中包含所有商品及其各自的奖励积分。 如果只想更新特定商品的奖励积分，同时保留其他商品的奖励积分，则应使用GET请求检索当前的奖励积分集，修改所需商品的奖励积分，然后返回包含特定商品更新后奖励积分的奖励积分集。 ### 获取奖励链列表 - [GET /v3/project/{project_id}/admin/reward_chain](https://developers.xsolla.com/zh/api/liveops/reward-chain-value-points-admin/admin-get-reward-chains.md): 获取奖励链列表。 注意：所有项目对于可以在响应中获得的商品数量均都限制。默认值和最大值是每个响应10项。要逐页获取更多数据，请使用limit和offset字段。 ### 创建奖励链 - [POST /v3/project/{project_id}/admin/reward_chain](https://developers.xsolla.com/zh/api/liveops/reward-chain-value-points-admin/admin-create-reward-chain.md): 创建奖励链。 ### 删除奖励链 - [DELETE /v3/project/{project_id}/admin/reward_chain/id/{reward_chain_id}](https://developers.xsolla.com/zh/api/liveops/reward-chain-value-points-admin/admin-delete-reward-chain.md): 删除特定奖励链。 ### 获取奖励链 - [GET /v3/project/{project_id}/admin/reward_chain/id/{reward_chain_id}](https://developers.xsolla.com/zh/api/liveops/reward-chain-value-points-admin/admin-get-reward-chain.md): 获取特定奖励链。 ### 更新奖励链 - [PUT /v3/project/{project_id}/admin/reward_chain/id/{reward_chain_id}](https://developers.xsolla.com/zh/api/liveops/reward-chain-value-points-admin/admin-update-reward-chain.md): 更新特定奖励链。 ### 重置奖励链 - [POST /v3/project/{project_id}/admin/reward_chain/id/{reward_chain_id}/reset](https://developers.xsolla.com/zh/api/liveops/reward-chain-value-points-admin/admin-reset-reward-chain.md): 重置奖励链中所有用户的奖励积分和进度。重置后，您可以更新奖励链的有效期，用户可以再次参与奖励链。 注意 不应在奖励链有效期内重置奖励链。在这种情况下，用户可能会在领取奖励之前失去已得到的奖励积分。 ### 开关奖励链 - [PUT /v3/project/{project_id}/admin/reward_chain/id/{reward_chain_id}/toggle](https://developers.xsolla.com/zh/api/liveops/reward-chain-value-points-admin/admin-toggle-reward-chain.md): 启用/禁用奖励链。 ## 客户端 ### 获取当前用户的奖励链 - [GET /v2/project/{project_id}/user/reward_chain](https://developers.xsolla.com/zh/api/liveops/reward-chain-client/get-reward-chains-list.md): 客户端端点。获取当前用户的奖励链。 注意：所有项目对于可以在响应中获得的商品数量均都限制。默认值和最大值是每个响应50项。要逐页获取更多数据，请使用limit和offset字段。 ### 获取当前用户的奖励积分余额 - [GET /v2/project/{project_id}/user/reward_chain/{reward_chain_id}/balance](https://developers.xsolla.com/zh/api/liveops/reward-chain-client/get-user-reward-chain-balance.md): 客户端端点。获取当前用户的奖励积分余额。 ### 领取步骤奖励 - [POST /v2/project/{project_id}/user/reward_chain/{reward_chain_id}/step/{step_id}/claim](https://developers.xsolla.com/zh/api/liveops/reward-chain-client/claim-user-reward-chain-step-reward.md): 客户端端点。从奖励链中领取当前用户的步骤奖励。 ## 公会客户端 ### 获取公会名下奖励链的前10名贡献者列表 - [GET /v2/project/{project_id}/user/clan/contributors/{reward_chain_id}/top](https://developers.xsolla.com/zh/api/liveops/clan-reward-chain-client/get-user-clan-top-contributors.md): 检索当前用户公会名下指定奖励链的前10名贡献者列表。如果用户不属于任何公会，则该调用返回将为空数组。 ### 更新当前用户的公会 - [PUT /v2/project/{project_id}/user/clan/update](https://developers.xsolla.com/zh/api/liveops/clan-reward-chain-client/user-clan-update.md): 根据用户属性更新当前用户的公会。领取奖励链中在上一个公会未领取的所有奖励。如果用户之前在某个公会中，但现在不在，则其公会身份将被撤销。如果用户更改了公会，则公会将被更改。 ## 管理 ### 获取每日奖励列表 - [GET /v2/project/{project_id}/admin/daily_chain](https://developers.xsolla.com/zh/api/liveops/daily-chain-admin/admin-get-daily-chains.md): 获取每日奖励列表以进行管理。 注意此方法返回分页的商品列表。最大值和默认值为每个响应50项。如要从列表中获取更多项，请使用limit和offset参数并获取更多页。例如，当使用limit = 25和offset = 100调用方法时，响应将从整体列表中的第101项开始返回25项。 ### 创建每日奖励 - [POST /v2/project/{project_id}/admin/daily_chain](https://developers.xsolla.com/zh/api/liveops/daily-chain-admin/admin-create-daily-chain.md): 创建每日奖励。 ### 删除每日奖励 - [DELETE /v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}](https://developers.xsolla.com/zh/api/liveops/daily-chain-admin/admin-delete-daily-chain.md): 删除指定每日奖励。 ### 获取每日奖励 - [GET /v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}](https://developers.xsolla.com/zh/api/liveops/daily-chain-admin/admin-get-daily-chain.md): 获取指定每日奖励以用于管理。 ### 更新每日奖励 - [PUT /v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}](https://developers.xsolla.com/zh/api/liveops/daily-chain-admin/admin-update-daily-chain.md): 更新指定每日奖励。 ### 重置每日奖励 - [POST /v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}/reset](https://developers.xsolla.com/zh/api/liveops/daily-chain-admin/admin-reset-daily-chain.md): 重置所有用户的每日奖励进度。仅适用于rolling类型每日奖励。 ### 切换每日奖励 - [PUT /v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}/toggle](https://developers.xsolla.com/zh/api/liveops/daily-chain-admin/admin-toggle-daily-chain.md): 启用或禁用每日奖励。 ## 客户端 ### 获取当前用户的每日奖励 - [GET /v2/project/{project_id}/user/daily_chain](https://developers.xsolla.com/zh/api/liveops/daily-chain-client/get-daily-chains-list.md): 客户端端点。获取当前用户的每日奖励。 注意此方法返回分页的商品列表。最大值和默认值为每个响应50项。如要从列表中获取更多项，请使用limit和offset参数并获取更多页。例如，当使用limit = 25和offset = 100调用方法时，响应将从整体列表中的第101项开始返回25项。 ### 通过ID获取当前用户的每日奖励 - [GET /v2/project/{project_id}/user/daily_chain/{daily_chain_id}](https://developers.xsolla.com/zh/api/liveops/daily-chain-client/get-user-daily-chain-by-id.md): 客户端端点。通过ID获取当前用户的每日奖励。 ### 领取每日奖励步骤 - [POST /v2/project/{project_id}/user/daily_chain/{daily_chain_id}/step/number/{step_number}/claim](https://developers.xsolla.com/zh/api/liveops/daily-chain-client/claim-user-daily-chain-step-reward.md): 客户端端点。从每日奖励中领取当前用户的步骤奖励。所有步骤只能按顺序领取。错过步骤的奖励无法通过虚拟或真实货币购买或通过观看广告获得 ## 管理 ### 获取优惠链列表 - [GET /v2/project/{project_id}/admin/offer_chain](https://developers.xsolla.com/zh/api/liveops/offer-chain-admin/admin-get-offer-chains.md): 获取优惠链列表以用于管理。 注意所有项目的单次响应中返回的商品数量都有上限。默认值和最大值为每次响应10个商品。如需更多数据，可通过limit与offset参数分页获取。 ### 创建优惠链 - [POST /v2/project/{project_id}/admin/offer_chain](https://developers.xsolla.com/zh/api/liveops/offer-chain-admin/admin-create-offer-chain.md): 创建优惠链。 ### 删除优惠链 - [DELETE /v2/project/{project_id}/admin/offer_chain/id/{offer_chain_id}](https://developers.xsolla.com/zh/api/liveops/offer-chain-admin/admin-delete-offer-chain.md): 删除指定优惠链。 删除后：用户已收到的奖励保留。未完成步骤不再可用，不可再获取奖励。 与通过启停优惠链禁用优惠链不同，删除不可恢复，用户进度不保留。 ### 获取优惠链 - [GET /v2/project/{project_id}/admin/offer_chain/id/{offer_chain_id}](https://developers.xsolla.com/zh/api/liveops/offer-chain-admin/admin-get-offer-chain.md): 获取指定优惠链以用于管理。 ### 更新优惠链 - [PUT /v2/project/{project_id}/admin/offer_chain/id/{offer_chain_id}](https://developers.xsolla.com/zh/api/liveops/offer-chain-admin/admin-update-offer-chain.md): 更新指定优惠链。 ### 启停优惠链 - [PUT /v2/project/{project_id}/admin/offer_chain/id/{offer_chain_id}/toggle](https://developers.xsolla.com/zh/api/liveops/offer-chain-admin/admin-toggle-offer-chain.md): 启用/禁用优惠链。 禁用后，用户暂时无法访问，但进度保留。 重新启用后，用户可从上次步骤的进度继续。 ## 客户端 ### 获取当前用户的优惠链 - [GET /v2/project/{project_id}/user/offer_chain](https://developers.xsolla.com/zh/api/liveops/offer-chain-client/get-offer-chains-list.md): 获取当前用户的优惠链。 注意所有项目的单次响应中返回的商品数量都有上限。默认值和最大值为每次响应30个商品。如需更多数据，可通过limit与offset参数分页获取。 ### 根据ID获取当前用户的优惠链 - [GET /v2/project/{project_id}/user/offer_chain/{offer_chain_id}](https://developers.xsolla.com/zh/api/liveops/offer-chain-client/get-user-offer-chain-by-id.md): 根据优惠链ID获取当前用户的优惠链。 ### 领取免费优惠链步骤奖励 - [POST /v2/project/{project_id}/user/offer_chain/{offer_chain_id}/step/number/{step_number}/claim](https://developers.xsolla.com/zh/api/liveops/offer-chain-client/claim-user-offer-chain-step-reward.md): 完成当前用户的优惠链步骤进程，并发放相关奖励。 注意 仅对优惠链中的免费步骤使用此调用。 对于需要以真实货币支付的步骤，请改用为付费优惠链步骤创建订单调用。 ### 为付费优惠链步骤创建订单 - [POST /v2/project/{project_id}/user/offer_chain/{offer_chain_id}/step/number/{step_number}/order](https://developers.xsolla.com/zh/api/liveops/offer-chain-client/order-user-offer-chain-step-reward.md): 为指定的付费优惠链步骤关联的商品创建订单。所创建订单的状态为new。 若要在新窗口中打开支付UI，请使用以下链接：https://secure.xsolla.com/paystation4/?token={token}，其中{token}为收到的令牌。 对于测试目的，请使用此URL：https://sandbox-secure.xsolla.com/paystation4/?token={token}。 注意 此方法必须在客户端侧使用。用户的IP地址用于确定所在国家/地区，这会影响适用货币和可用的支付方式。从服务器侧使用此方法可能会导致货币检测错误，并影响支付中心里的支付方式。 注意 此调用仅适用于付费优惠链步骤。 对于免费步骤，请改用领取免费优惠链步骤奖励调用。 ## payment-client-side ### 为付费优惠链步骤创建订单 - [POST /v2/project/{project_id}/user/offer_chain/{offer_chain_id}/step/number/{step_number}/order](https://developers.xsolla.com/zh/api/liveops/offer-chain-client/order-user-offer-chain-step-reward.md): 为指定的付费优惠链步骤关联的商品创建订单。所创建订单的状态为new。 若要在新窗口中打开支付UI，请使用以下链接：https://secure.xsolla.com/paystation4/?token={token}，其中{token}为收到的令牌。 对于测试目的，请使用此URL：https://sandbox-secure.xsolla.com/paystation4/?token={token}。 注意 此方法必须在客户端侧使用。用户的IP地址用于确定所在国家/地区，这会影响适用货币和可用的支付方式。从服务器侧使用此方法可能会导致货币检测错误，并影响支付中心里的支付方式。 注意 此调用仅适用于付费优惠链步骤。 对于免费步骤，请改用领取免费优惠链步骤奖励调用。 ## 管理 ### 获取项目中追加销售的信息 - [GET /v2/project/{project_id}/admin/items/upsell](https://developers.xsolla.com/zh/api/liveops/upsell-admin/get-upsell-configurations-for-project-admin.md): 检索项目中追加销售的信息：是否启用、追加销售的类型以及属于此追加销售的商品SKU列表。 ### 创建追加销售 - [POST /v2/project/{project_id}/admin/items/upsell](https://developers.xsolla.com/zh/api/liveops/upsell-admin/post-upsell.md): 为项目创建追加销售。 ### 更新追加销售 - [PUT /v2/project/{project_id}/admin/items/upsell](https://developers.xsolla.com/zh/api/liveops/upsell-admin/put-upsell.md): 更新项目的追加销售。 ### 激活/停用项目的追加销售 - [PUT /v2/project/{project_id}/admin/items/upsell/{toggle}](https://developers.xsolla.com/zh/api/liveops/upsell-admin/put-upsell-toggle-active-inactive.md): 将项目中追加销售的状态更改为激活或未激活。 ## 客户端 ### 获取项目中追加销售商品的列表 - [GET /v2/project/{project_id}/items/upsell](https://developers.xsolla.com/zh/api/liveops/upsell-client/get-upsell-for-project-client.md): 如果项目中已设置追加销售的商品，则获取其列表。