すべてのアドオンの入手Get all add-ons

Microsoft Store 送信 API でこのメソッドを使用して、データ、パートナー センター アカウントに登録されているすべてのアプリのすべてのアドオンを取得します。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.

前提条件Prerequisites

このメソッドを使うには、最初に次の作業を行う必要があります。To use this method, you need to first do the following:

  • Microsoft Store 申請 API に関するすべての前提条件を満たします (前提条件がまだ満たされていない場合)。If you have not done so already, complete all the prerequisites for the Microsoft Store submission API.
  • このメソッドの要求ヘッダーで使う Azure AD アクセス トークンを取得します。Obtain an Azure AD access token to use in the request header for this method. アクセス トークンを取得した後、アクセス トークンを使用できるのは、その有効期限が切れるまでの 60 分間です。After you obtain an access token, you have 60 minutes to use it before it expires. トークンの有効期限が切れたら新しいトークンを取得できます。After the token expires, you can obtain a new one.

要求Request

このメソッドの構文は次のとおりです。This method has the following syntax. ヘッダーと要求本文の使用例と説明については、次のセクションをご覧ください。See the following sections for usage examples and descriptions of the header and request body.

メソッドMethod 要求 URIRequest URI
GETGET https://manage.devcenter.microsoft.com/v1.0/my/inappproducts

要求ヘッダーRequest header

HeaderHeader 種類Type 説明Description
AuthorizationAuthorization stringstring 必須。Required. Bearer <トークン> という形式の Azure AD アクセス トークン。The Azure AD access token in the form Bearer <token>.

要求パラメーターRequest parameters

このメソッドでは、要求パラメーターはすべてオプションです。All request parameters are optional for this method. パラメーターを指定せずにこのメソッドを呼び出す場合、応答には、アカウントに登録するすべてのアプリのすべてのアドオンのデータが含まれます。If you call this method without parameters, the response contains data for all add-ons for all apps that are registered to your account.

パラメーターParameter 種類Type 説明Description 必須Required
toptop intint 要求で返される項目の数 (つまり、返されるアドオンの数)。The number of items to return in the request (that is, the number of add-ons to return). クエリで指定した値よりアカウントのアドオンの数が多い場合、応答本文には、データの次のページを要求するためにメソッド URI に追加できる相対 URI パスが含まれます。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. XNo
skipskip intint 残りの項目を返す前にクエリでバイパスする項目の数。The number of items to bypass in the query before returning the remaining items. データ セットを操作するには、このパラメーターを使用します。Use this parameter to page through data sets. たとえば、top = 10 と skip = 0 は、1 から 10 の項目を取得し、top=10 と skip=10 は 11 から 20 の項目を取得するという具合です。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. いいえNo

要求本文Request body

このメソッドでは要求本文を指定しないでください。Do not provide a request body for this method.

要求の例Request examples

次の例は、アカウントに登録するすべてのアプリのすべてのアドオン データを取得する方法を示しています。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>

次の例は、最初の 10 個のアドオンのみを取得する方法を示しています。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>

応答Response

次の例は、合計 1072 個のアドオンがある開発者アカウントに登録されている、最初の 5 個のアドオンに対する要求が成功した場合に返される JSON 応答本文を示しています。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. 簡潔にするために、この例では、要求によって返される最初の 2 つのアドオンのデータのみが示されています。For brevity, this example only shows the data for the first two add-ons returned by the request. 応答本文の値について詳しくは、次のセクションをご覧ください。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
}

応答本文Response body

ValueValue 種類Type 説明Description
@nextLink stringstring データの追加ページが存在する場合、この文字列には、データの次のページを要求するために、ベースとなる https://manage.devcenter.microsoft.com/v1.0/my/ 要求 URI に追加できる相対パスが含まれます。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. たとえば、最初の要求本文の top パラメーターが 10 に設定されていて、アカウントには 100 個のアドオンが登録されている場合、応答本文には、inappproducts?skip=10&top=10 という @nextLink 値が含まれます。これは、次の 10 個のアドオンを要求するために、https://manage.devcenter.microsoft.com/v1.0/my/inappproducts?skip=10&top=10 を呼び出すことができることを示しています。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.
valuevalue arrayarray 各アドオンに関する情報を提供するオブジェクトを格納する配列。An array that contains objects that provide information about each add-on. 詳しくは、「アドオン リソース」をご覧ください。For more information, see add-on resource.
totalCounttotalCount intint 応答本文の value 配列のアプリ オブジェクトの数。The number of app objects in the value array of the response body.

エラー コードError codes

要求を正常に完了できない場合、次の HTTP エラー コードのいずれかが応答に含まれます。If the request cannot be successfully completed, the response will contain one of the following HTTP error codes.

エラー コードError code 説明Description
404404 アドオンは見つかりませんでした。No add-ons were found.
409409 アプリまたはアドオンはパートナー センターの機能を使用して、現在サポートされていません、Microsoft Store 送信 APIします。The apps or add-ons use Partner Center features that are currently not supported by the Microsoft Store submission API.