Поделиться через

Управление надстройками

  • Статья

Используйте следующие методы в API отправки Microsoft Store для управления надстройками для приложений. Общие сведения об API отправки Microsoft Store, включая предварительные требования для использования API, см. в статье "Создание отправки и управление ими с помощью служб Microsoft Store".

Эти методы можно использовать только для получения, создания или удаления надстроек. Сведения о создании отправки надстроек см. в статье "Управление отправками надстроек".

Method URI Description
GET https://manage.devcenter.microsoft.com/v1.0/my/inappproducts Получение всех надстроек для приложений
GET https://manage.devcenter.microsoft.com/v1.0/my/inappproducts/{inAppProductId} Получение определенной надстройки
POST https://manage.devcenter.microsoft.com/v1.0/my/inappproducts Создание надстройки
DELETE https://manage.devcenter.microsoft.com/v1.0/my/inappproducts/{inAppProductId} Удаление надстройки

Необходимые компоненты

Если это еще не сделано, выполните все предварительные требования для API отправки Microsoft Store, прежде чем пытаться использовать любой из этих методов.

Ресурсы данных

Методы API отправки Microsoft Store для управления надстройками используют следующие ресурсы данных JSON.

Ресурс надстройки

Этот ресурс описывает надстройку.

{
  "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"
  }
}

Этот ресурс имеет следующие значения.

Значение Тип Описание
applications array Массив, содержащий один ресурс приложения, представляющий приложение, с которым связана эта надстройка. В этом массиве поддерживается только один элемент.
id строка Идентификатор магазина надстройки. Это значение предоставляется Магазином. Пример идентификатора магазина — 9NBLGGH4TNMP.
productId строка Идентификатор продукта надстройки. Это идентификатор, предоставленный разработчиком при создании надстройки. Дополнительные сведения см. в разделе "Настройка типа продукта" и идентификатора продукта.
productType строка Тип продукта надстройки. Поддерживаются следующие значения: устойчивые и потребляемые.
lastPublishedInAppProductSubmission объект Ресурс отправки, предоставляющий сведения о последней опубликованной отправке надстройки.
pendingInAppProductSubmission объект Ресурс отправки, предоставляющий сведения о текущей ожидающей отправке надстройки.

ресурс приложения.

Этот ресурс отменяет доступ к приложению, с которым связана надстройка. В следующем примере показан формат этого ресурса.

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

Этот ресурс имеет следующие значения.

Значение Тип Описание
значение объект Объект, содержащий следующие значения:
  • идентификатор. Идентификатор магазина приложения. Дополнительные сведения об идентификаторе Магазина см. в разделе "Просмотр сведений об удостоверении приложения".
  • resourceLocation. Относительный путь, который можно добавить к URI базового https://manage.devcenter.microsoft.com/v1.0/my/ запроса, чтобы получить полные данные для приложения.
totalCount INT Количество объектов приложения в массиве приложений текста ответа.

Ресурс отправки

Этот ресурс содержит сведения о отправке надстройки. В следующем примере показан формат этого ресурса.

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

Этот ресурс имеет следующие значения.

Значение Тип Описание
id строка Идентификатор отправки.
resourceLocation строка Относительный путь, который можно добавить к URI базового https://manage.devcenter.microsoft.com/v1.0/my/ запроса, чтобы получить полные данные для отправки.