Obtenir toutes les extensionsGet all add-ons

Utilisez cette méthode dans l’API de soumission de Microsoft Store pour récupérer des données pour tous les modules complémentaires pour toutes les applications qui sont inscrits dans votre compte espace partenaires.Use this method in the Microsoft Store submission API to retrieve data for all add-ons for all the apps that are registered to your Partner Center account.

PrérequisPrerequisites

Pour utiliser cette méthode, vous devez d’abord effectuer les opérations suivantes :To use this method, you need to first do the following:

  • Si ce n’est pas déjà le cas, remplissez toutes les conditions préalables relatives à l’API de soumission au Microsoft Store.If you have not done so already, complete all the prerequisites for the Microsoft Store submission API.
  • Obtenez un jeton d’accès Azure AD à utiliser dans l’en-tête de requête de cette méthode.Obtain an Azure AD access token to use in the request header for this method. Après avoir obtenu un jeton d’accès, vous avez 60 minutes pour l’utiliser avant expiration.After you obtain an access token, you have 60 minutes to use it before it expires. Une fois le jeton arrivé à expiration, vous pouvez en obtenir un nouveau.After the token expires, you can obtain a new one.

DemandeRequest

Cette méthode présente la syntaxe suivante.This method has the following syntax. Consultez les sections suivantes pour obtenir des exemples d’utilisation et une description de l’en-tête et du corps de la requête.See the following sections for usage examples and descriptions of the header and request body.

MéthodeMethod URI de requêteRequest URI
GETGET https://manage.devcenter.microsoft.com/v1.0/my/inappproducts

En-tête de requêteRequest header

HeaderHeader TypeType DescriptionDescription
AuthorizationAuthorization chaînestring Obligatoire.Required. Le jeton d’accès Azure AD sous la forme PORTEUR < jeton>.The Azure AD access token in the form Bearer <token>.

Paramètres de la requêteRequest parameters

Tous les paramètres de la requête sont facultatifs pour cette méthode.All request parameters are optional for this method. Si vous appelez cette méthode sans paramètre, la réponse contient les données de toutes les extensions pour toutes les applications inscrites dans votre compte.If you call this method without parameters, the response contains data for all add-ons for all apps that are registered to your account.

ParamètreParameter TypeType DescriptionDescription ObligatoireRequired
toptop entierint Nombre d’éléments à retourner dans la requête (autrement dit, nombre d’extensions à retourner).The number of items to return in the request (that is, the number of add-ons to return). Si votre compte comporte plus d’extensions que la valeur que vous spécifiez dans la requête, le corps de la réponse comprend un chemin d’URI relatif que vous pouvez ajouter à l’URI de la méthode pour solliciter la page suivante de données.If your account has more add-ons than the value you specify in the query, the response body includes a relative URI path that you can append to the method URI to request the next page of data. NonNo
skipskip entierint Nombre d’éléments à ignorer dans la requête avant de retourner les éléments restants.The number of items to bypass in the query before returning the remaining items. Utilisez ce paramètre pour parcourir des ensembles de données.Use this parameter to page through data sets. Par exemple, top=10 et skip=0 permettent de récupérer les éléments 1 à 10, top=10 et skip=10 permettent de récupérer les éléments 11 à 20, et ainsi de suite.For example, top=10 and skip=0 retrieves items 1 through 10, top=10 and skip=10 retrieves items 11 through 20, and so on. NonNo

Corps de la requêteRequest body

Ne fournissez pas de corps de requête pour cette méthode.Do not provide a request body for this method.

Exemples de demandeRequest examples

L’exemple suivant montre comment récupérer toutes les données d’extension de toutes les applications inscrites dans votre compte.The following example demonstrates how to retrieve all add-on data for all the apps that are registered to your account.

GET https://manage.devcenter.microsoft.com/v1.0/my/inappproducts HTTP/1.1
Authorization: Bearer <your access token>

L’exemple suivant montre comment récupérer les 10 premières extensions uniquement.The following example demonstrates how to retrieve the first 10 add-ons only.

GET https://manage.devcenter.microsoft.com/v1.0/my/inappproducts?top=10 HTTP/1.1
Authorization: Bearer <your access token>

RéponseResponse

L’exemple suivant montre le corps de réponse JSON renvoyé par une requête réussie sur les 5 premières extensions inscrites dans un compte de développeur qui en possède 1072 au total.The following example demonstrates the JSON response body returned by a successful request for the first 5 add-ons that are registered to a developer account with 1072 total add-ons. Pour des raisons de concision, cet exemple affiche uniquement les données des deux premières extensions retournées par la requête.For brevity, this example only shows the data for the first two add-ons returned by the request. Pour plus d’informations sur les valeurs figurant dans le corps de réponse, voir la section suivante.For more details about the values in the response body, see the following section.

{
  "@nextLink": "inappproducts/?skip=5&top=5",
  "value": [
    {
      "applications": {
        "value": [
          {
            "id": "9NBLGGH4R315",
            "resourceLocation": "applications/9NBLGGH4R315"
          }
        ],
        "totalCount": 1
      },
      "id": "9NBLGGH4TNMP",
      "productId": "a8b8310b-fa8d-4da0-aca0-577ef6dce4dd",
      "productType": "Consumable",
      "pendingInAppProductSubmission": {
        "id": "1152921504621243619",
        "resourceLocation": "inappproducts/9NBLGGH4TNMP/submissions/1152921504621243619"
      },
      "lastPublishedInAppProductSubmission": {
        "id": "1152921504621243705",
        "resourceLocation": "inappproducts/9NBLGGH4TNMP/submissions/1152921504621243705"
      }
    },
    {
      "applications": {
        "value": [
          {
            "id": "9NBLGGH4R315",
            "resourceLocation": "applications/9NBLGGH4R315"
          }
        ],
        "totalCount": 1
      },
      "id": "9NBLGGH4TNMN",
      "productId": "6a3c9788-a350-448a-bd32-16160a13018a",
      "productType": "Consumable",
      "pendingInAppProductSubmission": {
        "id": "1152921504621243538",
        "resourceLocation": "inappproducts/9NBLGGH4TNMN/submissions/1152921504621243538"
      },
      "lastPublishedInAppProductSubmission": {
        "id": "1152921504621243106",
        "resourceLocation": "inappproducts/9NBLGGH4TNMN/submissions/1152921504621243106"
      }
    },

  // Other add-ons omitted for brevity...
  ],
  "totalCount": 1072
}

Corps de la réponseResponse body

ValueValue TypeType DescriptionDescription
@nextLink chaînestring S’il existe des pages supplémentaires de données, cette chaîne contient un chemin relatif que vous pouvez ajouter à l’URI de requête https://manage.devcenter.microsoft.com/v1.0/my/ de base pour solliciter la page suivante de données.If there are additional pages of data, this string contains a relative path that you can append to the base https://manage.devcenter.microsoft.com/v1.0/my/ request URI to request the next page of data. Par exemple, si le paramètre top du corps de requête initial a la valeur 10, mais qu’il existe 100 extensions inscrites dans votre compte, le corps de réponse comprendra une valeur @nextLink de inappproducts?skip=10&top=10, ce qui indique que vous pouvez appeler https://manage.devcenter.microsoft.com/v1.0/my/inappproducts?skip=10&top=10 pour solliciter les 10 extensions suivantes.For example, if the top parameter of the initial request body is set to 10 but there are 100 add-ons registered to your account, the response body will include a @nextLink value of inappproducts?skip=10&top=10, which indicates that you can call https://manage.devcenter.microsoft.com/v1.0/my/inappproducts?skip=10&top=10 to request the next 10 add-ons.
valeurvalue tableauarray Tableau contenant des objets qui fournissent des informations sur chaque extension.An array that contains objects that provide information about each add-on. Pour plus d’informations, voir ressource d’extension.For more information, see add-on resource.
totalCounttotalCount entierint Nombre d’objets d’application dans le tableau value du corps de réponse.The number of app objects in the value array of the response body.

Codes d’erreurError codes

Si la requête ne peut pas aboutir, la réponse contient l’un des codes d’erreur HTTP suivants.If the request cannot be successfully completed, the response will contain one of the following HTTP error codes.

Error codeError code DescriptionDescription
404404 Aucune extension n’a été trouvée.No add-ons were found.
409409 Les applications ou les modules complémentaires utilisent les fonctionnalités de partenaires qui sont actuellement ne pas pris en charge par l’API de soumission de Microsoft Store.The apps or add-ons use Partner Center features that are currently not supported by the Microsoft Store submission API.