Получите все дополнения

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

Предпосылки

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

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

Просьба

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

Метод Запрос URI
ПОЛУЧАЙ https://manage.devcenter.microsoft.com/v1.0/my/inappproducts

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

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

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

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

Параметр Тип Описание Обязательно
Верх инт Количество элементов, которые нужно вернуть в запросе (т. е. количество возвращаемых дополнений). Если в вашей учетной записи больше дополнений, чем указанное в запросе значение, ответ содержит относительный URI-путь, который можно добавить к методному URI, чтобы запросить следующую страницу данных. нет
пропустить инт Количество элементов, которые нужно обойти в запросе, прежде чем возвращать остальные элементы. Используйте этот параметр для перелистывания наборов данных. Например, 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 струна Если есть дополнительные страницы данных, эта строка содержит относительный путь, который можно добавить к базовому https://manage.devcenter.microsoft.com/v1.0/my/ URI запроса, чтобы запросить следующую страницу данных. Например, если для параметра верхнего исходного текста запроса задано значение 10, но в вашей учетной записи зарегистрировано 100 надстроек, текст ответа будет содержать @nextLink значение inappproducts?skip=10&top=10, указывающее, что можно вызывать https://manage.devcenter.microsoft.com/v1.0/my/inappproducts?skip=10&top=10 для запроса следующих 10 надстроек.
ценность массив Массив, содержащий объекты, предоставляющие сведения о каждом дополнении. Дополнительную информацию см. в ресурсе надстройки .
общееКоличество инт Количество объектов приложения в массиве значений тела ответа.

Коды ошибок

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

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