权益
权益代表客户对数字产品（包括游戏、订阅和附加内容）的访问和使用权利。在 Microsoft Store 中进行的每次购买或兑换都会产生一个或多个由 Microsoft 的 collections 服务跟踪的权益。有关支持权益的产品类型的更多信息，请参阅选择合适的产品类型。 产品权益可以通过玩家直接购买该产品、购买满足关系的产品（例如捆绑包或订阅），或来自另一位用户的共享权益来授予。权益支持多种状态：active、inactive、expired 和 revoked。 游戏客户端和服务都可以查询玩家的权益，但结果可能不同：- 客户端 API 只能返回状态为 active 的权益，但可以返回所有权益类型（直接、共享、满足）。不过，客户端无法看到权益的类型。
- 服务端 API 可以返回任意状态的权益，但由于缺乏设备上下文，无法返回共享权益。不过，它们可以区分直接权益和满足权益。
权益共享与离线可用性
- 当拥有该产品的账号将当前设备指定为其离线设备时（在主机上使用 Home XBOX，或在 PC 上使用 Offline permissions），它会将其非消耗品权益与该设备上的其他账号共享。
- 消耗品权益是直接权益，与购买账号绑定，不能与设备上的其他账号共享。
- 所有权益查询都要求在线连接。请勿使用权益判断玩家在离线时的访问权。请改用授权。
游戏客户端的权益用法
每当客户端发送目录请求时，都会向 collections 服务发送对应的调用，以填充每个返回的 XStoreProduct 的IsInUserCollection 属性。如果 IsInUserCollection 为 true，则表示玩家有权使用该产品。在决定哪些产品在你的游戏内商店中显示为可购买或玩家已“拥有”时，请使用此值。
你可以通过以下方法获取附加内容的 XStoreProduct 详情：
- XStoreQueryAssociatedProductsAsync / Result - 仅返回可购买的产品。结果不包括在 Microsoft Store 中隐藏、仅在捆绑包中可用或已不再可购买的产品。
- XStoreQueryProductsAsync / Result - 用于查询特定产品。使用此函数检查单个产品或产品子集的权益变化。
游戏服务的权益用法
使用游戏服务时，可以获得更高级的权益查询和管理选项。以下是可能功能的一小部分：- 跨整个发行商目录查询用户的权益。
- 区分直接权益和满足权益，以更好地了解玩家如何获取内容。
- 查询将来开始日期的非活跃权益，以检测仍处于预购状态的购买。
- 管理强大的跨平台消耗品生态系统（请参阅基于消耗品的生态系统）。
- 使用 Clawback 服务检测产品何时被退款（请参阅从你的服务管理退款和拒付）。
- 检测 XBOX Game Pass 订阅状态，以在游戏中为订阅者授予福利（请参阅从你的服务检测 XBOX Game Pass 订阅访问）。
权益注意事项
- 在 PC 的开发者沙盒中操作时，客户端会代表登录 XBOX 应用的账号进行所有权益查询。
- 在 PC 的 RETAIL 中操作时，客户端会代表登录 Microsoft Store 的账号进行所有权益查询。当登录游戏的账号与登录 Microsoft Store 的账号不匹配时，可能会出现账号不匹配的场景（详情请参阅处理商店账号不匹配）。
授权
许可证是确认用户在设备上有权访问内容的数字密钥。在获取许可证之前，用户必须有权使用该产品或插入包含该产品的光盘（游戏和带包的耐用品）。 在处理耐用品（带包或不带包）时，使用授权满足在共享、并发和离线可用性方面的期望（请参阅游戏的产品共享模式）。 许可证受设备限制和并发检查约束，这些约束依赖于游戏使用的许可证模型（请参阅开放式与限制式授权）。即使玩家对该产品有活跃的权益，也可能无法获取用于该设备的有效许可证。许可证共享与离线可用性
在满足以下一项或多项条件时，设备上会发生许可证共享：- 游戏在拥有者的账号登录且建立在线连接时获取了许可证。
- 游戏在拥有者的账号被指定为该设备的离线账号时（在主机上使用 Home XBOX 或在 PC 上使用 Offline permissions）获取了离线许可证。在这种情况下，拥有账号无需登录到设备即可与该设备上的其他账号共享其许可证。
- 玩家插入包含该 DLC（带包的耐用品）的光盘，并且该 DLC 已安装在设备上。
- 拥有该产品的账号将当前设备指定为其“离线”设备（在主机上使用 Home XBOX 或在 PC 上使用 Offline permissions）。启用离线指定后，游戏必须在联机时获取该耐用品产品的许可证。下次启动游戏时，它会获取具备离线能力的许可证。
- 玩家插入包含该 DLC（带包的耐用品）的光盘，并且该 DLC 已安装在设备上。
游戏客户端的许可证用法
可以使用以下流程为耐用品（带包或不带包）授权：- XStoreCanAcquireLicenseForStoreIdAsync / Result 在不触发并发检查的情况下预览许可证。如果 XStoreCanLicenseStatus 为
Licensable，则游戏可以尝试获取耐用品许可证。此预览检查需要在线连接。 - XStoreAcquireLicenseForDurablesAsync / Result 在设备上没有许可证或当前许可证已过期时调用授权服务以获取许可证。当设备上已有该产品的活跃许可证或在离线时调用此 API 时，会返回缓存的许可证。如果返回的是缓存的许可证，它可能对当前玩家无效。
- 在游戏中解锁内容之前，始终调用 XStoreIsLicenseValid 检查许可证是否有效。
- 如果获取了有效许可证，请使用 XStoreRegisterPackageLicenseLost 监听许可证丢失事件。如果许可证丢失，请尝试重新获取许可证。如果无法重新获取许可证，请决定何时（或是否）阻止玩家对内容的访问（取决于游戏设计）。
- 在处理许可证丢失事件后，调用 XStoreUnregisterPackageLicenseLost 并通过调用 XStoreCloseLicenseHandle 释放旧的许可证句柄。
游戏服务的许可证用法
许可证与设备绑定，无法从游戏服务查询。不过，客户端可以调用 XStoreQueryLicenseTokenAsync / Result 通过游戏服务提供额外验证。有关更多信息，请参阅使用许可证令牌。授权注意事项
- 购买完成到可获取新许可证之间可能存在延迟。请检查用户权益的变化，并在为耐用品产品添加新权益后获取许可证。
- 部署侧载包时，会自动为带包的耐用品授予测试许可证。若要测试带包耐用品的授权场景，请改用许可证覆盖或从商店安装的包。有关更多信息，请参阅启用授权测试。
- 当游戏获取耐用品许可证时，该许可证会缓存在设备上。许可证会从缓存中拉取，直到系统触发许可证刷新（没有可强制刷新的 API）。对 XStoreAcquireLicense* 的重复调用会检查设备缓存，而不是服务。
- 许可证丢失回调可以帮助检测系统是否错误地向当前玩家返回了属于另一个账号的缓存许可证。在这种情况下，许可证丢失事件会立即触发；如果再次调用 XStoreAcquireLicense*，会提供全新的许可证。
- 许可证共享和缓存可能会让测试机器处于不干净的状态。有关更多信息，请参阅排查 XStore 开发问题。
示例资源
有关演示如何查询玩家权益和获取耐用品许可证的示例代码，请参阅以下资源：- InGameStore 示例 (GitHub)：演示 XStore 功能的 C++ 示例，包括产品检索、购买、权益和耐用品授权。
- DownloadableContent 示例 (GitHub)：演示 XStore 和 XPackage 功能的 C++ 示例，包括枚举和授权已打包的耐用品。
- UnityInGameStore 示例 (GitHub)：使用 Unity 游戏引擎和 “Microsoft GDK API package” 演示 XStore 功能的 C# 示例。
参考 API 文档
- XStore（API 内容）
- 函数
- XStoreQueryAssociatedProductsAsync
- Result
- XStoreQueryProductsAsync
- Result
- XStoreQueryEntitledProductsAsync
- Result
- XStoreCanAcquireLicenseForStoreIdAsync
- Result
- XStoreAcquireLicenseForDurablesAsync
- Result
- XStoreIsLicenseValid
- XStoreRegisterPackageLicenseLost
- XStoreUnregisterPackageLicenseLost
- XStoreCloseLicenseHandle
- XStoreCanAcquireLicenseForPackageAsync
- Result
- XStoreAcquireLicenseForPackageAsync
- Result
- XStoreQueryLicenseTokenAsync
- Result
- 结构体
- 函数
- XPackage（API 内容）
另请参阅
商务概述XStore API 参考