Получение всех приложений

  • Статья

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

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

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

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

Запрос

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

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

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

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

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

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

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

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

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

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

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

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

В следующем примере демонстрируется способ извлечения информации о всех приложениях, которые зарегистрированы в вашей учетной записи. Сначала получите первые 10 приложений:

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

Затем рекурсивно вызовите , GET https://manage.devcenter.microsoft.com/v1.0/my/{@nextLink} пока не {@nextlink} будет иметь значение NULL или не существует в ответе. Пример:

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

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

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

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

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

Ответ

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

{
  "@nextLink": "applications?skip=10&top=10",
  "value": [
    {
      "id": "9NBLGGH4R315",
      "primaryName": "Contoso sample app",
      "packageFamilyName": "5224ContosoDeveloper.ContosoSampleApp_ng6try80pwt52",
      "packageIdentityName": "5224ContosoDeveloper.ContosoSampleApp",
      "publisherName": "CN=…",
      "firstPublishedDate": "2016-03-11T01:32:11.0747851Z",
      "pendingApplicationSubmission": {
        "id": "1152921504621134883",
        "resourceLocation": "applications/9NBLGGH4R315/submissions/1152921504621134883"
      }
    },
    {
      "id": "9NBLGGH29DM8",
      "primaryName": "Contoso sample app 2",
      "packageFamilyName": "5224ContosoDeveloper.ContosoSampleApp2_ng6try80pwt52",
      "packageIdentityName": "5224ContosoDeveloper.ContosoSampleApp2",
      "publisherName": "CN=…",
      "firstPublishedDate": "2016-03-12T01:49:11.0747851Z",
      "lastPublishedApplicationSubmission": {
        "id": "1152921504621225621",
        "resourceLocation": "applications/9NBLGGH29DM8/submissions/1152921504621225621"
      }
      // Next 8 apps are omitted for brevity ...
    }
  ],
  "totalCount": 21
}

Текст ответа

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

Коды ошибок

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

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