アドオンの入手Get an add-on

Microsoft Store 送信 API でこのメソッドを使用して、パートナー センター アカウントに登録されているアプリ用のアドオン (とも呼ばれるアプリ内製品または IAP) に関する情報を取得します。Use this method in the Microsoft Store submission API to retrieve information about an add-on (also known as in-app product or IAP) for an app that is 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/{inAppProductId}

要求ヘッダーRequest header

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

要求パラメーターRequest parameters

名前Name 種類Type 説明Description
idid stringstring 必須。Required. 取得するアドオンのストア ID。The Store ID of the add-on to retrieve. Store ID は、パートナー センターで使用できます。The Store ID is available in Partner Center.

要求本文Request body

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

要求の例Request example

次の例は、アドオンの情報を取得する方法を示しています。The following example demonstrates how to retrieve information about an add-on.

GET https://manage.devcenter.microsoft.com/v1.0/my/inappproducts/9NBLGGH4TNMP HTTP/1.1
Authorization: Bearer <your access token>

応答Response

次の例は、このメソッドが正常に呼び出された場合の JSON 応答本文を示しています。The following example demonstrates the JSON response body for a successful call to this method. 応答の本文内の値について詳しくは、アドオンのリソースをご覧ください。For more details about the values in the response body, see add-on resource.

{
  "applications": {
    "value": [
      {
        "id": "9NBLGGH4R315",
        "resourceLocation": "applications/9NBLGGH4R315"
      }
    ],
    "totalCount": 1
  },
  "id": "9NBLGGH4TNMP",
  "productId": "Test-add-on",
  "productType": "Durable",
  "pendingInAppProductSubmission": {
    "id": "1152921504621243619",
    "resourceLocation": "inappproducts/9NBLGGH4TNMP/submissions/1152921504621243619"
  },
  "lastPublishedInAppProductSubmission": {
    "id": "1152921504621243705",
    "resourceLocation": "inappproducts/9NBLGGH4TNMP/submissions/1152921504621243705"
  }
}

エラー コード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 指定したアドオンは見つかりませんでした。The specified add-on could not be found.
409409 アドオンは、パートナー センター機能を使用する現在サポートされていません、Microsoft Store 送信 APIします。The add-on uses a Partner Center feature that is currently not supported by the Microsoft Store submission API.