Partager via

Obtenir des extensions pour une application

  • Article

Utilisez cette méthode dans l’API de soumission du Microsoft Store pour répertorier les modules complémentaires d’une application inscrite dans votre compte Espace partenaires.

Prérequis

Pour utiliser cette méthode, vous devez d’abord effectuer les opérations suivantes :

  • Si vous ne l’avez pas déjà fait, remplissez toutes les conditions préalables pour l’API de soumission au Microsoft Store.
  • Obtenir un jeton d’accès Azure AD à utiliser dans l’en-tête de requête pour cette méthode. Une fois que vous avez récupéré le jeton d’accès, vous avez 60 minutes pour l’utiliser avant qu’il n’expire. Une fois le jeton expiré, vous pouvez en obtenir un nouveau.

Requête

Cette méthode a la syntaxe suivante. Consultez les sections suivantes pour obtenir des exemples d’utilisation et des descriptions du corps de l’en-tête et de la demande.

Méthode URI de demande
GET https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/listinappproducts

En-tête de requête

En-tête Type Description
Autorisation string Obligatoire. Jeton d’accès Azure AD au format porteur<jeton>.

Paramètres de la demande

Nom Type Description Obligatoire
applicationId string ID Store de l’application pour laquelle vous souhaitez récupérer les modules complémentaires. Pour plus d’informations sur l’ID store, consultez Afficher les détails de l’identité de l’application. Oui
haut int Nombre d’éléments à retourner dans la demande (autrement dit, le nombre de modules complémentaires à renvoyer). Si l’application a plus de modules complémentaires que la valeur que vous spécifiez dans la requête, le corps de la réponse inclut un chemin d’URI relatif que vous pouvez ajouter à l’URI de méthode pour demander la page suivante des données. Non
skip int Nombre d’éléments à contourner dans la requête avant de renvoyer les éléments restants. Utilisez ce paramètre pour parcourir des jeux de données. Par exemple, top=10 et skip=0 récupère les éléments 1 à 10, top=10 et skip=10 récupère les éléments 11 à 20, et ainsi de suite. Non

Corps de la demande

Ne fournissez pas de corps de requête pour cette méthode.

Exemples de requête

L’exemple suivant montre comment répertorier tous les modules complémentaires pour une application.

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

L’exemple suivant montre comment répertorier les 10 premiers modules complémentaires pour une application.

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

Response

L’exemple suivant illustre le corps de la réponse JSON retourné par une requête réussie pour les 10 premiers modules complémentaires pour une application avec 53 modules complémentaires totaux. Par souci de concision, cet exemple affiche uniquement les données des trois premiers modules complémentaires retournés par la requête. Pour plus d’informations sur les valeurs dans le corps de la réponse, consultez la section suivante.

{
  "@nextLink": "applications/9NBLGGH4R315/listinappproducts/?skip=10&top=10",
  "value": [
    {
      "inAppProductId": "9NBLGGH4TNMP"
    },
    {
      "inAppProductId": "9NBLGGH4TNMN"
    },
    {
      "inAppProductId": "9NBLGGH4TNNR"
    },
    // Next 7 add-ons  are omitted for brevity ...
  ],
  "totalCount": 53
}

Response body

Valeur Type Description
@nextLink string S’il existe des pages de données supplémentaires, cette chaîne contient un chemin d’accès relatif que vous pouvez ajouter à l’URI de demande de base https://manage.devcenter.microsoft.com/v1.0/my/ pour demander la page suivante des données. Par exemple, si le paramètre supérieur du corps de la demande initiale est défini sur 10, mais qu’il existe 50 modules complémentaires pour l’application, le corps de la réponse inclut une @nextLink valeur de applications/{applicationid}/listinappproducts/?skip=10&top=10, ce qui indique que vous pouvez appeler https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationid}/listinappproducts/?skip=10&top=10 pour demander les 10 modules complémentaires suivants.
value tableau Tableau d’objets qui répertorient l’ID Store de chaque module complémentaire pour l’application spécifiée. Pour plus d’informations sur les données de chaque objet, consultez la ressource de module complémentaire.
totalCount int Nombre total de lignes dans le résultat des données de la requête (autrement dit, nombre total de modules complémentaires pour l’application spécifiée).

Codes d’erreur

Si la requête ne peut pas être terminée, la réponse contient l’un des codes d’erreur HTTP suivants.

Code d'erreur Description
404 Aucun module complémentaire n’a été trouvé.
409 Les modules complémentaires utilisent les fonctionnalités de l’Espace partenaires qui ne sont actuellement pas prises en charge par l’API de soumission au Microsoft Store.