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

  • Статья

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

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

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

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

Запрос

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

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

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

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

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

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

Параметр Тип Описание Обязательно
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/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>

Ответ

В следующем примере показано тело ответа 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/ запроса, чтобы запросить следующую страницу данных. Например, если для параметра top в тексте исходного запроса задано значение 10, но в учетной записи зарегистрировано 100 надстроек, тело ответа будет содержать значение @nextLinkinappproducts?skip=10&top=10, которое указывает, что можно вызвать https://manage.devcenter.microsoft.com/v1.0/my/inappproducts?skip=10&top=10 для запроса следующих 10 надстроек.
значение array Массив, содержащий объекты, которые предоставляют сведения о каждой надстройке. Дополнительные сведения см. в разделе Ресурс надстройки.
totalCount INT Количество объектов приложения в массиве value тела ответа.

Коды ошибок

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

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