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

Получение всех надстроек

  • Статья

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

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

Чтобы использовать этот метод, сначала необходимо выполнить следующие действия:

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

Запросить

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

Способ URI запроса
GET https://manage.devcenter.microsoft.com/v1.0/my/inappproducts

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

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

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

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

Параметр Тип Описание Обязательное поле
популярное 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/inappproducts HTTP/1.1
Authorization: Bearer <your access token>

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

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

Response

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

{
  "@nextLink": "inappproducts/?skip=5&top=5",
  "value": [
    {
      "applications": {
        "value": [
          {
            "id": "9NBLGGH4R315",
            "resourceLocation": "applications/9NBLGGH4R315"
          }
        ],
        "totalCount": 1
      },
      "id": "9NBLGGH4TNMP",
      "productId": "a8b8310b-fa8d-4da0-aca0-577ef6dce4dd",
      "productType": "Consumable",
      "pendingInAppProductSubmission": {
        "id": "1152921504621243619",
        "resourceLocation": "inappproducts/9NBLGGH4TNMP/submissions/1152921504621243619"
      },
      "lastPublishedInAppProductSubmission": {
        "id": "1152921504621243705",
        "resourceLocation": "inappproducts/9NBLGGH4TNMP/submissions/1152921504621243705"
      }
    },
    {
      "applications": {
        "value": [
          {
            "id": "9NBLGGH4R315",
            "resourceLocation": "applications/9NBLGGH4R315"
          }
        ],
        "totalCount": 1
      },
      "id": "9NBLGGH4TNMN",
      "productId": "6a3c9788-a350-448a-bd32-16160a13018a",
      "productType": "Consumable",
      "pendingInAppProductSubmission": {
        "id": "1152921504621243538",
        "resourceLocation": "inappproducts/9NBLGGH4TNMN/submissions/1152921504621243538"
      },
      "lastPublishedInAppProductSubmission": {
        "id": "1152921504621243106",
        "resourceLocation": "inappproducts/9NBLGGH4TNMN/submissions/1152921504621243106"
      }
    },

  // Other add-ons omitted for brevity...
  ],
  "totalCount": 1072
}

Текст ответа

Значение Тип Описание:
@nextLink строка Если есть дополнительные страницы данных, эта строка содержит относительный путь, который можно добавить к URI базового https://manage.devcenter.microsoft.com/v1.0/my/ запроса, чтобы запросить следующую страницу данных. Например, если в качестве верхнего параметра исходного текста запроса задано значение 10, но в вашей учетной записи зарегистрировано 100 надстроек, текст ответа будет содержать @nextLink значение inappproducts?skip=10&top=10, указывающее, что можно вызвать https://manage.devcenter.microsoft.com/v1.0/my/inappproducts?skip=10&top=10 запрос следующих 10 надстроек.
значение array Массив, содержащий объекты, предоставляющие сведения о каждой надстройке. Дополнительные сведения см. в ресурсе надстройки.
totalCount INT Количество объектов приложения в массиве значений текста ответа.

Коды ошибок

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

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