XStore
Documentation de référence pour les API XStore. Fournit à un jeu des fonctionnalités liées au commerce, notamment des détails sur le contenu disponible à l’achat, la gestion des packages de contenu téléchargeable, la gestion des licences et les versions d’évaluation des jeux.Fonctions
| Fonction | Description |
|---|---|
| XStoreAcquireLicenseForDurablesAsync | Acquiert une licence pour le durable spécifié. |
| XStoreAcquireLicenseForDurablesResult | Récupère le résultat d’un appel à XStoreAcquireLicenseForDurablesAsync. |
| XStoreAcquireLicenseForPackageAsync | Acquiert une licence pour un contenu téléchargeable (DLC) d’un jeu que l’utilisateur a le droit d’utiliser. |
| XStoreAcquireLicenseForPackageResult | Récupère les résultats d’un appel à XStoreAcquireLicenseForPackageAsync. |
| XStoreCanAcquireLicenseForPackageAsync | Récupère une licence d’aperçu pour un DLC. |
| XStoreCanAcquireLicenseForPackageResult | Obtient les résultats d’un appel à XStoreCanAcquireLicenseForPackageAsync. |
| XStoreCanAcquireLicenseForStoreIdAsync | Récupère une licence d’aperçu pour du contenu. |
| XStoreCanAcquireLicenseForStoreIdResult | Obtient les résultats d’un appel à XStoreCanAcquireLicenseForStoreIdAsync. |
| XStoreCloseContextHandle | Ferme le handle de contexte du Store spécifié. |
| XStoreCloseLicenseHandle | Ferme le handle de licence du Store spécifié. |
| XStoreCloseProductsQueryHandle | Ferme le handle de requête de produits du Store spécifié. |
| XStoreCreateContext | Crée un contexte du Store pour l’utilisateur spécifié. |
| XStoreDownloadAndInstallPackagesAsync | Télécharge et installe les packages du Store spécifiés. |
| XStoreDownloadAndInstallPackagesResult | Obtient les résultats d’un appel à XStoreDownloadAndInstallPackagesAsync. |
| XStoreDownloadAndInstallPackagesResultCount | Obtient le nombre d’éléments du résultat qui sera retourné par XStoreDownloadAndInstallPackagesResult. |
| XStoreDownloadAndInstallPackageUpdatesAsync | Télécharge et installe les mises à jour des packages du Store spécifiés. |
| XStoreDownloadAndInstallPackageUpdatesResult | Obtient les résultats d’un appel à XStoreDownloadAndInstallPackageUpdatesAsync. |
| XStoreDownloadPackageUpdatesAsync | Télécharge les mises à jour des packages spécifiés. |
| XStoreDownloadPackageUpdatesResult | Obtient les résultats d’un appel à XStoreDownloadPackageUpdatesAsync. |
| XStoreEnumerateProductsQuery | Énumère les résultats d’une requête de produits. |
| XStoreGameLicenseChangedCallback | Rappel défini par le jeu pour l’événement de modification de la licence du jeu. |
| XStoreGetUserCollectionsIdAsync | Obtient un ID de collections de client. |
| XStoreGetUserCollectionsIdResult | Obtient les résultats d’un appel à XStoreGetUserCollectionsIdAsync. |
| XStoreGetUserCollectionsIdResultSize | Obtient la taille de l’ID retourné par XStoreGetUserCollectionsIdResult. |
| XStoreGetUserPurchaseIdAsync | Récupère un ID d’achat de client. |
| XStoreGetUserPurchaseIdResult | Obtient le résultat d’un appel à XStoreGetUserPurchaseIdAsync. |
| XStoreGetUserPurchaseIdResultSize | Obtient la taille du résultat retourné par XStoreGetUserPurchaseIdResult. |
| XStoreIsLicenseValid | Vérifie si la licence spécifiée est valide. |
| XStorePackageLicenseLostCallback | Rappel défini par le jeu pour l’événement de perte de licence. |
| XStoreProductQueryCallback | Rappel défini par le jeu pour une requête de produit. |
| XStoreProductsQueryHasMorePages | Vérifie s’il existe d’autres pages de résultats pour la requête spécifiée. |
| XStoreProductsQueryNextPageAsync | Obtient la page suivante des résultats de la requête. |
| XStoreProductsQueryNextPageResult | Obtient la page suivante des résultats d’une requête de produits. |
| XStoreQueryAddOnLicensesAsync | Énumère les licences accordées à l’utilisateur pour les durables sans bits du jeu en cours d’exécution. |
| XStoreQueryAddOnLicensesResult | Récupère le résultat d’un appel à XStoreQueryAddOnLicensesAsync. |
| XStoreQueryAddOnLicensesResultCount | Obtient le nombre de licences récupérées par XStoreQueryAddonLicensesAsync. |
| XStoreQueryAssociatedProductsAsync | Obtient les informations de fiche du Store pour les produits pouvant être achetés à partir du jeu en cours. |
| XStoreQueryAssociatedProductsForStoreIdAsync | Obtient les informations de fiche du Store pour les produits pouvant être achetés à partir du produit spécifié par l’ID du Store. |
| XStoreQueryAssociatedProductsForStoreIdResult | Obtient les résultats d’un appel à XStoreQueryAssociatedProductsForStoreIdAsync. |
| XStoreQueryAssociatedProductsResult | Obtient les résultats d’un appel à XStoreQueryAssociatedProductsAsync. |
| XStoreQueryConsumableBalanceRemainingAsync | Obtient le solde restant du consommable pour l’ID de produit spécifié. |
| XStoreQueryConsumableBalanceRemainingResult | Récupère les résultats d’un appel à XStoreQueryConsumableBalanceRemainingAsync. |
| XStoreQueryEntitledProductsAsync | Fournit les informations de produit du Store pour tous les modules complémentaires du jeu en cours que l’utilisateur a achetés. |
| XStoreQueryEntitledProductsResult | Obtient les résultats d’un appel à XStoreQueryEntitledProductsAsync. |
| XStoreQueryGameAndDlcPackageUpdatesAsync | Obtient les mises à jour du jeu et les mises à jour facultatives pour le package actuel. |
| XStoreQueryGameAndDlcPackageUpdatesResult | Obtient le résultat d’un appel à XStoreQueryGameAndDlcPackageUpdatesAsync. |
| XStoreQueryGameAndDlcPackageUpdatesResultCount | Obtient le nombre de mises à jour récupérées par XStoreQueryGameAndDlcPackageUpdatesAsync. |
| XStoreQueryGameLicenseAsync | Récupère des informations sur la licence acquise pour permettre le lancement du jeu. |
| XStoreQueryGameLicenseResult | Obtient les résultats d’un appel à XStoreQueryGameLicenseAsync. |
| XStoreQueryLicenseTokenAsync | Fournit au jeu appelant un jeton opaque qui peut être transmis au service du jeu pour effectuer des appels B2B. |
| XStoreQueryLicenseTokenResult | Récupère les résultats d’un appel à XStoreQueryLicenseTokenAsync. |
| XStoreQueryLicenseTokenResultSize | Obtient la taille du résultat qui sera retourné par XstoreQueryLicenseTokenResult. |
| XStoreQueryPackageIdentifier | Récupère l’identificateur de package pour l’ID du Store spécifié. |
| XStoreQueryPackageUpdatesAsync | Récupère les mises à jour disponibles pour les packages spécifiés. |
| XStoreQueryPackageUpdatesResult | Obtient le résultat d’un appel à XStoreQueryPackageUpdatesAsync. |
| XStoreQueryPackageUpdatesResultCount | Obtient le nombre de mises à jour récupérées par XStoreQueryPackageUpdatesAsync. |
| XStoreQueryProductForCurrentGameAsync | Fournit les informations de produit du Store pour le jeu en cours d’exécution, ses références (SKU) et disponibilités, ainsi que d’autres métadonnées. |
| XStoreQueryProductForCurrentGameResult | Obtient les résultats d’un appel à XStoreQueryProductForCurrentGameAsync. |
| XStoreQueryProductForPackageAsync | Récupère les informations de produit du Store pour le package spécifié. |
| XStoreQueryProductForPackageResult | Obtient les résultats d’un appel à XStoreQueryProductForPackageAsync. |
| XStoreQueryProductsAsync | Retourne les informations de fiche des produits spécifiés qui sont associés au jeu en cours, que ces produits soient actuellement disponibles à l’achat dans le jeu en cours ou non. |
| XStoreQueryProductsResult | Obtient les résultats d’un appel à XStoreQueryProductsAsync. |
| XStoreRegisterGameLicenseChanged | Inscrit un rappel pour l’événement de modification de la licence du jeu. |
| XStoreRegisterPackageLicenseLost | Inscrit un rappel pour l’événement de perte de licence. |
| XStoreReportConsumableFulfillmentAsync | Consomme la quantité spécifiée d’un consommable. |
| XStoreReportConsumableFulfillmentResult | Obtient les résultats d’un appel à XStoreReportConsumableFulfillmentAsync. |
| XStoreShowAssociatedProductsUIAsync | Ouvre l’application Microsoft Store et affiche l’ensemble des modules complémentaires disponibles associés au jeu. Ces éléments peuvent être filtrés davantage par type de produit. |
| XStoreShowAssociatedProductsUIResult | Obtient le résultat d’un appel à XStoreShowAssociatedProductsUIAsync. |
| XStoreShowGiftingUIAsync | Permet au jeu de demander l’achat d’un produit du Store particulier en tant que cadeau pour un autre utilisateur. |
| XStoreShowGiftingUIResult | Obtient les résultats d’un appel à XStoreShowGiftingUIAsync. |
| XStoreShowProductPageUIAsync | Ouvre l’application Store directement sur la page de détails du ProductId spécifié. |
| XStoreShowProductPageUIResult | Obtient le résultat d’un appel à XStoreShowProductPageUIAsync. |
| XStoreShowPurchaseUIAsync | Permet au jeu de demander l’achat d’un produit du Store particulier. |
| XStoreShowPurchaseUIResult | Obtient les résultats d’un appel à XStoreShowPurchaseUIAsync. |
| XStoreShowRateAndReviewUIAsync | Affiche une boîte de dialogue système permettant à l’utilisateur de rédiger une critique ou de refuser de le faire. |
| XStoreShowRateAndReviewUIResult | Obtient le résultat d’un appel à XStoreShowRateAndReviewUIAsync. |
| XStoreShowRedeemTokenUIAsync | Déclenche l’échange d’un jeton spécifié pour l’utilisateur actuel. |
| XStoreShowRedeemTokenUIResult | Obtient les résultats d’un appel à XStoreShowRedeemTokenUIAsync. |
| XStoreUnregisterGameLicenseChanged | Désinscrit le rappel de modification de la licence du jeu spécifié. |
| XStoreUnregisterPackageLicenseLost | Désinscrit le rappel de perte de licence du Store spécifié. |
Structures
| Structure | Description |
|---|---|
| XStoreAddonLicense | Décrit une licence de module complémentaire. |
| XStoreAvailability | Décrit la disponibilité d’un produit. |
| XStoreCanAcquireLicenseResult | Obtient le résultat d’un appel à XStoreCanAcquireLicenseForPackageAsync ou à XStoreCanAcquireLicenseForStoreIdAsync. |
| XStoreCollectionData | Décrit une collection du Store. |
| XStoreConsumableResult | Représente la quantité du consommable. |
| XStoreGameLicense | Décrit une licence de jeu. |
| XStoreImage | Décrit une image. |
| XStorePackageUpdate | Décrit une mise à jour de package. |
| XStorePrice | Informations sur le prix dans le Store. |
| XStoreProduct | Décrit un produit du Store. |
| XStoreRateAndReviewResult | Résultats d’un appel à XStoreShowRateAndReviewUIAsync. |
| XStoreSku | Décrit une référence (SKU) du Store. |
| XStoreSubscriptionInfo | Contient des informations sur un abonnement. |
| XStoreVideo | Décrit une vidéo du Store. |
Énumérations
| Énumération | Description |
|---|---|
| XStoreCanLicenseStatus | Indique si un utilisateur pourrait obtenir une licence pour un package. |
| XStoreDurationUnit | Unités d’une valeur de durée. |
| XStoreProductKind | Indique le type de produit. |
Codes d’erreur
Les codes d’erreur suivants peuvent être retournés par les API XStore. Pour obtenir la liste complète, consultez Codes d’erreur.| Code | Valeur | Description |
|---|---|---|
| E_GAMESTORE_LICENSE_ACTION_NOT_APPLICABLE_TO_PRODUCT | 0x89245300 | Le jeu a demandé une licence pour un produit qui ne peut pas faire l’objet d’une licence. |
| E_GAMESTORE_NETWORK_ERROR | 0x89245301 | Le jeu n’a pas réussi à communiquer avec le réseau du Store. |
| E_GAMESTORE_SERVER_ERROR | 0x89245302 | Le jeu a reçu une réponse incorrecte du serveur du Store. |
| E_GAMESTORE_INSUFFICIENT_QUANTITY | 0x89245303 | L’utilisateur ne possède pas assez de ce consommable pour utiliser la quantité demandée. |
| E_GAMESTORE_ALREADY_PURCHASED | 0x89245304 | L’utilisateur possède déjà ce produit. |
| E_GAMESTORE_LICENSE_ACTION_THROTTLED | 0x89245305 | Le jeu a interrogé la licence du produit de façon excessive et est maintenant limité. La limite est de 30 tentatives d’obtention de licence en 10 minutes pour le même produit. |
Documentation conceptuelle
Voir aussi
Référence des API systèmeRéférence des API XPackage
Vue d’ensemble du commerce