Получение надстроек для приложения

  • Статья

Используйте этот метод в API отправки Microsoft Store, чтобы получить список надстроек для приложения, зарегистрированного в вашей учетной записи Центра партнеров.

Предварительные требования

Для использования этого метода сначала необходимо сделать следующее:

  • Если вы еще не сделали этого, выполните все необходимые условия для API отправки в Microsoft Store.
  • Получите маркер доступа Azure AD, который будет использоваться в заголовке запроса этого метода. После получения маркера доступа у вас будет 60 минут, чтобы использовать его до истечения срока действия. После истечения срока действия маркера можно получить новый маркер.

Запрос

У этого метода следующий синтаксис. Примеры использования и описание текста заголовка и запроса приведены в следующих разделах.

Метод Универсальный код ресурса (URI) запроса
GET https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/listinappproducts

Заголовок запроса

Заголовок Тип Описание
Авторизация строка Обязательный. Маркер доступа Azure AD в видемаркера>носителя<.

Параметры запроса

Имя Тип Описание Обязательно
applicationId строка Код продукта в Магазине для приложения, по которому требуется получить данные о надстройках. Дополнительные сведения о коде продукта в Магазине см. в разделе Просмотр сведений об идентификации приложения. Да
top INT Число элементов, возвращаемых в запросе (т. е., количество возвращаемых надстроек). Если количество надстроек у приложения больше значения, указанного в запросе, текст ответа будет содержать относительный путь URI, который можно добавить в URI метода, чтобы запросить следующую страницу данных. Нет
skip INT Число элементов, которые требуется пропустить в запросе перед возвратом оставшихся элементов. Используйте этот параметр для постраничного перемещения по наборам данных. Например, если задано top = 10 и skip = 0, извлекаются элементы с 1 по 10; если задано top = 10 и skip = 10, извлекаются элементы с 11 по 20 и т. д. Нет

Текст запроса

Предоставлять текст запроса для этого метода не требуется.

Примеры запросов

В следующем примере показано, как получить список всех надстроек для приложения.

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

В следующем примере показано, как получить список первых 10 надстроек для приложения.

GET https://manage.devcenter.microsoft.com/v1.0/my/applications/9NBLGGH4R315/listinappproducts?top=10 HTTP/1.1
Authorization: Bearer <your access token>

Ответ

В следующем примере показано тело ответа JSON, возвращаемое при успешном запросе первых 10 надстроек для приложения, имеющего в сумме 53 надстройки. Для краткости в этом примере показаны данные только первых трех надстроек, возвращенных в запросе. Дополнительные сведения о значениях, которые могут содержаться в теле ответа, см. в следующем разделе.

{
  "@nextLink": "applications/9NBLGGH4R315/listinappproducts/?skip=10&top=10",
  "value": [
    {
      "inAppProductId": "9NBLGGH4TNMP"
    },
    {
      "inAppProductId": "9NBLGGH4TNMN"
    },
    {
      "inAppProductId": "9NBLGGH4TNNR"
    },
    // Next 7 add-ons  are omitted for brevity ...
  ],
  "totalCount": 53
}

Текст ответа

Значение Тип Описание
@nextLink строка При наличии дополнительных страниц данных эта строка содержит относительный путь, который можно добавить к базовому URI https://manage.devcenter.microsoft.com/v1.0/my/ запроса, чтобы запросить следующую страницу данных. Например, если для параметра top в тексте исходного запроса задано значение 10, но приложение содержит 50 надстроек, тело ответа будет содержать значение @nextLinkapplications/{applicationid}/listinappproducts/?skip=10&top=10, которое указывает, что можно вызвать https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationid}/listinappproducts/?skip=10&top=10 для запроса следующих 10 надстроек.
значение array Массив объектов, содержащих список кодов продуктов в Магазине для каждой надстройки указанного приложения. Дополнительные сведения о данных в каждом объекте см. в разделе Ресурс надстройки.
totalCount INT Общее количество строк в данных результата запроса (т. е., общее количество надстроек для указанного приложения).

Коды ошибок

Если запрос не удается выполнить, ответ будет содержать один из следующих кодов ошибок HTTP.

Код ошибки Описание
404 Надстройки не найдены.
409 Надстройки используют функции Центра партнеров, которые в настоящее время не поддерживаются API отправки Microsoft Store.