Abrufen aller Add-Ons
Verwenden Sie diese Methode in der Microsoft Store-Übermittlungs-API, um Daten für alle Add-Ons für alle Apps abzurufen, die für Ihr Partner Center-Konto registriert sind.
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/inappproducts |
Anforderungsheader
Header | Typ | Beschreibung |
---|---|---|
Autorisierung | Zeichenfolge | Erforderlich. Das Azure AD-Zugriffstoken im Formular Bearer<-Token>. |
Anforderungsparameter
Alle Anforderungsparameter sind für diese Methode optional. Wenn Sie diese Methode ohne Parameter aufrufen, enthält die Antwort Daten für alle Add-Ons für alle Apps, die für Ihr Konto registriert sind.
Parameter | Typ | Beschreibung | Erforderlich |
---|---|---|---|
Oben | int | Die Anzahl der Elemente, die in der Anforderung zurückgegeben werden sollen (d. r. die Anzahl der zurückzugebenden Add-Ons). Wenn Ihr Konto ü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
Das folgende Beispiel veranschaulicht, wie alle Add-On-Daten für alle Apps abgerufen werden, die für Ihr Konto registriert sind.
GET https://manage.devcenter.microsoft.com/v1.0/my/inappproducts HTTP/1.1
Authorization: Bearer <your access token>
Im folgenden Beispiel wird veranschaulicht, wie nur die ersten 10 Add-Ons abgerufen werden.
GET https://manage.devcenter.microsoft.com/v1.0/my/inappproducts?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 5 Add-Ons zurückgegeben wird, die für ein Entwicklerkonto mit insgesamt 1072 Add-Ons registriert sind. Aus Platzgründen zeigt dieses Beispiel nur die Daten für die ersten beiden Add-Ons an, die von der Anforderung zurückgegeben werden. Weitere Informationen zu den Werten im Antworttext finden Sie im folgenden Abschnitt.
{
"@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
}
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 100 Add-Ons für Ihr Konto registriert sind, enthält der Antworttext den @nextLink Wert , der inappproducts?skip=10&top=10 angibt, dass Sie aufrufen https://manage.devcenter.microsoft.com/v1.0/my/inappproducts?skip=10&top=10 können, um die nächsten 10 Add-Ons anzufordern. |
value | array | Ein Array, das Objekte enthält, die Informationen zu jedem Add-On bereitstellen. Weitere Informationen finden Sie in der Add-On-Ressource. |
totalCount | int | Die Anzahl der App-Objekte im Wertarray des Antworttexts. |
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 Apps oder Add-Ons verwenden Partner Center-Features, die derzeit von der Microsoft Store-Übermittlungs-API nicht unterstützt werden. |