Abrufen aller Add-OnsGet all add-ons

Verwenden Sie diese Methode in der Microsoft Store-Übermittlung API zum Abrufen von Daten für alle Add-ons für alle apps, die mit Ihrem Partner Center-Konto registriert sind.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.

VorraussetzungenPrerequisites

Zur Verwendung dieser Methode sind folgende Schritte erforderlich:To use this method, you need to first do the following:

  • Falls noch nicht geschehen, erfüllen Sie alle Voraussetzungen für die Microsoft Store-Übermittlungs-API.If you have not done so already, complete all the prerequisites for the Microsoft Store submission API.
  • Rufen Sie ein Azure AD-Zugriffstoken ab, das im Anforderungsheader für diese Methode verwendet wird.Obtain an Azure AD access token to use in the request header for this method. Nach Erhalt eines Zugriffstokens können Sie es 60 Minuten lang verwenden, bevor es abläuft.After you obtain an access token, you have 60 minutes to use it before it expires. Wenn das Token abgelaufen ist, können Sie ein neues abrufen.After the token expires, you can obtain a new one.

AnforderungRequest

Diese Methode hat die folgende Syntax.This method has the following syntax. In den folgenden Abschnitten finden Sie Verwendungsbeispiele und Beschreibungen des Header und Anforderungstexts.See the following sections for usage examples and descriptions of the header and request body.

MethodeMethod Anforderungs-URIRequest URI
GETGET https://manage.devcenter.microsoft.com/v1.0/my/inappproducts

AnforderungsheaderRequest header

HeaderHeader TypType BeschreibungDescription
AutorisierungAuthorization Stringstring Erforderlich.Required. Die Azure AD-Zugriffstoken in der Form Bearer < token>.The Azure AD access token in the form Bearer <token>.

AnforderungsparameterRequest parameters

Alle Anforderungsparameter sind optional für diese Methode.All request parameters are optional for this method. 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.If you call this method without parameters, the response contains data for all add-ons for all apps that are registered to your account.

ParameterParameter TypType BeschreibungDescription ErforderlichRequired
toptop intint Die Anzahl von Elementen, die in der Anforderung zurückgegeben werden sollen (d. h. die Anzahl der zurückzugebenden-Add-Ons).The number of items to return in the request (that is, the number of add-ons to return). Wenn Ihr Konto über 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.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. NeinNo
skipskip intint Die Anzahl der Elemente, die in der Abfrage umgangen werden sollen, bevor die verbleibenden Elemente zurückgegeben werden.The number of items to bypass in the query before returning the remaining items. Verwenden Sie diesen Parameter, um große Datensätze durchzublättern.Use this parameter to page through data sets. 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.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. NeinNo

AnforderungstextRequest body

Stellen Sie keinen Anforderungstext für diese Methode bereit.Do not provide a request body for this method.

AnforderungsbeispieleRequest examples

Im folgenden Beispiel wird veranschaulicht, wie alle Add-On-Daten für alle Apps abgerufen werden können, die für Ihr Konto registriert sind.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>

Im folgenden Beispiel wird veranschaulicht, wie nur die ersten 10 Add-Ons abgerufen werden.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>

AntwortResponse

Im folgenden Beispiel wird der JSON-Antworttext veranschaulicht, 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 wurden.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. Aus Platzgründen sind in diesem Beispiel nur die Daten für die ersten beiden Add-Ons dargestellt, die von der Anforderung zurückgegeben werden.For brevity, this example only shows the data for the first two add-ons returned by the request. Weitere Informationen zu den Werten im Antworttext finden Sie im folgenden Abschnitt.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
}

AntworttextResponse body

WertValue TypType BeschreibungDescription
@nextLink Stringstring 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.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. Wenn beispielsweise der Parameter top des anfänglichen Anforderungstexts auf 10 festgelegt ist, für Ihr Konto jedoch 100 Add-Ons registriert wurden, enthält der Antworttext den @nextLink-Wert inappproducts?skip=10&top=10, der angibt, dass Sie https://manage.devcenter.microsoft.com/v1.0/my/inappproducts?skip=10&top=10 aufrufen können, um die nächsten 10 Add-Ons anzufordern.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.
Wertvalue arrayarray Ein Array, das die Objekte enthält, die Informationen über jedes Add-On bereitstellen.An array that contains objects that provide information about each add-on. Weitere Informationen finden Sie unter Add-On-Ressource.For more information, see add-on resource.
totalCounttotalCount intint Die Anzahl der App-Objekte im value-Array des Antworttexts.The number of app objects in the value array of the response body.

FehlercodesError codes

Wenn die Anforderung nicht erfolgreich abgeschlossen werden kann, enthält die Antwort einen der folgenden HTTP-Fehlercodes.If the request cannot be successfully completed, the response will contain one of the following HTTP error codes.

FehlercodeError code BeschreibungDescription
404404 Es wurden keine Add-Ons gefunden.No add-ons were found.
409409 Verwenden Sie die apps oder -Add-Ons Partner Center-Features, die derzeit nicht durch die Übermittlung zum Microsoft Store-API unterstützt.The apps or add-ons use Partner Center features that are currently not supported by the Microsoft Store submission API.