Add-Ons für eine App abrufen

  • Artikel

Verwenden Sie diese Methode in der Microsoft Store-Übermittlungs-API, um die Add-Ons für eine App aufzulisten, die bei Ihrem Partner Center-Konto registriert ist.

Voraussetzungen

Zur Verwendung dieser Methode sind folgende Schritte erforderlich:

  • Wenn Sie dies noch nicht getan haben, erfüllen Sie alle Voraussetzungen für die Microsoft Store-Übermittlungs-API.
  • 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. Wenn das Token abgelaufen ist, können Sie ein neues abrufen.

Anforderung

Diese Methode hat die folgende Syntax. In den folgenden Abschnitten finden Sie Verwendungsbeispiele und Beschreibungen des Header und Anforderungstexts.

Methode Anforderungs-URI
GET https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/listinappproducts

Anforderungsheader

Header type BESCHREIBUNG
Authorization Zeichenfolge Erforderlich. Das Azure AD-Zugriffstoken im Format Bearertoken<>.

Anforderungsparameter

Name Typ BESCHREIBUNG Erforderlich
applicationId Zeichenfolge Die Store-ID der App, für die Sie Add-Ons abrufen möchten. Weitere Informationen zur Store-ID finden Sie unter Anzeigen von Details zur App-Identität. Ja
top INT Die Anzahl von Elementen, die in der Anforderung zurückgegeben werden sollen (d. h. die Anzahl der zurückzugebenden-Add-Ons). Wenn die App mehr Add-Ons als der Wert verfügt, den Sie in der Abfrage festlegen, enthält der Antworttext einen relativen URI-Pfad, den Sie an den URI der Methode anfügen können, um die nächste Seite mit Daten anzufordern. Nein
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 große Datensätze durchzublättern. Zum Beispiel werden bei top=10 und skip=0 die Elemente 1 bis 10 abgerufen, bei top=10 und skip=10 die Elemente 11 bis 20 und so weiter. Nein

Anforderungstext

Stellen Sie keinen Anforderungstext für diese Methode bereit.

Anforderungsbeispiele

Im folgenden Beispiel wird veranschaulicht, wie alle Add-Ons für eine App aufgelistet werden können.

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 aufgelistet werden können.

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 sind in diesem Beispiel nur die Daten für die ersten drei Add-Ons dargestellt, 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 Zeichenfolge Wenn weitere Datenseiten vorhanden sind, enthält diese Zeichenfolge einen relativen Pfad, den Sie an den Basisanforderungs-URI https://manage.devcenter.microsoft.com/v1.0/my/ zum Anfordern der nächsten Datenseite anfügen können. 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 den @nextLink Wert von applications/{applicationid}/listinappproducts/?skip=10&top=10, der 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 für jedes Add-On für die angegebene App auflisten. Weitere Informationen zu den Daten in den einzelnen Objekten finden Sie unter -Add-On-Ressource.
totalCount INT Die Gesamtzahl der Zeilen im Datenergebnis für die Abfrage (d. h. 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 nicht von der Microsoft Store-Übermittlungs-API unterstützt werden.