Partager via


Gérer les soumissions d’applications

L’API de soumission du Microsoft Store fournit des méthodes que vous pouvez utiliser pour gérer les soumissions pour vos applications, y compris les déploiements progressifs de packages. Pour une présentation de l’API de soumission du Microsoft Store, y compris les conditions préalables à l’utilisation de l’API, consultez Créer et gérer des soumissions à l’aide des services microsoft Store.

Importante

Si vous utilisez l’API de soumission du Microsoft Store pour créer une soumission pour une application, veillez à apporter d’autres modifications à la soumission uniquement à l’aide de l’API, plutôt que de l’Espace partenaires. Si vous utilisez l’Espace partenaires pour modifier une soumission que vous avez créée à l’origine à l’aide de l’API, vous ne pourrez plus modifier ou valider cette soumission à l’aide de l’API. Dans certains cas, la soumission peut être laissée dans un état d’erreur où elle ne peut pas continuer dans le processus de soumission. Si cela se produit, vous devez supprimer la soumission et créer une nouvelle soumission.

Importante

Vous ne pouvez pas utiliser cette API pour publier des soumissions pour les achats en volume via le Microsoft Store pour les entreprises et le Microsoft Store pour l'éducation ou pour publier des soumissions pour les applications LOB directement aux entreprises. Pour ces deux scénarios, vous devez utiliser l’Espace partenaires pour publier la soumission.

Méthodes de gestion des soumissions d’applications

Utilisez les méthodes suivantes pour obtenir, créer, mettre à jour, valider ou supprimer une soumission d’application. Avant de pouvoir utiliser ces méthodes, l’application doit déjà exister dans votre compte Espace partenaires et vous devez d’abord créer une soumission pour l’application dans l’Espace partenaires. Pour plus d’informations, consultez les prérequis .

Méthode URI Descriptif
OBTENIR https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId} Obtenir une soumission d’application existante
OBTENIR https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/status Obtenir l’état d’une soumission d’application existante
PUBLIER https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions Créer une nouvelle soumission d’application
METTRE https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId} Mettre à jour une soumission d’application existante
PUBLIER https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/commit Valider une soumission d’application nouvelle ou mise à jour
Suppression https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId} Supprimer une soumission d’application

Créer une soumission d’application

Pour créer une soumission pour une application, suivez ce processus.

  1. Si vous ne l’avez pas déjà fait, remplissez toutes les conditions préalables pour l’API de soumission du Microsoft Store.

    Remarque

    Assurez-vous que l'application dispose déjà d'au moins une soumission terminée dont les informations sur les évaluations d'âge et sont complètes.

  2. Obtenir un jeton d’accès Azure AD. Vous devez transmettre ce jeton d’accès aux méthodes de l’API de soumission au Microsoft Store. Après avoir obtenu un jeton d’accès, vous avez 60 minutes pour l’utiliser avant son expiration. Une fois le jeton expiré, vous pouvez en obtenir un nouveau.

  3. Créer une soumission d’application en exécutant la méthode suivante dans l’API de soumission du Microsoft Store. Cette méthode crée une soumission en cours, qui est une copie de votre dernière soumission publiée.

    POST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions
    

    Le corps de la réponse contient une ressource de soumission d’application qui inclut l’ID de la nouvelle soumission, l’URI de signature d’accès partagé (SAP) pour téléverser tous les fichiers associés à la soumission sur le Stockage Blob Azure (par exemple, les packages d’applications, les images de liste et les fichiers de bandes-annonces), ainsi que toutes les données de la nouvelle soumission (telles que les listes et les informations de tarification).

    Remarque

    Un URI SAP fournit l’accès à une ressource sécurisée dans le stockage Azure sans nécessiter de clés de compte. Pour plus d’informations sur les URI SAP et leur utilisation avec stockage Blob Azure, consultez signatures d’accès partagé, partie 1 : Présentation du modèle SAP et signatures d’accès partagé, partie 2 : Créer et utiliser une SAP avec stockage Blob.

  4. Si vous ajoutez de nouveaux packages, des listes d’images ou des fichiers de bandes-annonces pour la soumission, préparez les packages d’application et préparez les captures d’écran, les images et les bandes-annonces d’application. Ajoutez tous ces fichiers à une archive ZIP.

  5. Modifiez les données de soumission d'application avec les modifications requises pour la nouvelle soumission, puis exécutez la méthode suivante pour mettre à jour la soumission d'application.

    PUT https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}
    

    Remarque

    Si vous ajoutez de nouveaux fichiers pour la soumission, veillez à mettre à jour les données de soumission pour faire référence au nom et au chemin relatif de ces fichiers dans l’archive ZIP.

  6. Si vous ajoutez de nouveaux packages, des listes d’images ou des fichiers de bandes-annonces pour la soumission, téléchargez l’archive ZIP vers le Stockage Blob Azure à l’aide de l’URI SAS fourni dans le corps de la réponse de la méthode POST que vous avez appelée précédemment. Il existe différentes bibliothèques Azure que vous pouvez utiliser pour ce faire sur diverses plateformes, notamment :

    L’exemple de code C# suivant montre comment charger une archive ZIP dans Stockage Blob Azure à l’aide de la classe CloudBlockBlob dans la bibliothèque cliente stockage Azure pour .NET. Cet exemple suppose que l’archive ZIP a déjà été écrite dans un objet de flux.

    string sasUrl = "https://productingestionbin1.blob.core.windows.net/ingestion/26920f66-b592-4439-9a9d-fb0f014902ec?sv=2014-02-14&sr=b&sig=usAN0kNFNnYE2tGQBI%2BARQWejX1Guiz7hdFtRhyK%2Bog%3D&se=2016-06-17T20:45:51Z&sp=rwl";
    Microsoft.WindowsAzure.Storage.Blob.CloudBlockBlob blockBob =
        new Microsoft.WindowsAzure.Storage.Blob.CloudBlockBlob(new System.Uri(sasUrl));
    await blockBob.UploadFromStreamAsync(stream);
    
  7. Valider la soumission d’application en exécutant la méthode suivante. Cela alerte l’Espace partenaires que vous avez terminé avec votre soumission et que vos mises à jour doivent maintenant être appliquées à votre compte.

    POST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/commit
    
  8. Vérifiez l’état de validation en exécutant la méthode suivante pour obtenir l’état de la soumission de l’application.

    GET https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/status
    

    Pour confirmer l’état de la soumission, vérifiez la valeur d’état dans le corps de la réponse. Cette valeur doit passer de CommitStarted à PreProcessing si la requête réussit ou à CommitFailed en cas d’erreurs dans la requête. En cas d’erreur, le champ statusDetails contient des détails supplémentaires sur l’erreur.

  9. Une fois la validation terminée, l’envoi est envoyé au Windows Store pour ingestion. Vous pouvez continuer à surveiller la progression de la soumission à l’aide de la méthode précédente ou en visitant l’Espace partenaires.

Méthodes de gestion d’un déploiement de package progressif

Vous pouvez déployer progressivement les packages mis à jour dans une soumission d’application à un pourcentage des clients de votre application sur Windows 10 et Windows 11. Cela vous permet de surveiller les commentaires et les données analytiques des packages spécifiques pour vous assurer que vous êtes sûr de la mise à jour avant de la déployer plus largement. Vous pouvez modifier le pourcentage de déploiement (ou arrêter la mise à jour) d’une soumission publiée sans avoir à créer une nouvelle soumission. Pour plus d’informations, notamment des instructions sur l’activation et la gestion d’un déploiement progressif de packages dans l’Espace partenaires, consultez cet article.

Pour activer par programme un déploiement progressif de package pour une soumission d’application, suivez ce processus à l’aide de méthodes dans l’API de soumission du Microsoft Store :

  1. Créer une soumission d’application ou obtenir une soumission d’application existante.
  2. Dans les données de réponse, recherchez la ressource packageRollout, définissez le champ isPackageRollout sur true, puis définissez le champ packageRolloutPercentage sur le pourcentage des clients de votre application qui doivent obtenir les paquets mis à jour.
  3. Transmettez les données mises à jour de soumission de l’application à la méthode de mise à jour d’une soumission de l’application.

Une fois le déploiement progressif d’un package activé pour une soumission d’application, vous pouvez utiliser les méthodes suivantes pour obtenir, mettre à jour, arrêter ou finaliser le déploiement progressif par programmation.

Méthode URI Descriptif
OBTENIR https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/packagerollout Obtenir les informations de déploiement progressif pour une soumission d’application
PUBLIER https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/updatepackagerolloutpercentage Mettre à jour le pourcentage de déploiement progressif pour une soumission d’application
PUBLIER https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/haltpackagerollout arrêter le déploiement progressif d’une soumission d’application
PUBLIER https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/finalizepackagerollout finaliser le déploiement progressif d’une soumission d’application

Exemples de code pour la gestion des soumissions d’applications

Les articles suivants fournissent des exemples de code détaillés qui montrent comment créer une soumission d’application dans plusieurs langages de programmation différents :

Module PowerShell StoreBroker

En guise d’alternative à l’appel direct de l’API de soumission du Microsoft Store, nous fournissons également un module PowerShell open source qui implémente une interface de ligne de commande au-dessus de l’API. Ce module est appelé StoreBroker. Vous pouvez utiliser ce module pour gérer vos soumissions d'application, de vol d’essai et de module complémentaire à partir de la ligne de commande plutôt que d'appeler directement l’API de soumission du Microsoft Store, ou vous pouvez simplement parcourir la source pour voir d’autres exemples pour savoir comment appeler cette API. Le module StoreBroker est utilisé activement au sein de Microsoft comme principale façon dont de nombreuses applications internes sont soumises au Windows Store.

Pour plus d’informations, consultez notre page StoreBroker sur GitHub.

Ressources de données

Les méthodes d’API de soumission du Microsoft Store pour la gestion des soumissions d’applications utilisent les ressources de données JSON suivantes.

Ressource de soumission d’application

Cette ressource décrit une soumission d’application.

{
  "id": "1152921504621243540",
  "applicationCategory": "BooksAndReference_EReader",
  "pricing": {
    "trialPeriod": "FifteenDays",
    "marketSpecificPricings": {},
    "sales": [],
    "priceId": "Tier2",
    "isAdvancedPricingModel": true
  },
  "visibility": "Public",
  "targetPublishMode": "Manual",
  "targetPublishDate": "1601-01-01T00:00:00Z",
  "listings": {
    "en-us": {
      "baseListing": {
        "copyrightAndTrademarkInfo": "",
        "keywords": [
          "epub"
        ],
        "licenseTerms": "",
        "privacyPolicy": "",
        "supportContact": "",
        "websiteUrl": "",
        "description": "Description",
        "features": [
          "Free ebook reader"
        ],
        "releaseNotes": "",
        "images": [
          {
            "fileName": "contoso.png",
            "fileStatus": "Uploaded",
            "id": "1152921504672272757",
            "description": "Main page",
            "imageType": "Screenshot"
          }
        ],
        "recommendedHardware": [],
        "title": "Contoso ebook reader"
      },
      "platformOverrides": {
        "Windows81": {
          "description": "Ebook reader for Windows 8.1"
        }
      }
    }
  },
  "hardwarePreferences": [
    "Touch"
  ],
  "automaticBackupEnabled": false,
  "canInstallOnRemovableMedia": true,
  "isGameDvrEnabled": false,
  "gamingOptions": [],
  "hasExternalInAppProducts": false,
  "meetAccessibilityGuidelines": true,
  "notesForCertification": "",
  "status": "PendingCommit",
  "statusDetails": {
    "errors": [],
    "warnings": [],
    "certificationReports": []
  },
  "fileUploadUrl": "https://productingestionbin1.blob.core.windows.net/ingestion/387a9ea8-a412-43a9-8fb3-a38d03eb483d?sv=2014-02-14&sr=b&sig=sdd12JmoaT6BhvC%2BZUrwRweA%2Fkvj%2BEBCY09C2SZZowg%3D&se=2016-06-17T18:32:26Z&sp=rwl",
  "applicationPackages": [
    {
      "fileName": "contoso_app.appx",
      "fileStatus": "Uploaded",
      "id": "1152921504620138797",
      "version": "1.0.0.0",
      "architecture": "ARM",
      "languages": [
        "en-US"
      ],
      "capabilities": [
        "ID_RESOLUTION_HD720P",
        "ID_RESOLUTION_WVGA",
        "ID_RESOLUTION_WXGA"
      ],
      "minimumDirectXVersion": "None",
      "minimumSystemRam": "None",
      "targetDeviceFamilies": [
        "Windows.Mobile min version 10.0.10240.0"
      ]
    }
  ],
  "packageDeliveryOptions": {
    "packageRollout": {
        "isPackageRollout": false,
        "packageRolloutPercentage": 0.0,
        "packageRolloutStatus": "PackageRolloutNotStarted",
        "fallbackSubmissionId": "0"
    },
    "isMandatoryUpdate": false,
    "mandatoryUpdateEffectiveDate": "1601-01-01T00:00:00.0000000Z"
  },
  "enterpriseLicensing": "Online",
  "allowMicrosoftDecideAppAvailabilityToFutureDeviceFamilies": true,
  "allowTargetFutureDeviceFamilies": {
    "Desktop": false,
    "Mobile": true,
    "Holographic": true,
    "Xbox": false,
    "Team": true
  },
  "friendlyName": "Submission 2",
  "trailers": []
}

Cette ressource a les valeurs suivantes.

Valeur Catégorie Descriptif
pièce d'identité chaîne L’ID de la soumission. Cet ID est disponible dans les données de réponse pour les demandes de créer une soumission d’application, obtenir toutes les applicationset obtenir une application. Pour une soumission créée dans l’Espace partenaires, cet ID est également disponible dans l’URL de la page de soumission dans l’Espace partenaires.
catégorie d'application chaîne Chaîne qui spécifie la catégorie et/ou la sous-catégorie pour votre application. Les catégories et les sous-catégories sont combinées en une seule chaîne avec le caractère de soulignement '_', tel que BooksAndReference_EReader.
Prix objet Ressource de tarification qui contient des informations de tarification pour l’application.
visibilité chaîne Visibilité de l’application. Il peut s’agir de l’une des valeurs suivantes :
  • Masqué(e)
  • Publique
  • Privé
  • Non défini
mode de publication cible chaîne Mode de publication de la soumission. Il peut s’agir de l’une des valeurs suivantes :
  • Immédiat
  • Manuel
  • Date spécifique
date de publication cible chaîne Date de publication de la soumission au format ISO 8601, si le targetPublishMode est défini sur SpecificDate.
listes objet Un dictionnaire de paires de clé-valeur, où chaque clé est un code de pays et chaque valeur est une ressource de référencement qui contient des informations de liste pour l’application.
préférences matérielles tableau Tableau de chaînes qui définissent les préférences matérielles pour votre application. Il peut s’agir de l’une des valeurs suivantes :
  • Entrées tactiles
  • Clavier
  • Souris
  • Caméra
  • NfcHce
  • NFC
  • BluetoothLE
  • Téléphonie
sauvegardeAutomatiqueActivée booléen Indique si Windows peut inclure les données de votre application dans les sauvegardes automatiques sur OneDrive. Pour plus d’informations, consultez Déclarations d’application.
peut être installé sur un support amovible booléen Indique si les clients peuvent installer votre application dans un stockage amovible. Pour plus d’informations, consultez Déclarations d’application.
isGameDvrActivé booléen Indique si DVR de jeu est activé pour l’application.
Options de jeu tableau Tableau qui contient une ressource d’options de jeu qui définit les paramètres liés au jeu pour l’application.
contientDesProduitsExternesDansLApplication booléen Indique si votre application permet aux utilisateurs d’effectuer un achat en dehors du système de commerce du Microsoft Store. Pour plus d’informations, consultez Déclarations d’application.
respecterLesDirectivesD'Accessibilité booléen Indique si votre application a été testée pour répondre aux instructions d’accessibilité. Pour plus d’informations, consultez Déclarations d’application.
notesForCertification chaîne Contient des notes pour la certification de votre application.
statut chaîne État de la soumission. Il peut s’agir de l’une des valeurs suivantes :
  • Aucun
  • Annulé
  • Engagement en attente
  • CommitStarted
  • EngagementÉchoué
  • En attente de publication
  • Édition
  • Publié
  • Publication échouée
  • Prétraitement
  • Échec du prétraitement
  • Certification
  • Échec de la certification
  • Libération
  • Échec de la mise en production
détails du statut objet Ressource de détails sur l’état qui contient des détails supplémentaires sur l’état de la soumission, y compris des informations sur les erreurs éventuelles.
fileUploadUrl chaîne URI de signature d’accès partagé (SAS) pour le téléchargement de packages pour la soumission. Si vous ajoutez de nouveaux packages, des images de liste ou des fichiers de bandes-annonces pour la soumission, chargez l’archive ZIP qui contient les packages et les images dans cet URI. Pour plus d’informations, consultez Créer une soumission d’application.
paquets d'applications tableau Tableau de ressources de paquets d’application qui fournit des détails sur chaque paquet dans la soumission.
options de livraison de colis objet Ressource d’options de livraison de package qui contient des paramètres de déploiement progressif des packages et de mise à jour obligatoire pour la soumission.
licence d'entreprise chaîne L’une des valeurs de licence d’entreprise qui indique le comportement de licence d’entreprise pour l’application.
autoriserMicrosoftÀDéciderDeLaDisponibilitéDesApplicationsPourLesFuturesFamillesD'appareils booléen Indique si Microsoft est autorisé à mettre l'application à disposition des futures familles d’appareils Windows 10 et Windows 11.
allowTargetFutureDeviceFamilies objet Dictionnaire de paires clé et valeur, où chaque clé est une famille d’appareils Windows 10 et Windows 11 et chaque valeur est une valeur booléenne qui indique si votre application est autorisée à cibler la famille d’appareils spécifiée.
nom convivial chaîne Nom convivial de la soumission tel qu’il apparaît dans l’Espace partenaires. Cette valeur est générée pour vous lorsque vous créez la soumission.
Remorques tableau Tableau qui contient jusqu’à 15 ressources de bandes-annonces qui représentent des bandes-annonces vidéo pour la liste des applications.

Ressource de tarification

Cette ressource contient des informations de tarification pour l’application. Cette ressource a les valeurs suivantes.

Valeur Catégorie Descriptif
période d'essai chaîne Chaîne qui spécifie la période d’évaluation de l’application. Il peut s’agir de l’une des valeurs suivantes :
  • Pas d'essai gratuit
  • Un Jour
  • EssaiN'expireJamais
  • SevenDays
  • Quinze Jours
  • Trente Jours
tarifications spécifiques au marché objet Dictionnaire de paires clé et valeur, où chaque clé est un code pays ISO 3166-1 alpha-2 à deux lettres et chaque valeur est un niveau de prix . Ces éléments représentent les prix personnalisés de votre application sur des marchés spécifiques. Tous les éléments de ce dictionnaire remplacent le prix de base spécifié par la valeur priceId pour le marché spécifié.
ventes tableau Obsolète. Tableau de ressources de vente qui contiennent des informations de vente pour l’application.
priceId chaîne Un niveau de prix qui spécifie le prix de base pour l’application.
estModèleDeTarificationAvancée booléen Si vrai, votre compte développeur a accès à l’ensemble étendu de niveaux de prix de .99 USD à 1999,99 USD. Si faux, votre compte développeur a accès à l’ensemble des tranches de prix d’origine de 0,99 USD à 999,99 USD. Pour plus d’informations sur les différents niveaux, consultez niveaux tarifaires.

Remarque Ce champ est en lecture seule.

Ressource de vente

Ces ressources contiennent des informations de vente pour une application.

Importante

La ressource Sale n’est plus prise en charge et vous ne pouvez pas obtenir ou modifier les données de vente d’une soumission d’application à l’aide de l’API de soumission du Microsoft Store. À l’avenir, nous allons mettre à jour l’API de soumission du Microsoft Store pour introduire une nouvelle façon d’accéder par programmation aux informations de vente pour les soumissions d’applications.

Cette ressource a les valeurs suivantes.

Valeur Catégorie Descriptif
nom chaîne Nom de la vente.
basePriceId chaîne Niveau tarifaire à utiliser pour le prix de base de la vente.
date de début chaîne Date de début de la vente au format ISO 8601.
date de fin chaîne Date de fin de la vente au format ISO 8601.
tarifications spécifiques au marché objet Dictionnaire de paires clé et valeur, où chaque clé est un code pays ISO 3166-1 alpha-2 à deux lettres et chaque valeur est un niveau de prix . Ces éléments représentent les prix personnalisés de votre application sur des marchés spécifiques. Tous les éléments de ce dictionnaire remplacent le prix de base spécifié par la valeur basePriceId pour le marché spécifié.

Ressource liste

Cette ressource contient des informations de liste pour une application. Cette ressource a les valeurs suivantes.

Valeur Catégorie Descriptif
baseListing objet Informations de référencement de base pour l’application, qui définissent les informations de référencement par défaut pour toutes les plateformes.
platformOverrides objet Dictionnaire de paires clé et valeur, où chaque clé est une chaîne qui identifie une plateforme pour laquelle remplacer les informations de référencement, et chaque valeur est une ressource de référencement de base (contenant uniquement les valeurs de la description au titre) qui spécifie les informations de référencement à remplacer pour la plateforme spécifiée. Les clés peuvent avoir les valeurs suivantes :
  • Inconnu
  • Windows80
  • Windows81
  • WindowsPhone71
  • WindowsPhone80
  • WindowsPhone81

Ressource de référencement de base

Cette ressource contient des informations de liste de base pour une application. Cette ressource a les valeurs suivantes.

Valeur Catégorie Descriptif
Informations sur les droits d'auteur et les marques déposées chaîne Informations facultatives sur le droit d’auteur et/ou les marques.
Mots-clés tableau Ensemble de mots-clés pour aider votre application à apparaître dans les résultats de recherche.
conditions de licence chaîne Les termes facultatifs du contrat de licence relatifs à votre application.
politique de confidentialité chaîne Cette valeur est obsolète. Pour définir ou modifier l’URL de la stratégie de confidentialité de votre application, vous devez le faire dans la page Propriétés dans l’Espace partenaires. Vous pouvez omettre cette valeur de vos appels à l’API de soumission. Si vous définissez cette valeur, elle sera ignorée.
contact du support chaîne Cette valeur est obsolète. Pour définir ou modifier l’URL ou l’adresse e-mail du contact de support pour votre application, vous devez le faire dans la page Propriétés dans l’Espace partenaires. Vous pouvez omettre cette valeur de vos appels à l’API de soumission. Si vous définissez cette valeur, elle sera ignorée.
URL du site web chaîne Cette valeur est obsolète. Pour définir ou modifier l’URL de la page web de votre application, vous devez le faire sur la page Propriétés dans l’Espace partenaires. Vous pouvez omettre cette valeur de vos appels à l’API de soumission. Si vous définissez cette valeur, elle sera ignorée.
descriptif chaîne Description de la liste des applications.
fonctionnalités tableau Un tableau pouvant contenir jusqu’à 20 chaînes qui répertorient les fonctionnalités de votre app.
releaseNotes chaîne Les notes de publication pour votre application.
Images tableau Un tableau de ressources d’images et d’icônes pour la liste des applications.
matériel recommandé tableau Un tableau pouvant contenir jusqu'à 11 chaînes qui répertorient les configurations matérielles recommandées pour votre application.
configuration matérielle minimale chaîne Un tableau pouvant contenir jusqu’à 11 chaînes qui répertorient les configurations matérielles minimales pour votre application.
titre chaîne Titre de la description de l’application.
brève description chaîne Utilisé uniquement pour les jeux. Cette description s’affiche dans la section Informations du Hub de jeux sur Xbox One et aide les clients à en savoir plus sur votre jeu.
titre court chaîne Une version plus courte du nom de votre produit. S’il est fourni, ce nom plus court peut apparaître à différents endroits sur Xbox One (lors de l’installation, dans Achievements, etc.) à la place du titre complet de votre produit.
sortTitle chaîne Si votre produit peut être alphabétique de différentes façons, vous pouvez entrer une autre version ici. Cela peut aider les clients à trouver le produit plus rapidement lors de la recherche.
titre vocal chaîne Un autre nom pour votre produit qui, s’il est fourni, peut être utilisé dans l’expérience audio sur Xbox One lors de l’utilisation de Kinect ou d’un casque.
devStudio chaîne Spécifiez cette valeur si vous souhaitez inclure un champ Développé par dans l'inscription. (Le champ Publié par listera le nom d’affichage de l’éditeur associé à votre compte, que vous fournissiez ou non une valeur pour devStudio.)

Ressource d’image

Cette ressource contient des données d’image et d’icône pour une liste d’applications. Pour plus d’informations sur les images et les icônes d’une liste d’applications, consultez Captures d’écran et images de l’application. Cette ressource a les valeurs suivantes.

Valeur Catégorie Descriptif
Nom de fichier chaîne Nom du fichier image dans l’archive ZIP que vous avez chargée pour la soumission.
statut du fichier chaîne État du fichier image. Il peut s’agir de l’une des valeurs suivantes :
  • Aucun
  • En attente de téléchargement
  • Téléchargé
  • En attente de suppression
pièce d'identité chaîne ID de l’image. Cette valeur est fournie par l’Espace partenaires.
descriptif chaîne Description de l’image.
type d'image chaîne Indique le type de l’image. Les chaînes suivantes sont actuellement prises en charge.

Capture d’écran des images:

  • Capture d’écran (utilisez cette valeur pour la capture d’écran du bureau)
  • Capture d'écran mobile
  • XboxScreenshot
  • SurfaceHubScreenshot
  • Capture d'écran HoloLens

Logos du Store :

  • StoreLogo9x16
  • StoreLogoSquare
  • Icône (utilisez cette valeur pour le logo 1:1 300 x 300 pixels)

images promotionnelles:

  • PromotionalArt16x9
  • ŒuvrePromotionnelle2400X1200

Images Xbox :

  • XboxBrandedKeyArt
  • XboxTitledHeroArt
  • Art promotionnel en vedette de Xbox

images promotionnelles facultatives:

  • SquareIcon358X358
  • BackgroundImage1000X800
  • ArtPromotionnelle414X180

Ressource sur les options de jeu

Cette ressource contient des paramètres liés au jeu pour l’application. Les valeurs de cette ressource correspondent aux paramètres de jeu pour les soumissions dans l’Espace partenaires.

{
  "gamingOptions": [
    {
      "genres": [
        "Games_ActionAndAdventure",
        "Games_Casino"
      ],
      "isLocalMultiplayer": true,
      "isLocalCooperative": true,
      "isOnlineMultiplayer": false,
      "isOnlineCooperative": false,
      "localMultiplayerMinPlayers": 2,
      "localMultiplayerMaxPlayers": 12,
      "localCooperativeMinPlayers": 2,
      "localCooperativeMaxPlayers": 12,
      "isBroadcastingPrivilegeGranted": true,
      "isCrossPlayEnabled": false,
      "kinectDataForExternal": "Enabled"
    }
  ],
}

Cette ressource a les valeurs suivantes.

Valeur Catégorie Descriptif
genres tableau Tableau contenant une ou plusieurs des chaînes suivantes qui décrivent les genres du jeu :
  • Jeux_ActionEtAventure
  • Jeux_CartesEtPlateau
  • Jeux_Casino
  • Jeux_Éducatifs
  • Jeux_FamilleEtEnfants
  • Jeux_Combat
  • Jeux_Musique
  • Games_Platformer
  • Jeux_EnigmesEtQuestions
  • Games_RacingAndFlying
  • Jeux_de_rôle
  • Games_Shooter
  • Jeux_Simulation
  • Jeux_Sports
  • Jeux_Stratégie
  • Jeux_Mot
isLocalMultiplayer booléen Indique si le jeu prend en charge le mode multijoueur local.
isLocalCooperative booléen Indique si le jeu prend en charge la coopération locale.
isOnlineMultiplayer booléen Indique si le jeu prend en charge le mode multijoueur en ligne.
isOnlineCooperative booléen Indique si le jeu prend en charge la coopération en ligne.
localMultiplayerMinPlayers Int Spécifie le nombre minimal de joueurs pris en charge par le jeu pour le mode multijoueur local.
localMultiplayerMaxPlayers Int Spécifie le nombre maximal de joueurs pris en charge par le jeu pour le mode multijoueur local.
localCooperativeMinPlayers Int Spécifie le nombre minimal de joueurs pris en charge par le jeu pour la coopération locale.
localCooperativeMaxPlayers Int Spécifie le nombre maximum de joueurs pris en charge par le jeu pour la coopération locale.
broadcastingPrivilegeEstAccordé booléen Indique si le jeu prend en charge la diffusion.
Jeu croisé activé booléen Indique si le jeu prend en charge les sessions multijoueurs entre les joueurs sur Les PC Windows 10 et Windows 11 et Xbox.
kinectDataForExternal chaîne Une des valeurs de chaîne suivantes qui indique si le jeu peut collecter des données Kinect et l’envoyer à des services externes :
  • Non défini
  • Inconnu
  • Activé
  • Handicapé

Remarque

La ressource gamingOptions a été ajoutée en mai 2017, après la mise à disposition de l’API de soumission du Microsoft Store aux développeurs. Si vous avez créé une soumission pour une application via l’API de soumission avant l’introduction de cette ressource et que cette soumission est toujours en cours, cette ressource est null pour les soumissions pour l’application jusqu’à ce que vous validiez correctement la soumission ou que vous la supprimez. Si la ressource gamingOptions n’est pas disponible pour les soumissions d’une application, le champ hasAdvancedListingPermission de la ressource Application retourné par la méthode get an app est faux.

Ressource de détails de l’état

Cette ressource contient des détails supplémentaires sur l’état d’une soumission. Cette ressource a les valeurs suivantes.

Valeur Catégorie Descriptif
Erreurs objet Tableau de ressources de détails de l’état qui contient des détails d’erreur pour la soumission.
Avertissements objet Tableau de ressources de détails de l’état qui contient des détails d’avertissement pour la soumission.
rapports de certification objet Tableau de ressources du rapport de certification qui donnent accès aux données du rapport de certification pour la soumission. Vous pouvez examiner ces rapports pour plus d’informations si la certification échoue.

Ressource de détails de l’état

Cette ressource contient des informations supplémentaires sur les erreurs ou avertissements associés pour une soumission. Cette ressource a les valeurs suivantes.

Valeur Catégorie Descriptif
code chaîne Un code d’état de soumission qui décrit le type d’erreur ou d’avertissement.
Détails chaîne Message contenant plus de détails sur le problème.

Ressource de package d’application

Cette ressource contient des détails sur un package d’application pour la soumission.

{
  "applicationPackages": [
    {
      "fileName": "contoso_app.appx",
      "fileStatus": "Uploaded",
      "id": "1152921504620138797",
      "version": "1.0.0.0",
      "architecture": "ARM",
      "languages": [
        "en-US"
      ],
      "capabilities": [
        "ID_RESOLUTION_HD720P",
        "ID_RESOLUTION_WVGA",
        "ID_RESOLUTION_WXGA"
      ],
      "minimumDirectXVersion": "None",
      "minimumSystemRam": "None",
      "targetDeviceFamilies": [
        "Windows.Mobile min version 10.0.10240.0"
      ]
    }
  ],
}

Cette ressource a les valeurs suivantes.

Remarque

Lors de l’appel de la méthode mettre à jour une soumission d’application, seules les valeurs fileName, fileStatus, minimumDirectXVersion et minimumSystemRam de cet objet sont requises dans le corps de la requête. Les autres valeurs sont remplies par l’Espace partenaires.

Valeur Catégorie Descriptif
Nom de fichier chaîne Nom du package.
statut du fichier chaîne État du package. Il peut s’agir de l’une des valeurs suivantes :
  • Aucun
  • En attente de téléchargement
  • Téléchargé
  • En attente de suppression
pièce d'identité chaîne ID qui identifie de façon unique le package. Cette valeur est fournie par l’Espace partenaires.
Version chaîne Version du package d’application. Pour plus d’informations, consultez Numéro de version du package.
architecture chaîne Architecture du package (par exemple, ARM).
langues tableau Tableau de codes de langue pour les langues prises en charge par l’application. Pour plus d’informations, consultez langues prises en charge.
Capacités tableau Tableau de fonctionnalités requises par le package. Pour plus d’informations sur les fonctionnalités, consultez déclarations de fonctionnalités d’application.
minimumDirectXVersion chaîne Version minimale de DirectX prise en charge par le package d’application. Cela ne peut être défini que pour les applications qui ciblent Windows 8.x. Pour les applications qui ciblent d’autres versions du système d’exploitation, cette valeur doit être présente lors de l’appel de la mettre à jour une méthode de soumission d’application, mais la valeur que vous spécifiez est ignorée. Il peut s’agir de l’une des valeurs suivantes :
  • Aucun
  • DirectX93
  • DirectX100
mémoire système minimale chaîne Ram minimale requise par le package d’application. Cela ne peut être défini que pour les applications qui ciblent Windows 8.x. Pour les applications qui ciblent d’autres versions du système d’exploitation, cette valeur doit être présente lors de l’appel de la mettre à jour une méthode de soumission d’application, mais la valeur que vous spécifiez est ignorée. Il peut s’agir de l’une des valeurs suivantes :
  • Aucun
  • Mémoire 2 Go
familles d'appareils cibles tableau Tableau de chaînes qui représentent les familles d’appareils cibles par le package. Cette valeur est utilisée uniquement pour les packages qui ciblent Windows 10 ; pour les packages qui ciblent des versions antérieures, cette valeur a la valeur Aucun. Les chaînes de famille d’appareils suivantes sont actuellement prises en charge pour les packages Windows 10 et Windows 11, où {0} est une chaîne de version Windows 10 ou Windows 11 telle que 10.0.10240.0, 10.0.10586.0 ou 10.0.14393.0 :
  • Version min Windows.Universal {0}
  • Version minimale de Windows.Desktop {0}
  • Version minimale de Windows.Mobile {0}
  • Version minimale de Windows.Xbox {0}
  • Version min. Windows.Holographic {0}

id="certification-report-resource »

Ressource de rapport de certification

Cette ressource fournit l’accès aux données du rapport de certification pour une soumission. Cette ressource a les valeurs suivantes.

Valeur Catégorie Descriptif
date chaîne Date et heure de génération du rapport au format ISO 8601.
URL de rapport chaîne URL à laquelle vous pouvez accéder au rapport.

Ressource pour les options de livraison de colis

Cette ressource contient des paramètres de déploiement progressif de packages et de mises à jour obligatoires pour la soumission.

{
  "packageDeliveryOptions": {
    "packageRollout": {
        "isPackageRollout": false,
        "packageRolloutPercentage": 0,
        "packageRolloutStatus": "PackageRolloutNotStarted",
        "fallbackSubmissionId": "0"
    },
    "isMandatoryUpdate": false,
    "mandatoryUpdateEffectiveDate": "1601-01-01T00:00:00.0000000Z"
  },
}

Cette ressource a les valeurs suivantes.

Valeur Catégorie Descriptif
packageRollout objet Ressource de déploiement de package qui contient des paramètres de déploiement progressif de package pour la soumission.
estMiseÀJourObligatoire booléen Indique si vous souhaitez traiter les packages de cette soumission comme obligatoires pour l’installation automatique des mises à jour d’application. Pour plus d’informations sur les packages obligatoires pour l’installation automatique des mises à jour d’application, consultez Télécharger et installer les mises à jour des packages pour votre application.
date de prise d'effet de la mise à jour obligatoire date Date et heure auxquelles les packages de cette soumission deviennent obligatoires, au format ISO 8601 et au fuseau horaire UTC.

Ressource de déploiement de package

Cette ressource contient des paramètres de déploiement de package progressifs pour la soumission. Cette ressource a les valeurs suivantes.

Valeur Catégorie Descriptif
isPackageRollout booléen Indique si le déploiement progressif du package est activé pour la soumission.
pourcentageDeDéploiementDuPaquet flotter Pourcentage d’utilisateurs qui recevront les packages dans le déploiement progressif.
statutDeDéploiementDuPaquet chaîne L’une des chaînes suivantes indiquant l’état du déploiement progressif du package :
  • DéploiementDuPaquetNonCommencé
  • Déploiement du package en cours
  • Déploiement du paquet terminé
  • Arrêt de Déploiement du Paquet
fallbackSubmissionId chaîne ID de la soumission qui sera reçue par les clients qui n’obtiennent pas les packages de déploiement progressif.

Remarque

Les valeurs packageRolloutStatus et fallbackSubmissionId sont attribuées par l’Espace partenaires et ne doivent pas être définies par le développeur. Si vous incluez ces valeurs dans un corps de requête, ces valeurs sont ignorées.

Ressource de bandes-annonces

Cette ressource représente une bande-annonce vidéo pour la liste des applications. Les valeurs de cette ressource correspondent aux options de bandes-annonces pour les soumissions dans l’Espace partenaires.

Vous pouvez ajouter jusqu’à 15 ressources de bande-annonce au tableau de bandes-annonces dans une ressource de soumission d’application. Pour charger des fichiers vidéo de bande-annonce et des images miniatures pour une soumission, ajoutez ces fichiers au même fichier ZIP qui contient les packages et les images de référencement pour la soumission, puis chargez ce fichier ZIP dans l’URI de signature d’accès partagé (SAP) de la soumission. Pour plus d’informations sur le chargement de l’archive ZIP dans l’URI SAP, consultez Créer une soumission d’application.

{
  "trailers": [
    {
      "id": "1158943556954955699",
      "videoFileName": "Trailers\\ContosoGameTrailer.mp4",
      "videoFileId": "1159761554639123258",
      "trailerAssets": {
        "en-us": {
          "title": "Contoso Game",
          "imageList": [
            {
              "fileName": "Images\\ContosoGame-Thumbnail.png",
              "id": "1155546904097346923",
              "description": "This is a still image from the video."
            }
          ]
        }
      }
    }
  ]
}

Cette ressource a les valeurs suivantes.

Valeur Catégorie Descriptif
pièce d'identité chaîne ID de la bande-annonce. Cette valeur est fournie par l’Espace partenaires.
nomDuFichierVidéo chaîne Nom du fichier vidéo de bande-annonce dans l’archive ZIP qui contient des fichiers pour la soumission.
videoFileId chaîne ID du fichier vidéo de bande-annonce. Cette valeur est fournie par l’Espace partenaires.
Ressources de remorque objet Dictionnaire de paires clé et valeur, où chaque clé est un code de langue et chaque valeur est une ressource de composants de bande-annonce qui contient des ressources spécifiques aux paramètres régionaux supplémentaires pour la bande-annonce. Pour plus d’informations sur les codes de langue pris en charge, consultez langues prises en charge.

Remarque

La ressource des bandes-annonces a été ajoutée en mai 2017, après la mise à disposition pour les développeurs de l’API de soumission du Microsoft Store. Si vous avez créé une soumission pour une application via l’API de soumission avant l’introduction de cette ressource et que cette soumission est toujours en cours, cette ressource est null pour les soumissions pour l’application jusqu’à ce que vous validiez correctement la soumission ou que vous la supprimez. Si la ressource bandes-annonces n’est pas disponible pour les soumissions d’une application, le champ hasAdvancedListingPermission de la ressource Application retourné par la méthode get an app est faux.

Ressource des composants de bandes-annonces

Cette ressource contient des éléments supplémentaires spécifiques aux paramètres régionaux pour une bande-annonce définie dans une ressource de bande-annonce . Cette ressource a les valeurs suivantes.

Valeur Catégorie Descriptif
titre chaîne Titre localisé de la bande-annonce. Le titre s’affiche lorsque l’utilisateur lit la bande-annonce en mode plein écran.
liste d'images tableau Un tableau qui contient une ressource d’image fournissant l’image miniature pour la bande-annonce. Vous pouvez uniquement inclure une ressource d’image dans ce tableau.

Ressource image (pour une bande-annonce)

Cette ressource décrit l’image miniature d’une bande-annonce. Cette ressource a les valeurs suivantes.

Valeur Catégorie Descriptif
Nom de fichier chaîne Nom du fichier image miniature dans l’archive ZIP que vous avez chargée pour la soumission.
pièce d'identité chaîne ID de l’image miniature. Cette valeur est fournie par l’Espace partenaires.
descriptif chaîne Description de l’image miniature. Cette valeur est uniquement des métadonnées et n’est pas affichée aux utilisateurs.

Énumérations

Ces méthodes utilisent les énumérations suivantes.

Niveaux tarifaires

Les valeurs suivantes représentent les niveaux tarifaires disponibles dans la ressource de tarification ressource pour une soumission d’application.

Valeur Descriptif
Base Le niveau tarifaire n’est pas défini ; utilisez le prix de base de l’application.
Indisponible L’application n’est pas disponible dans la région spécifiée.
Libre L’application est gratuite.
Niveauxxxx Chaîne qui spécifie le niveau tarifaire de l’application, au format Niveauxxxx. Actuellement, les plages de prix suivantes sont prises en charge :

  • Si la valeur isAdvancedPricingModel de la ressource tarifaire est true, les valeurs de niveau tarifaire disponibles pour votre compte sont Tier1012 - Tier1424.
  • Si la valeur isAdvancedPricingModel de la ressource tarifaire est false, les valeurs de niveau tarifaire disponibles pour votre compte sont Tier2 - Tier96.
Pour afficher le tableau complet des niveaux de prix disponibles pour votre compte développeur, y compris les prix spécifiques au marché associés à chaque niveau, accédez à la page Tarification et disponibilité pour l’une de vos soumissions d’applications dans l’Espace partenaires, puis cliquez sur le tableau afficher le lien dans la section Marchés et prix personnalisés section (pour certains comptes de développeur, ce lien se trouve dans la section Tarification).

Valeurs de licence d’entreprise

Les valeurs suivantes représentent le comportement de licence de l’organisation pour l’application. Pour plus d’informations sur ces options, consultez options de gestion des licences organisationnelles.

Remarque

Bien que vous puissiez configurer les options de licence organisationnelle pour une soumission d’application via l’API de soumission, vous ne pouvez pas utiliser cette dernière pour publier des soumissions concernant des achats en volume via le Microsoft Store pour Entreprises et le Microsoft Store pour Éducation.. Pour publier des soumissions dans le Microsoft Store pour Entreprises et le Microsoft Store pour l’Éducation, vous devez utiliser l’Espace partenaires.

Valeur Descriptif
Aucun Ne rendez pas votre application disponible pour les entreprises disposant d’une licence en volume gérée par le Windows Store (en ligne).
En ligne Rendez votre application disponible pour les entreprises disposant d’une licence en volume gérée par le Windows Store (en ligne).
En ligne et hors ligne Rendez votre application disponible pour les entreprises disposant d’une licence en volume gérée par le Windows Store (en ligne) et rendez votre application disponible pour les entreprises via des licences déconnectées (hors connexion).

Code d’état de soumission

Les valeurs suivantes représentent le code d’état d’une soumission.

Valeur Descriptif
Aucun Aucun code n’a été spécifié.
InvalidArchive L’archive ZIP contenant le package n’est pas valide ou a un format d’archive non reconnu.
MissingFiles L’archive ZIP n’a pas tous les fichiers répertoriés dans vos données de soumission, ou ils se trouvent à un emplacement incorrect dans l’archive.
Échec de la validation du paquet Un ou plusieurs packages de votre soumission n’ont pas pu être validés.
ValeurDuParamètreInvalide L’un des paramètres du corps de la requête n’est pas valide.
Opération non valide L’opération que vous avez tentée n’est pas valide.
État non valide L’opération que vous avez tentée n’est pas valide pour l’état actuel du vol du package.
Ressource Non Trouvée Impossible de trouver le vol du package spécifié.
Erreur de Service Une erreur de service interne a empêché la requête de réussir. Réessayez la requête.
Avertissement de désinscription de la liste Le développeur a supprimé une liste d’une soumission précédente ou n’a pas inclus les informations de référencement prises en charge par le package.
Avertissement d'adhésion à la liste Le développeur a ajouté une liste.
Avertissement de mise à jour uniquement Le développeur tente d’insérer quelque chose qui n’a que la prise en charge des mises à jour.
Autre La soumission est dans un état non reconnu ou non catégorisé.
Avertissement de Validation du Paquet Le processus de validation du package a entraîné un avertissement.