アドオンの作成Create an add-on

Microsoft Store 送信 API でこのメソッドを使用すると、パートナー センター アカウントに登録されているアプリ用のアドオン (とも呼ばれるアプリ内製品または IAP) を作成できます。Use this method in the Microsoft Store submission API to create an add-on (also known as in-app product or IAP) for an app that is registered to your Partner Center account.

注意

このメソッドは、申請なしでアドオンを作成します。This method creates an add-on without any submissions. アドオンの申請を作成する方法については、「アドオンの申請の管理」のメソッドをご覧ください。To create a submission for an add-on, see the methods in Manage add-on submissions.

前提条件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
POSTPOST 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 body

要求本文には次のパラメーターがあります。The request body has the following parameters.

パラメーターParameter 種類Type 説明Description 必須Required
applicationIdsapplicationIds arrayarray このアドオンが関連付けられるアプリのストア ID を含む配列です。An array that contains the Store ID of the app that this add-on is associated with. この配列でサポートされる項目は 1 つのみです。Only one item is supported in this array. Yes
productIdproductId stringstring アドオンの製品 ID です。The product ID of the add-on. これは、アドオンを参照する、コード内で使用できる識別子です。This is an identifier that can use in code to refer to the add-on. 詳しくは、「IAP の製品の種類と製品 ID を設定する」をご覧ください。For more information, see Set your product type and product ID. Yes
productTypeproductType stringstring アドオンの製品の種類です。The product type of the add-on. 次の値がサポートされています。持続性のある消耗します。The following values are supported: Durable and Consumable. Yes

要求の例Request example

次の例は、アプリの新しいコンシューマブルなアドオンを作成する方法を示しています。The following example demonstrates how to create a new consumable add-on for an app.

POST https://manage.devcenter.microsoft.com/v1.0/my/inappproducts HTTP/1.1
Authorization: Bearer eyJ0eXAiOiJKV1Q...
Content-Type: application/json
{
    "applicationIds": [  "9NBLGGH4R315"  ],
    "productId": "my-new-add-on",
    "productType": "Consumable",
}

応答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": "my-new-add-on",
  "productType": "Consumable",
}

エラー コードError codes

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

エラー コードError code 説明Description
400400 要求が無効です。The request is invalid.
409409 現在の状態のため、アドオンを作成できませんでしたまたはアドオンであるパートナー センター機能を使用するいない現在 Microsoft Store 送信 API ではサポートされてします。The add-on could not be created because of its current state, or the add-on uses a Partner Center feature that is currently not supported by the Microsoft Store submission API.