Add-Ons für eine App abrufen
Verwenden Sie diese Methode in der Microsoft Store-Übermittlungs-API, um die Add-Ons für eine App auflisten, die für Ihr Partner Center-Konto registriert ist.
Voraussetzungen
Um diese Methode zu verwenden, müssen Sie zuerst Folgendes tun:
- Falls noch nicht geschehen, füllen Sie alle Voraussetzungen für die Microsoft Store-Übermittlungs-API aus.
- Rufen Sie ein Azure AD-Zugriffstoken ab, das im Anforderungsheader für diese Methode verwendet wird. Nachdem Sie ein Zugriffstoken erhalten haben, haben Sie 60 Minuten Zeit, es zu verwenden, bevor es abläuft. Nachdem das Token abgelaufen ist, können Sie eine neue abrufen.
Anfordern
Diese Methode weist die folgende Syntax auf. In den folgenden Abschnitten finden Sie Verwendungsbeispiele und Beschreibungen des Headers und des Anforderungstexts.
Methode | Anforderungs-URI |
---|---|
GET | https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/listinappproducts |
Anforderungsheader
Header | Typ | Beschreibung |
---|---|---|
Autorisierung | Zeichenfolge | Erforderlich. Das Azure AD-Zugriffstoken im Formular Bearer<-Token>. |
Anforderungsparameter
Name | Typ | Beschreibung | Erforderlich |
---|---|---|---|
applicationId | Zeichenfolge | Die Store-ID der App, für die Sie die Add-Ons abrufen möchten. Weitere Informationen zur Store-ID finden Sie unter Anzeigen von App-Identitätsdetails. | Ja |
Oben | int | Die Anzahl der Elemente, die in der Anforderung zurückgegeben werden sollen (d. r. die Anzahl der zurückzugebenden Add-Ons). Wenn die App über mehr Add-Ons als den Wert verfügt, den Sie in der Abfrage angeben, enthält der Antworttext einen relativen URI-Pfad, den Sie an den Methoden-URI anfügen können, um die nächste Seite mit Daten anzufordern. | No |
skip | int | Die Anzahl der Elemente, die in der Abfrage umgangen werden sollen, bevor die verbleibenden Elemente zurückgegeben werden. Verwenden Sie diesen Parameter, um Datensätze zu durchlaufen. Beispielsweise ruft top=10 und skip=0 Elemente 1 bis 10 ab, top=10 und skip=10 ruft Elemente 11 bis 20 ab usw. | No |
Anforderungstext
Geben Sie keinen Anforderungstext für diese Methode an.
Beispiele für Anforderungen
Im folgenden Beispiel wird veranschaulicht, wie alle Add-Ons für eine App aufgeführt werden.
GET https://manage.devcenter.microsoft.com/v1.0/my/applications/9NBLGGH4R315/listinappproducts HTTP/1.1
Authorization: Bearer <your access token>
Im folgenden Beispiel wird veranschaulicht, wie die ersten 10 Add-Ons für eine App aufgeführt werden.
GET https://manage.devcenter.microsoft.com/v1.0/my/applications/9NBLGGH4R315/listinappproducts?top=10 HTTP/1.1
Authorization: Bearer <your access token>
Antwort
Das folgende Beispiel veranschaulicht den JSON-Antworttext, der von einer erfolgreichen Anforderung für die ersten 10 Add-Ons für eine App mit insgesamt 53 Add-Ons zurückgegeben wird. Aus Platzgründen zeigt dieses Beispiel nur die Daten für die ersten drei Add-Ons, die von der Anforderung zurückgegeben werden. Weitere Informationen zu den Werten im Antworttext finden Sie im folgenden Abschnitt.
{
"@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
}
Antworttext
Wert | Typ | Beschreibung |
---|---|---|
@nextLink | string | Wenn zusätzliche Datenseiten vorhanden sind, enthält diese Zeichenfolge einen relativen Pfad, den Sie an den Basisanforderungs-URI https://manage.devcenter.microsoft.com/v1.0/my/ anfügen können, um die nächste Datenseite anzufordern. Wenn beispielsweise der oberste Parameter des anfänglichen Anforderungstexts auf 10 festgelegt ist, aber 50 Add-Ons für die App vorhanden sind, enthält der Antworttext einen @nextLink Wert von , der applications/{applicationid}/listinappproducts/?skip=10&top=10 angibt, dass Sie aufrufen https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationid}/listinappproducts/?skip=10&top=10 können, um die nächsten 10 Add-Ons anzufordern. |
value | array | Ein Array von Objekten, die die Store-ID jedes Add-Ons für die angegebene App auflisten. Weitere Informationen zu den Daten in den einzelnen Objekten finden Sie in der Add-On-Ressource. |
totalCount | int | Die Gesamtanzahl der Zeilen im Datenergebnis für die Abfrage (d. r. die Gesamtanzahl der Add-Ons für die angegebene App). |
Fehlercodes
Wenn die Anforderung nicht erfolgreich abgeschlossen werden kann, enthält die Antwort einen der folgenden HTTP-Fehlercodes.
Fehlercode | BESCHREIBUNG |
---|---|
404 | Es wurden keine Add-Ons gefunden. |
409 | Die Add-Ons verwenden Partner Center-Features, die derzeit von der Microsoft Store-Übermittlungs-API nicht unterstützt werden. |