Получение всех приложений
Используйте этот метод в API отправки Microsoft Store, чтобы получить данные для приложений, зарегистрированных в учетной записи Центра партнеров.
Необходимые компоненты
Чтобы использовать этот метод, сначала необходимо выполнить следующие действия:
- Если вы этого еще не сделали, выполните все предварительные требования для API отправки Microsoft Store.
- Получите маркер доступа Azure AD для использования в заголовке запроса для этого метода. После получения маркера доступа у вас будет 60 минут, чтобы использовать его до истечения срока действия. После истечения срока действия маркера можно получить новый.
Запросить
Этот метод имеет следующий синтаксис. В следующих разделах приведены примеры использования и описания текста заголовка и запроса.
| Способ | URI запроса |
|---|---|
| GET | https://manage.devcenter.microsoft.com/v1.0/my/applications |
Заголовок запроса
| Верхний колонтитул | Тип | Описание |
|---|---|---|
| Авторизация | строка | Обязательный. Маркер доступа Azure AD в маркере> носителя<формы. |
Параметры запроса
Все параметры запроса являются необязательными для этого метода. При вызове этого метода без параметров ответ содержит данные для первых 10 приложений, зарегистрированных в вашей учетной записи.
| Параметр | Тип | Описание | Обязательное поле |
|---|---|---|---|
| популярное | INT | Количество элементов, возвращаемых в запросе (т. е. количество возвращаемых приложений). Если у вашей учетной записи больше приложений, чем указано в запросе, текст ответа содержит относительный ПУТЬ URI, который можно добавить к URI метода, чтобы запросить следующую страницу данных. | No |
| skip | INT | Количество элементов, которые нужно обойти в запросе, прежде чем возвращать остальные элементы. Используйте этот параметр для страницы с помощью наборов данных. Например, top=10 и skip=0 извлекает элементы от 1 до 10, top=10 и skip=10 извлекает элементы 11–20 и т. д. | No |
Текст запроса
Не предоставляйте текст запроса для этого метода.
Примеры запросов
В следующем примере показано, как получить первые 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>
Если вы уже знаете общее количество приложений, которые у вас есть в вашей учетной записи, вы можете просто передать это число в верхнем параметре, чтобы получить сведения обо всех приложениях.
GET https://manage.devcenter.microsoft.com/v1.0/my/applications?top=23 HTTP/1.1
Authorization: Bearer <your access token>
Response
В следующем примере показан текст ответа 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
}
Текст ответа
| Значение | Тип | Описание |
|---|---|---|
| значение | array | Массив объектов, содержащих сведения о каждом приложении, зарегистрированном в вашей учетной записи. Дополнительные сведения о данных в каждом объекте см. в разделе "Ресурс приложения". |
| @nextLink | строка | Если есть дополнительные страницы данных, эта строка содержит относительный путь, который можно добавить к URI базового https://manage.devcenter.microsoft.com/v1.0/my/ запроса, чтобы запросить следующую страницу данных. Например, если верхний параметр исходного текста запроса имеет значение 10, но в вашей учетной записи зарегистрировано 20 приложений, текст ответа будет содержать @nextLink значение applications?skip=10&top=10, указывающее, что можно вызвать https://manage.devcenter.microsoft.com/v1.0/my/applications?skip=10&top=10 следующие 10 приложений. |
| totalCount | INT | Общее количество строк в результатах данных для запроса (то есть общее количество приложений, зарегистрированных в вашей учетной записи). |
Коды ошибок
Если запрос не может быть выполнен успешно, ответ будет содержать один из следующих кодов ошибок HTTP.
| Код ошибки | Description |
|---|---|
| 404 | Нет приложений. |
| 409 | Приложения используют функции Центра партнеров, которые в настоящее время не поддерживаются API отправки Microsoft Store. |