{"templateId":"openapi_docs","sharedDataIds":{"openAPIDocsStore":"oas-@l10n/zh/api/liveops/index.yaml","sidebar":"sidebar-@l10n/zh/liveops-en.sidebars.yaml"},"props":{"definitionId":"@l10n/zh/api/liveops/index.yaml","dynamicMarkdocComponents":[],"baseSlug":"/zh/api/liveops","seo":{"title":"概述","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]},"description":"促销活动使用限制用于限制特定用户可使用某个促销活动的次数。您还可以配置定时重置限制。\n\n限制数信息存储在艾克索拉侧，可在[发布商帐户](https://publisher.xsolla.com/0/projects/0/storefront/promotions)的促销活动设置中配置，也可以在以下API调用中通过`limits`对象配置：\n* [为商品创建折扣促销活动](/zh/api/liveops/promotions-discounts/create-item-promotion/)或[更新折扣促销活动](/zh/api/liveops/promotions-discounts/update-item-promotion)\n* [创建买赠促销活动](/zh/api/liveops/promotions-bonuses/create-bonus-promotion/)或[更新买赠促销活动](/zh/api/liveops/promotions-bonuses/update-bonus-promotion)\n\nLimit information is returned in the `items.promotions.limits` object in the following API calls for retrieving the items catalog:\n* [Get virtual items list](/zh/api/catalog/virtual-items-currency-catalog/get-virtual-items/)\n* [Get virtual currency list](/zh/api/catalog/virtual-items-currency-catalog/get-virtual-currency/)\n* [Get virtual currency packages list](/zh/api/catalog/virtual-items-currency-catalog/get-virtual-currency-package/)\n* [Get bundles list](/zh/api/catalog/bundles-catalog/get-bundle-list/)\n* [Get games list](/zh/api/catalog/game-keys-catalog/get-games-list/)\n\n**限制**组的**管理**部分中的API调用可用于获取限制的当前状态，并针对特定用户更新限制，例如在任务完成后重置计数器，或手动调整剩余数量。\n\n<div class=\"note\">\n  <b>注：</b><br><br>\n  有关在商品目录中配置限制数的详细信息，请参阅<a href=\"/zh/liveops/promotion-tools/liveops-number-limits/\">促销活动使用限制</a>部分。\n</div>\n\n您可以配置[limits.per_user](/zh/api/liveops/promotions-discounts/create-item-promotion#promotions-discounts/create-item-promotion/t=request&path=limits)，即单个用户可使用某个促销活动的次数限制。\n\n未认证用户始终会看到促销活动的最大可使用次数。\n\n如需显示用户在当前有效限制下剩余的促销活动可使用次数，请在请求商品目录时传入用户授权数据。\n\n如需配置定时重置周期（日、周或月），请在[创建](/zh/api/liveops/promotions-discounts/create-item-promotion#promotions-discounts/create-item-promotion/t=request&path=limits/recurrent_schedule)或[更新](/zh/api/liveops/promotions-discounts/update-item-promotion#promotions-discounts/update-item-promotion/t=request&path=limits/recurrent_schedule)促销活动时传入`limits.recurrent_schedule`对象。\n\n**限制配置和执行场景**\n\n1. 使用[为商品创建折扣促销](/zh/api/liveops/promotions-discounts/create-item-promotion/)或[创建买赠促销活动](/zh/api/liveops/promotions-bonuses/create-bonus-promotion/) API调用创建促销活动，并传入`limits`对象。\n2. 为未认证用户请求商品目录⸺响应会在`items.promotions.limits`对象中返回促销活动的最大可使用次数。\n3. 用户登录。\n4. 使用用户的授权令牌请求商品目录⸺响应会返回当前有效限制下的剩余可使用次数。\n5. 用户选择促销商品并进行购买。\n6. 支付成功后，艾克索拉会更新`items.promotions.limits.per_user`值。当该值达到`0`时，后续商品目录API调用会返回该商品，但不再包含折扣或赠品。\n7. 您可以使用**管理**子部分中的API调用更新限制数：\n   * [刷新指定用户的所有促销活动限制](/zh/api/liveops/user-limits-admin/reset-all-user-promotions-limit/)或[刷新特定促销活动的限制](/zh/api/liveops/user-limits-admin/reset-user-promotion-limit/)\n   * [设置特定限制值](/zh/api/liveops/user-limits-admin/set-user-promotion-limit/)\n   * [增加](/zh/api/liveops/user-limits-admin/add-user-promotion-limit/)或[减少可用次数](/zh/api/liveops/user-limits-admin/remove-user-promotion-limit/)\n8. 在下一次使用用户授权令牌发起的商品目录请求中，您可以从`items.promotions.limits`获取更新后的限制值，并将其显示给用户。\n\n![促销活动限制](https://cdn.xsolla.net/developers/current/images/api_docs/promotion-limit.svg)"},"itemId":"promotion-limits-overview","disableAutoScroll":true,"metadata":{},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"xsolla.redocly.app","port":4000,"ipAddress":"216.73.216.14"},"lang":"zh","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"realm"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/zh/api/liveops/promotion-limits-overview","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}