アドオンの管理Manage add-ons

アプリのアドオンを管理するには、Microsoft Store 申請 API の以下のメソッドを使います。Use the following methods in the Microsoft Store submission API to manage add-ons for your apps. Microsoft Store 申請 API の概要については、「Microsoft Store サービスを使用した申請の作成と管理」をご覧ください。この API を使用するための前提条件などの情報があります。For an introduction to the Microsoft Store submission API, including prerequisites for using the API, see Create and manage submissions using Microsoft Store services.

以下のメソッドは、アドオンの取得、作成、または削除にしか使用できません。These methods can only be used to get, create, or delete add-ons. アドオンの申請を作成する方法については、「アドオンの申請の管理」のメソッドをご覧ください。To create submissions for add-ons, see the methods in Manage add-on submissions.

メソッドMethod URIURI 説明Description
GETGET https://manage.devcenter.microsoft.com/v1.0/my/inappproducts アプリのすべてのアドオンを入手します。Get all add-ons for your apps
GETGET https://manage.devcenter.microsoft.com/v1.0/my/inappproducts/{inAppProductId} 特定のアドオンを取得します。Get a specific add-on
POSTPOST https://manage.devcenter.microsoft.com/v1.0/my/inappproducts アドオンを作成します。Create an add-on
DelDELETE https://manage.devcenter.microsoft.com/v1.0/my/inappproducts/{inAppProductId} アドオンを削除します。Delete an add-on

前提条件Prerequisites

Microsoft Store 申請 API に関するすべての前提条件がまだ満たされていない場合は、ここに記載されているメソッドを使用する前に前提条件を整えてください。If you have not done so already, complete all the prerequisites for the Microsoft Store submission API before trying to use any of these methods.

データ リソースData resources

アドオンを管理するための Microsoft Store 申請 API のメソッドでは、次の JSON データ リソースが使われます。The Microsoft Store submission API methods for managing add-ons use the following JSON data resources.

アドオン リソースAdd-on resource

このリソースは、アドオンを記述しています。This resource describes an add-on.

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

このリソースには、次の値があります。This resource has the following values.

ValueValue 種類Type 説明Description
applicationsapplications arrayarray このアドオンが関連付けられるアプリを表す 1 つのアプリケーション リソースを格納する配列です。An array that contains one application resource that represents the app that this add-on is associated with. この配列でサポートされる項目は 1 つのみです。Only one item is supported in this array.
idid stringstring アドオンのストア ID です。The Store ID of the add-on. この値は、ストアによって提供されます。This value is supplied by the Store. ストア ID の例は 9NBLGGH4TNMP です。An example Store ID is 9NBLGGH4TNMP.
productIdproductId stringstring アドオンの製品 ID です。The product ID of the add-on. これは、アドオンの作成時に開発者が指定した ID です。This is the ID that was provided by the developer when the add-on was created. 詳しくは、「IAP の製品の種類と製品 ID を設定する」をご覧ください。For more information, see Set your product type and product ID.
productTypeproductType stringstring アドオンの製品の種類です。The product type of the add-on. 次の値がサポートされています。持続性のある消耗します。The following values are supported: Durable and Consumable.
lastPublishedInAppProductSubmissionlastPublishedInAppProductSubmission オブジェクトobject アドオンの最後に公開された申請に関する情報を提供する申請のリソースA submission resource that provides information about the last published submission for the add-on.
pendingInAppProductSubmissionpendingInAppProductSubmission オブジェクトobject アドオンの現在保留中の申請に関する情報を提供する申請のリソースA submission resource that provides information about the current pending submission for the add-on.

アプリケーション リソースApplication resource

このリソースは、アドオンが関連付けられているアプリを説明します。This resource descries the app that an add-on is associated with. 次の例は、このリソースの書式設定を示しています。The following example demonstrates the format of this resource.

{
  "applications": {
    "value": [
      {
        "id": "9NBLGGH4R315",
        "resourceLocation": "applications/9NBLGGH4R315"
      }
    ],
    "totalCount": 1
  },
}

このリソースには、次の値があります。This resource has the following values.

ValueValue 種類Type 説明Description
valuevalue オブジェクトobject 次の値を格納するオブジェクトです。An object that contains the following values:

  • id。アプリケーションのストア ID です。id. The Store ID of the app. ストア ID について詳しくは、「アプリ ID の詳細の表示」をご覧ください。For more information about the Store ID, see View app identity details.
  • resourceLocationresourceLocation. アプリの完全なデータを取得するために基本 https://manage.devcenter.microsoft.com/v1.0/my/ 要求 URI に付加できる相対パス。A relative path that you can append to the base https://manage.devcenter.microsoft.com/v1.0/my/ request URI to retrieve the complete data for the app.
totalCounttotalCount intint 応答本文の applications 配列のアプリ オブジェクトの数。The number of app objects in the applications array of the response body.

申請のリソースSubmission resource

このリソースは、アドオンの申請に関する情報を提供します。This resource provides information about a submission for an add-on. 次の例は、このリソースの書式設定を示しています。The following example demonstrates the format of this resource.

{
  "pendingInAppProductSubmission": {
    "id": "1152921504621243619",
    "resourceLocation": "inappproducts/9NBLGGH4TNMP/submissions/1152921504621243619"
  },
}

このリソースには、次の値があります。This resource has the following values.

| ValueValue | 種類Type | 説明Description | |-----------------|---------|------------------| | idid | stringstring | 申請 ID。The ID of the submission. | | resourceLocationresourceLocation | stringstring | 申請の完全なデータを取得するために基本 https://manage.devcenter.microsoft.com/v1.0/my/ 要求 URI に付加できる相対パス。A relative path that you can append to the base https://manage.devcenter.microsoft.com/v1.0/my/ request URI to retrieve the complete data for the submission. |