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

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

  • Статья

Используйте этот метод в 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 строка Идентификатор приложения, для которого требуется получить надстройки. Дополнительные сведения об идентификаторе Магазина см. в разделе "Просмотр сведений об удостоверении приложения". Да
популярное INT Количество элементов, возвращаемых в запросе (т. е. количество возвращаемых надстроек). Если приложение имеет больше надстроек, чем значение, указанное в запросе, текст ответа содержит относительный URI-путь, который можно добавить к URI метода, чтобы запросить следующую страницу данных. No
skip INT Количество элементов, которые нужно обойти в запросе, прежде чем возвращать остальные элементы. Используйте этот параметр для страницы с помощью наборов данных. Например, top=10 и skip=0 извлекает элементы от 1 до 10, top=10 и skip=10 извлекает элементы 11–20 и т. д. No

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

Не предоставляйте текст запроса для этого метода.

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

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

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>

Response

В следующем примере показан текст ответа 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/ запроса, чтобы запросить следующую страницу данных. Например, если верхний параметр исходного текста запроса имеет значение 10, но для приложения есть 50 надстроек, текст ответа будет содержать @nextLink значение applications/{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.

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