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

Управление отправками приложений

  • Статья

API отправки в Microsoft Store предоставляет методы, которые можно использовать для управления отправками для приложений, включая постепенные развертывания пакетов. Общие сведения об API отправки Microsoft Store, включая предварительные требования для использования API, см. в статье "Создание отправки и управление ими с помощью служб Microsoft Store".

Внимание

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

Внимание

Этот API нельзя использовать для публикации отправки для покупок томов с помощью Microsoft Store для бизнеса и Microsoft Store для образования или публикации отправки бизнес-приложений непосредственно на предприятия. Для обоих этих сценариев необходимо использовать Центр партнеров для публикации отправки.

Методы управления отправкой приложений

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

Method URI Description
GET https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId} Получение существующей отправки приложения
GET https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/status Получение состояния существующей отправки приложения
POST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions Создание отправки приложения
PUT https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId} Обновление существующей отправки приложения
POST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/commit Фиксация новой или обновленной отправки приложения
DELETE https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId} Удаление отправки приложения

Создание отправки приложения

Чтобы создать отправку для приложения, выполните этот процесс.

  1. Если вы этого еще не сделали, выполните все предварительные требования для API отправки Microsoft Store.

    Примечание.

    Убедитесь, что приложение уже имеет по крайней мере одну завершенную отправку с информацией о возрастных оценках , завершенной.

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

  3. Создайте отправку приложения, выполнив следующий метод в API отправки в Microsoft Store. Этот метод создает новую выполняющуюся отправку, которая является копией последней опубликованной отправки.

    POST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions

    Текст ответа содержит ресурс отправки приложения, содержащий идентификатор новой отправки, универсальный код ресурса (URI) подписанного URL-адреса (SAS) для отправки всех связанных файлов для отправки в Хранилище BLOB-объектов Azure (например, пакетов приложений, перечисления изображений и файлов трейлера), а также всех данных для новой отправки (например, списки и сведения о ценах).

    Примечание.

    URI SAS предоставляет доступ к защищенному ресурсу в службе хранилища Azure, не требуя ключей учетной записи. Общие сведения о URI SAS и их использовании с Хранилище BLOB-объектов Azure см. в разделе "Подписанные URL-адреса", часть 1. Общие сведения о модели SAS и подписанных URL-адресах, часть 2. Создание и использование SAS с хранилищем BLOB-объектов.

  4. Если вы добавляете новые пакеты, перечисляете изображения или файлы трейлеров для отправки, подготовьте пакеты приложений и подготовите снимки экрана приложения, изображения и трейлеры. Добавьте все эти файлы в ZIP-архив.

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

    PUT https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}

    Примечание.

    Если вы добавляете новые файлы для отправки, обязательно обновите данные отправки, чтобы ссылаться на имя и относительный путь к этим файлам в ZIP-архиве.

  6. Если вы добавляете новые пакеты, перечисляете изображения или файлы трейлера для отправки, отправьте ZIP-архив в Хранилище BLOB-объектов Azure с помощью URI SAS, предоставленного в тексте ответа метода POST, который вы вызвали ранее. Существуют различные библиотеки Azure, которые можно использовать для этого на различных платформах, в том числе:

    В следующем примере кода C# показано, как отправить ZIP-архив в Хранилище BLOB-объектов Azure с помощью класса CloudBlockBlob в клиентской библиотеке служба хранилища Azure для .NET. В этом примере предполагается, что ZIP-архив уже записан в объект потока.

    string sasUrl = "https://productingestionbin1.blob.core.windows.net/ingestion/26920f66-b592-4439-9a9d-fb0f014902ec?sv=2014-02-14&sr=b&sig=usAN0kNFNnYE2tGQBI%2BARQWejX1Guiz7hdFtRhyK%2Bog%3D&se=2016-06-17T20:45:51Z&sp=rwl";
Microsoft.WindowsAzure.Storage.Blob.CloudBlockBlob blockBob =
    new Microsoft.WindowsAzure.Storage.Blob.CloudBlockBlob(new System.Uri(sasUrl));
await blockBob.UploadFromStreamAsync(stream);

  7. Зафиксируйте отправку приложения, выполнив следующий метод. При этом центр партнеров будет оповещен о том, что вы выполнили отправку и что обновления теперь должны применяться к вашей учетной записи.

    POST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/commit

  8. Проверьте состояние фиксации, выполнив следующий метод, чтобы получить состояние отправки приложения.

    GET https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/status

    Чтобы подтвердить состояние отправки, просмотрите значение состояния в тексте ответа. Это значение должно измениться с CommitStarted на предварительную обработку, если запрос выполнен успешно или на CommitFailed, если в запросе возникают ошибки. Если возникают ошибки, поле statusDetails содержит дополнительные сведения об ошибке.

  9. После успешного завершения фиксации отправка отправляется в Магазин для приема. Вы можете продолжать отслеживать ход отправки с помощью предыдущего метода или посетить Центр партнеров.

Методы управления постепенным развертыванием пакетов

Вы можете постепенно развертывать обновленные пакеты в отправке приложения в процентах от клиентов вашего приложения в Windows 10 и Windows 11. Это позволяет отслеживать отзывы и аналитические данные для конкретных пакетов, чтобы убедиться, что вы уверены в обновлении, прежде чем развертывать его более широко. Вы можете изменить процент развертывания (или остановить обновление) для опубликованной отправки, не создавая новую отправку. Дополнительные сведения, включая инструкции по включению постепенного развертывания пакетов и управлению ими в Центре партнеров, см . в этой статье.

Чтобы программно включить постепенный выпуск пакета для отправки приложения, выполните этот процесс с помощью методов в API отправки в Microsoft Store:

  1. Создайте отправку приложения или получите существующую отправку приложения.
  2. В данных ответа найдите ресурс packageRollout, задайте для поля isPackageRollout значение true и задайте для поля packageRolloutPercentage процент клиентов вашего приложения, которые должны получать обновленные пакеты.
  3. Передайте обновленные данные отправки приложения в метод отправки приложения.

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

Method URI Description
GET https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/packagerollout Получение сведений о постепенном выпуске для отправки приложения
POST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/updatepackagerolloutpercentage Обновление процента постепенного развертывания для отправки приложения
POST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/haltpackagerollout Остановка постепенного развертывания для отправки приложения
POST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/finalizepackagerollout Завершение постепенного развертывания для отправки приложения

Примеры кода для управления отправкой приложений

В следующих статьях приведены подробные примеры кода, демонстрирующие создание отправки приложения на нескольких разных языках программирования:

Модуль StoreBroker PowerShell

В качестве альтернативы вызову API отправки Microsoft Store напрямую мы также предоставляем модуль PowerShell с открытым исходным кодом, который реализует интерфейс командной строки на вершине API. Этот модуль называется StoreBroker. Этот модуль можно использовать для управления отправкой приложений, полетов и надстроек из командной строки, а не вызова API отправки Microsoft Store напрямую, или вы можете просто просмотреть источник, чтобы просмотреть дополнительные примеры вызова этого API. Модуль StoreBroker активно используется в Корпорации Майкрософт в качестве основного способа отправки многих сторонних приложений в Магазин.

Дополнительные сведения см . на странице StoreBroker на сайте GitHub.

Ресурсы данных

Методы API отправки в Microsoft Store для управления отправкой приложений используют следующие ресурсы данных JSON.

Ресурс отправки приложения

Этот ресурс описывает отправку приложения.

{
  "id": "1152921504621243540",
  "applicationCategory": "BooksAndReference_EReader",
  "pricing": {
    "trialPeriod": "FifteenDays",
    "marketSpecificPricings": {},
    "sales": [],
    "priceId": "Tier2",
    "isAdvancedPricingModel": true
  },
  "visibility": "Public",
  "targetPublishMode": "Manual",
  "targetPublishDate": "1601-01-01T00:00:00Z",
  "listings": {
    "en-us": {
      "baseListing": {
        "copyrightAndTrademarkInfo": "",
        "keywords": [
          "epub"
        ],
        "licenseTerms": "",
        "privacyPolicy": "",
        "supportContact": "",
        "websiteUrl": "",
        "description": "Description",
        "features": [
          "Free ebook reader"
        ],
        "releaseNotes": "",
        "images": [
          {
            "fileName": "contoso.png",
            "fileStatus": "Uploaded",
            "id": "1152921504672272757",
            "description": "Main page",
            "imageType": "Screenshot"
          }
        ],
        "recommendedHardware": [],
        "title": "Contoso ebook reader"
      },
      "platformOverrides": {
        "Windows81": {
          "description": "Ebook reader for Windows 8.1"
        }
      }
    }
  },
  "hardwarePreferences": [
    "Touch"
  ],
  "automaticBackupEnabled": false,
  "canInstallOnRemovableMedia": true,
  "isGameDvrEnabled": false,
  "gamingOptions": [],
  "hasExternalInAppProducts": false,
  "meetAccessibilityGuidelines": true,
  "notesForCertification": "",
  "status": "PendingCommit",
  "statusDetails": {
    "errors": [],
    "warnings": [],
    "certificationReports": []
  },
  "fileUploadUrl": "https://productingestionbin1.blob.core.windows.net/ingestion/387a9ea8-a412-43a9-8fb3-a38d03eb483d?sv=2014-02-14&sr=b&sig=sdd12JmoaT6BhvC%2BZUrwRweA%2Fkvj%2BEBCY09C2SZZowg%3D&se=2016-06-17T18:32:26Z&sp=rwl",
  "applicationPackages": [
    {
      "fileName": "contoso_app.appx",
      "fileStatus": "Uploaded",
      "id": "1152921504620138797",
      "version": "1.0.0.0",
      "architecture": "ARM",
      "languages": [
        "en-US"
      ],
      "capabilities": [
        "ID_RESOLUTION_HD720P",
        "ID_RESOLUTION_WVGA",
        "ID_RESOLUTION_WXGA"
      ],
      "minimumDirectXVersion": "None",
      "minimumSystemRam": "None",
      "targetDeviceFamilies": [
        "Windows.Mobile min version 10.0.10240.0"
      ]
    }
  ],
  "packageDeliveryOptions": {
    "packageRollout": {
        "isPackageRollout": false,
        "packageRolloutPercentage": 0.0,
        "packageRolloutStatus": "PackageRolloutNotStarted",
        "fallbackSubmissionId": "0"
    },
    "isMandatoryUpdate": false,
    "mandatoryUpdateEffectiveDate": "1601-01-01T00:00:00.0000000Z"
  },
  "enterpriseLicensing": "Online",
  "allowMicrosoftDecideAppAvailabilityToFutureDeviceFamilies": true,
  "allowTargetFutureDeviceFamilies": {
    "Desktop": false,
    "Mobile": true,
    "Holographic": true,
    "Xbox": false,
    "Team": true
  },
  "friendlyName": "Submission 2",
  "trailers": []
}

Этот ресурс имеет следующие значения.

Значение Тип Описание
id строка Идентификатор отправки. Этот идентификатор доступен в данных ответа для запросов на создание отправки приложения, получение всех приложений и получение приложения. Для отправки, созданной в Центре партнеров, этот идентификатор также доступен в URL-адресе страницы отправки в Центре партнеров.
applicationCategory строка Строка, указывающая категорию и (или) подкатегорию для приложения. Категории и подкатегории объединяются в одну строку с символом подчеркивания "_", например BooksAndReference_EReader.
цены объект Ресурс ценообразования, содержащий сведения о ценах для приложения.
видимость строка Видимость приложения. Это может быть одно из следующих значений:
  • Скрытый
  • Общедоступные
  • Личные
  • NotSet
targetPublishMode строка Режим публикации для отправки. Это может быть одно из следующих значений:
  • Интерпретация
  • Руководство
  • SpecificDate
targetPublishDate строка Дата публикации для отправки в формате ISO 8601, если targetPublishMode имеет значение SpecificDate.
Предложения объект Словарь пар "ключ" и "значение", где каждый ключ является кодом страны, а каждое значение — это ресурс перечисления, содержащий сведения о списке для приложения.
hardwarePreferences array Массив строк, определяющих параметры оборудования для приложения. Это может быть одно из следующих значений:
  • Сенсорный ввод
  • Клавиатура
  • Мышь
  • Камера
  • NfcHce
  • Nfc
  • BluetoothLE
  • Телефония
automaticBackupEnabled boolean Указывает, могут ли Windows включать данные приложения в автоматические резервные копии в OneDrive. Дополнительные сведения см . в объявлениях приложений.
canInstallOnRemovableMedia boolean Указывает, могут ли клиенты устанавливать приложение в съемный хранилище. Дополнительные сведения см . в объявлениях приложений.
isGameDvrEnabled boolean Указывает, включена ли dvR игры для приложения.
Игровыеoptions array Массив, содержащий один ресурс игровых параметров, определяющий параметры, связанные с игрой, для приложения.
hasExternalInAppProducts boolean Указывает, позволяет ли ваше приложение совершать покупки за пределами коммерческой системы Microsoft Store. Дополнительные сведения см . в объявлениях приложений.
meetAccessibilityGuidelines boolean Указывает, проверено ли ваше приложение в соответствии с рекомендациями по специальным возможностям. Дополнительные сведения см . в объявлениях приложений.
notesForCertification строка Содержит заметки о сертификации для приложения.
статус строка Состояние отправки. Это может быть одно из следующих значений:
  • нет
  • Отмененные
  • ОжиданиеCommit
  • CommitStarted
  • CommitFailed
  • Ожидание публикации
  • Публикация
  • Опубликованные
  • PublishFailed
  • Предварительная обработка
  • PreProcessingFailed
  • Сертификация
  • CertificationFailed
  • Выпуск
  • ReleaseFailed
statusDetails объект Ресурс сведений о состоянии, содержащий дополнительные сведения о состоянии отправки, включая сведения об ошибках.
fileUploadUrl строка URI подписанного URL-адреса (SAS) для отправки пакетов для отправки. Если вы добавляете новые пакеты, перечисляете изображения или файлы трейлера для отправки, отправьте ZIP-архив, содержащий пакеты и изображения в этот URI. Дополнительные сведения см. в разделе "Создание отправки приложения".
applicationPackages array Массив ресурсов пакета приложения, предоставляющих сведения о каждом пакете в отправке.
packageDeliveryOptions объект Ресурс параметров доставки пакетов, содержащий постепенное развертывание пакета и обязательные параметры обновления для отправки.
enterpriseLicensing строка Одно из значений корпоративного лицензирования, указывающее поведение корпоративного лицензирования для приложения.
allowMicrosoftDecideAppAvailabilityToFutureDeviceFamilies boolean Указывает, разрешено ли майкрософт сделать приложение доступным для будущих семейств устройств Windows 10 и Windows 11.
allowTargetFutureDeviceFamilies объект Словарь пар ключей и значений, где каждый ключ — это семейство устройств Windows 10 и Windows 11, а каждое значение — логическое значение, указывающее, разрешено ли приложению использовать указанное семейство устройств.
friendlyName строка Понятное имя отправки, как показано в Центре партнеров. Это значение создается при создании отправки.
Прицепы array Массив, содержащий до 15 ресурсов трейлеров, представляющих видео трейлеры для описания приложения.

Ресурс ценообразования

Этот ресурс содержит сведения о ценах для приложения. Этот ресурс имеет следующие значения.

Значение Тип Описание
trialPeriod строка Строка, задающая пробный период для приложения. Это может быть одно из следующих значений:
  • NoFreeTrial
  • OneDay
  • TrialNeverExpires
  • SevenDays
  • Пятнадцати дней
  • ТридцатьDays
marketSpecificPricings объект Словарь пар "ключ и значение", где каждый ключ — это двухбуквенный код страны ISO 3166-1 alpha-2, а каждое значение — ценовая категория. Эти элементы представляют пользовательские цены для вашего приложения на определенных рынках. Все элементы в этом словаре переопределяют базовую цену, указанную значением priceId для указанного рынка.
продажи array Устарело. Массив ресурсов продаж, содержащих сведения о продажах для приложения.
priceId строка Ценовая категория , указывающая базовую цену для приложения.
isAdvancedPricingModel boolean Если верно, ваша учетная запись разработчика имеет доступ к расширенному набору ценовых категорий с 99 долларов США до 1999,99 ДОЛЛ. США. Если значение false, ваша учетная запись разработчика имеет доступ к исходному набору ценовых категорий с 99 долл. США до 999,99 долл. США. Дополнительные сведения о разных уровнях см. в разделе ценовых категорий.

Обратите внимание, что это поле доступно только для чтения.

Ресурс продажи

Эти ресурсы содержат сведения о продаже для приложения.

Внимание

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

  • После вызова метода GET для получения отправки приложения значение продаж будет пустым. Вы можете продолжать использовать Центр партнеров для получения данных о продажах для отправки приложения.
  • При вызове метода PUT для обновления отправки приложения сведения в значении продаж игнорируются. Вы можете продолжать использовать Центр партнеров для изменения данных о продажах для отправки приложения.

Этот ресурс имеет следующие значения.

Значение Тип Description
name строка Имя продажи.
basePriceId строка Ценовая категория , используемая для базовой цены продажи.
startDate строка Дата начала продажи в формате ISO 8601.
endDate строка Дата окончания продажи в формате ISO 8601.
marketSpecificPricings объект Словарь пар "ключ и значение", где каждый ключ — это двухбуквенный код страны ISO 3166-1 alpha-2, а каждое значение — ценовая категория. Эти элементы представляют пользовательские цены для вашего приложения на определенных рынках. Все элементы в этом словаре переопределяют базовую цену, указанную значением basePriceId для указанного рынка.

Перечисление ресурса

Этот ресурс содержит сведения о списке для приложения. Этот ресурс имеет следующие значения.

Значение Тип Описание
baseListing объект Базовые сведения о списке для приложения, определяющие сведения о списке по умолчанию для всех платформ.
platformOverrides объект Словарь пар "ключ" и "значение", где каждый ключ является строкой, определяющей платформу, для которой необходимо переопределить сведения о списке, и каждое значение — это базовый ресурс перечисления (содержащий только значения из описания в название), указывающий сведения о перечислении для переопределения для указанной платформы. Ключи могут иметь следующие значения:
  • Неизвестно
  • Windows80
  • Windows81
  • WindowsPhone71
  • WindowsPhone80
  • WindowsPhone81

Базовый ресурс перечисления

Этот ресурс содержит базовые сведения о списке для приложения. Этот ресурс имеет следующие значения.

Значение Тип Описание
copyrightAndTrademarkInfo строка Необязательные сведения об авторских правах и /или товарных знаках.
ключевые слова array Массив ключевых слов, помогающий приложению отображаться в результатах поиска.
licenseTerms строка Необязательные условия лицензии для приложения.
privacyPolicy строка Это значение устарело. Чтобы задать или изменить URL-адрес политики конфиденциальности для приложения, необходимо сделать это на странице "Свойства " в Центре партнеров. Это значение можно опустить из вызовов API отправки. Если задать это значение, он будет игнорироваться.
supportContact строка Это значение устарело. Чтобы задать или изменить URL-адрес или адрес электронной почты для вашего приложения, необходимо сделать это на странице "Свойства " в Центре партнеров. Это значение можно опустить из вызовов API отправки. Если задать это значение, он будет игнорироваться.
websiteUrl строка Это значение устарело. Чтобы задать или изменить URL-адрес веб-страницы приложения, это необходимо сделать на странице "Свойства " в Центре партнеров. Это значение можно опустить из вызовов API отправки. Если задать это значение, он будет игнорироваться.
описание строка Описание описания приложения.
features array Массив до 20 строк, которые перечисляют функции приложения.
releaseNotes строка Заметки о выпуске приложения.
images array Массив ресурсов изображений и значков для списка приложений.
рекомендуемое программное обеспечениеHardware array Массив до 11 строк, которые перечисляют рекомендуемые конфигурации оборудования для приложения.
минимальное программное обеспечениеHardware строка Массив до 11 строк, которые перечисляют минимальные конфигурации оборудования для приложения.
title string Заголовок списка приложений.
shortDescription строка Используется только для игр. Это описание отображается в разделе "Информация " в Центре игр на Xbox One и помогает клиентам понять больше о вашей игре.
shortTitle строка Более короткая версия имени продукта. Если это указано, это короткое имя может отображаться в различных местах в Xbox One (во время установки, в достижениях и т. д.) вместо полного названия вашего продукта.
sortTitle строка Если продукт может быть в алфавитном порядке, вы можете ввести другую версию здесь. Это может помочь клиентам быстрее найти продукт при поиске.
voiceTitle строка Альтернативное имя продукта, которое, если указано, может использоваться в звуковом интерфейсе Xbox One при использовании Kinect или гарнитуры.
devStudio строка Укажите это значение, если вы хотите включить поле", разработанное по полю в списке. (The Опубликовано по полю отобразится отображаемое имя издателя, связанное с вашей учетной записью, независимо от того, предоставляется ли значение devStudio.)

Ресурс изображения

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

Значение Тип Описание
fileName строка Имя файла изображения в ZIP-архиве, отправленном для отправки.
fileStatus строка Состояние файла изображения. Это может быть одно из следующих значений:
  • нет
  • ОжиданиеUpload
  • Отправка
  • ОжиданиеDelete
id строка Идентификатор изображения. Это значение предоставляется Центром партнеров.
описание строка Описание изображения.
imageType строка Указывает тип изображения. В настоящее время поддерживаются следующие строки.

Снимок экрана:

  • Снимок экрана (используйте это значение для снимка экрана рабочего стола)
  • MobileScreenshot
  • XboxScreenshot
  • SurfaceHubScreenshot
  • HoloLensScreenshot

Логотипы магазина:

  • StoreLogo9x16
  • StoreLogoSquare
  • Значок (используйте это значение для логотипа 1:1 300 x 300 пикселей)

Рекламные изображения:

  • Рекламный элементArt16x9
  • Рекламныеartwork2400X1200

Изображения Xbox:

  • XboxBrandedKeyArt
  • XboxTitledHeroArt
  • XboxFeaturedPromotionalArt

Необязательные рекламные изображения:

  • SquareIcon358X358
  • BackgroundImage1000X800
  • Рекламныеartwork414X180

Ресурс параметров игр

Этот ресурс содержит параметры, связанные с игрой для приложения. Значения в этом ресурсе соответствуют параметрам игры для отправки в Центре партнеров.

{
  "gamingOptions": [
    {
      "genres": [
        "Games_ActionAndAdventure",
        "Games_Casino"
      ],
      "isLocalMultiplayer": true,
      "isLocalCooperative": true,
      "isOnlineMultiplayer": false,
      "isOnlineCooperative": false,
      "localMultiplayerMinPlayers": 2,
      "localMultiplayerMaxPlayers": 12,
      "localCooperativeMinPlayers": 2,
      "localCooperativeMaxPlayers": 12,
      "isBroadcastingPrivilegeGranted": true,
      "isCrossPlayEnabled": false,
      "kinectDataForExternal": "Enabled"
    }
  ],
}

Этот ресурс имеет следующие значения.

Значение Тип Описание
genres array Массив одной или нескольких из следующих строк, описывающих жанры игры:
  • Games_ActionAndAdventure
  • Games_CardAndBoard
  • Games_Casino
  • Games_Educational
  • Games_FamilyAndKids
  • Games_Fighting
  • Games_Music
  • Games_Platformer
  • Games_PuzzleAndTrivia
  • Games_RacingAndFlying
  • Games_RolePlaying
  • Games_Shooter
  • Games_Simulation
  • Games_Sports
  • Games_Strategy
  • Games_Word
isLocalMultiplayer boolean Указывает, поддерживает ли игра локальную многопользовательскую игру.
isLocalCooperative boolean Указывает, поддерживает ли игра локальную совместную работу.
isOnlineMultiplayer boolean Указывает, поддерживает ли игра многопользовательскую игру в Интернете.
isOnlineCooperative boolean Указывает, поддерживает ли игра онлайн-совместную работу.
localMultiplayerMinPlayers INT Указывает минимальное количество игроков, поддерживаемых для локального многопользовательского режима.
localMultiplayerMaxPlayers INT Указывает максимальное количество игроков, поддерживаемых для локального многопользовательского режима.
localCooperativeMinPlayers INT Указывает минимальное количество игроков, поддерживаемых для локального совместной работы.
localCooperativeMaxPlayers INT Указывает максимальное количество игроков, поддерживаемых для локального совместной работы.
isBroadcastingPrivilegeGranted boolean Указывает, поддерживает ли игра трансляцию.
isCrossPlayEnabled boolean Указывает, поддерживает ли игра многопользовательские сеансы между игроками на компьютерах с Windows 10 и Windows 11 и Xbox.
kinectDataForExternal строка Одно из следующих строковых значений, указывающее, может ли игра собирать данные Kinect и отправлять их во внешние службы:
  • NotSet
  • Неизвестно
  • Активировано
  • Выключено

Примечание.

Ресурс gamingOptions был добавлен в мае 2017 года после того, как API отправки Microsoft Store был впервые выпущен разработчикам. Если вы создали отправку для приложения через API отправки до того, как этот ресурс был введен, и эта отправка по-прежнему выполняется, этот ресурс будет иметь значение NULL для отправки приложения, пока вы не зафиксируете отправку или удалите его. Если ресурс gamingOptions недоступен для отправки приложения, поле hasAdvancedListingPermission, возвращаемое методом приложения, имеет значение false.

Ресурс сведений о состоянии

Этот ресурс содержит дополнительные сведения о состоянии отправки. Этот ресурс имеет следующие значения.

Значение Тип Описание
ошибки объект Массив ресурсов сведений о состоянии, содержащих сведения об ошибке для отправки.
warnings объект Массив ресурсов сведений о состоянии, содержащих сведения о предупреждении для отправки.
certificationReports объект Массив ресурсов отчета о сертификации, предоставляющих доступ к данным отчета о сертификации для отправки. Эти отчеты можно просмотреть для получения дополнительных сведений, если сертификация завершается ошибкой.

Ресурс сведений о состоянии

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

Значение Тип Описание
кодом строка Код состояния отправки, описывающий тип ошибки или предупреждения.
details строка Сообщение с дополнительными сведениями о проблеме.

Ресурс пакета приложения

Этот ресурс содержит сведения о пакете приложения для отправки.

{
  "applicationPackages": [
    {
      "fileName": "contoso_app.appx",
      "fileStatus": "Uploaded",
      "id": "1152921504620138797",
      "version": "1.0.0.0",
      "architecture": "ARM",
      "languages": [
        "en-US"
      ],
      "capabilities": [
        "ID_RESOLUTION_HD720P",
        "ID_RESOLUTION_WVGA",
        "ID_RESOLUTION_WXGA"
      ],
      "minimumDirectXVersion": "None",
      "minimumSystemRam": "None",
      "targetDeviceFamilies": [
        "Windows.Mobile min version 10.0.10240.0"
      ]
    }
  ],
}

Этот ресурс имеет следующие значения.

Примечание.

При вызове метода отправки приложения в текст запроса требуются только значения fileName, fileStatus, minimumDirectXVersion и minimumSystemRam этого объекта. Остальные значения заполняются Центром партнеров.

Значение Тип Описание
fileName строка Имя пакета.
fileStatus строка Состояние пакета. Это может быть одно из следующих значений:
  • нет
  • ОжиданиеUpload
  • Отправка
  • ОжиданиеDelete
id строка Идентификатор, который однозначно идентифицирует пакет. Это значение предоставляется Центром партнеров.
версия строка Версия пакета приложения. Дополнительные сведения см. в разделе "Нумерирование версий пакета".
архитектура строка Архитектура пакета (например, ARM).
languages array Массив языковых кодов для языков, поддерживаемых приложением. Дополнительные сведения см. в разделе Поддерживаемые языки.
capabilities array Массив возможностей, необходимых пакету. Дополнительные сведения о возможностях см . в объявлениях возможностей приложений.
minimumDirectXVersion строка Минимальная версия DirectX, поддерживаемая пакетом приложения. Это можно задать только для приложений, предназначенных для Windows 8.x. Для приложений, предназначенных для других версий ОС, это значение должно присутствовать при вызове метода отправки приложения, но указанное значение игнорируется. Это может быть одно из следующих значений:
  • нет
  • DirectX93
  • DirectX100
minimumSystemRam строка Минимальная ОЗУ, требуемая пакетом приложения. Это можно задать только для приложений, предназначенных для Windows 8.x. Для приложений, предназначенных для других версий ОС, это значение должно присутствовать при вызове метода отправки приложения, но указанное значение игнорируется. Это может быть одно из следующих значений:
  • нет
  • Память2 ГБ
targetDeviceFamilies array Массив строк, представляющих семейства устройств, предназначенные для пакета. Это значение используется только для пакетов, предназначенных для Windows 10; для пакетов, предназначенных для предыдущих выпусков, это значение имеет значение None. Следующие строки семейства устройств в настоящее время поддерживаются для пакетов Windows 10 и Windows 11, где {0} находится строка версии Windows 10 или Windows 11, например 10.0.10240.0, 10.0.10586.0 или 10.0.14393.0:
  • Версия Windows.Universal min {0}
  • Версия Windows.Desktop min {0}
  • Версия Windows.Mobile min {0}
  • Версия Windows.Xbox min {0}
  • Windows.Holographic min version {0}

id="certification-report-resource"

Ресурс отчета о сертификации

Этот ресурс предоставляет доступ к данным отчета о сертификации для отправки. Этот ресурс имеет следующие значения.

Значение Тип Описание
Дата строка Дата и время создания отчета в формате ISO 8601.
reportUrl строка URL-адрес, по которому можно получить доступ к отчету.

Ресурс параметров доставки пакетов

Этот ресурс содержит постепенное развертывание пакета и обязательные параметры обновления для отправки.

{
  "packageDeliveryOptions": {
    "packageRollout": {
        "isPackageRollout": false,
        "packageRolloutPercentage": 0,
        "packageRolloutStatus": "PackageRolloutNotStarted",
        "fallbackSubmissionId": "0"
    },
    "isMandatoryUpdate": false,
    "mandatoryUpdateEffectiveDate": "1601-01-01T00:00:00.0000000Z"
  },
}

Этот ресурс имеет следующие значения.

Значение Тип Описание
packageRollout объект Ресурс развертывания пакета, содержащий параметры постепенного развертывания пакетов для отправки.
isMandatoryUpdate boolean Указывает, следует ли рассматривать пакеты в этой отправке как обязательные для самостоятельной установки обновлений приложений. Дополнительные сведения о обязательных пакетах для самостоятельной установки обновлений приложений см. в разделе "Скачивание и установка обновлений пакетов" для приложения.
обязательныйUpdateEffectiveDate Дата Дата и время, когда пакеты в этой отправке становятся обязательными в формате ISO 8601 и часовом поясе UTC.

Ресурс развертывания пакета

Этот ресурс содержит параметры постепенного развертывания пакета для отправки. Этот ресурс имеет следующие значения.

Значение Тип Описание
isPackageRollout boolean Указывает, включена ли постепенная развертывание пакета для отправки.
packageRolloutPercentage с плавающей запятой Процент пользователей, которые получат пакеты в постепенном развертывании.
packageRolloutStatus строка Одна из следующих строк, указывающих состояние постепенного развертывания пакета:
  • PackageRolloutNotStarted
  • PackageRolloutInProgress
  • PackageRolloutComplete
  • PackageRolloutStopped
fallbackSubmissionId строка Идентификатор отправки, которая будет получена клиентами, которые не получают пакеты постепенного развертывания.

Примечание.

Значения packageRolloutStatus и резервные значенияSubmissionId назначаются Центром партнеров и не предназначены для установки разработчиком. Если включить эти значения в текст запроса, эти значения будут игнорироваться.

Ресурс трейлеров

Этот ресурс представляет трейлер видео для описания приложения. Значения в этом ресурсе соответствуют параметрам трейлеров для отправки в Центре партнеров.

Вы можете добавить до 15 ресурсов трейлеров в массив трейлеров в ресурсе отправки приложений. Чтобы отправить видеофайлы трейлера и эскизы для отправки, добавьте эти файлы в тот же ZIP-архив, содержащий пакеты и перечисление изображений для отправки, а затем отправьте этот ZIP-архив в URI подписанного URL-адреса (SAS) для отправки. Дополнительные сведения о отправке ZIP-архива в URI SAS см. в разделе "Создание отправки приложения".

{
  "trailers": [
    {
      "id": "1158943556954955699",
      "videoFileName": "Trailers\\ContosoGameTrailer.mp4",
      "videoFileId": "1159761554639123258",
      "trailerAssets": {
        "en-us": {
          "title": "Contoso Game",
          "imageList": [
            {
              "fileName": "Images\\ContosoGame-Thumbnail.png",
              "id": "1155546904097346923",
              "description": "This is a still image from the video."
            }
          ]
        }
      }
    }
  ]
}

Этот ресурс имеет следующие значения.

Значение Тип Описание
id строка Идентификатор трейлера. Это значение предоставляется Центром партнеров.
videoFileName строка Имя видеофайла трейлера в ZIP-архиве, содержащего файлы для отправки.
videoFileId строка Идентификатор видеофайла трейлера. Это значение предоставляется Центром партнеров.
трейлерAssets объект Словарь пар "ключ" и "значение", где каждый ключ является языковым кодом, и каждое значение является ресурсом ресурсов трейлера, который содержит дополнительные ресурсы, относящиеся к языковому стандарту для трейлера. Дополнительные сведения о поддерживаемых языковых кодах см. в разделе "Поддерживаемые языки".

Примечание.

Ресурс трейлеров был добавлен в мае 2017 года после того, как API отправки Microsoft Store был впервые выпущен разработчикам. Если вы создали отправку для приложения через API отправки до того, как этот ресурс был введен, и эта отправка по-прежнему выполняется, этот ресурс будет иметь значение NULL для отправки приложения, пока вы не зафиксируете отправку или удалите его. Если ресурс трейлеров недоступен для отправки приложения, поле hasAdvancedListingPermission, возвращаемое методом приложения, имеет значение false.

Ресурс активов трейлера

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

Значение Тип Описание
название string Локализованный заголовок трейлера. Заголовок отображается, когда пользователь воспроизводит трейлер в полноэкранном режиме.
imageList array Массив, содержащий один ресурс изображения , предоставляющий эскиз изображения для трейлера. В этот массив можно включить только один ресурс изображения .

Ресурс изображения (для трейлера)

Этот ресурс описывает эскиз изображения для трейлера. Этот ресурс имеет следующие значения.

Значение Тип Описание
fileName строка Имя файла эскиза изображения в ZIP-архиве, отправленном для отправки.
id строка Идентификатор изображения эскиза. Это значение предоставляется Центром партнеров.
описание строка Описание эскиза изображения. Это значение является только метаданными и не отображается пользователям.

Перечисления

Эти методы используют следующие перечисления.

Ценовые категории

Следующие значения представляют доступные ценовые категории в ресурсе ценовых ресурсов для отправки приложения.

значение Описание
База Ценовая категория не задана; используйте базовую цену для приложения.
NotAvailable Приложение недоступно в указанном регионе.
Бесплатно Это бесплатное приложение.
Уровеньxxx Строка, указывающая ценовую категорию для приложения в формате xxxx. В настоящее время поддерживаются следующие диапазоны ценовых категорий:

  • Если значение isAdvancedPricingModel ресурса ценообразования имеет значение true, доступные значения ценовой категории для вашей учетной записи : Tier1012 - Tier1424.
  • Если значение isAdvancedPricingModel ресурса ценообразования равно false, доступные значения ценовой категории для вашей учетной записи — Tier2 - Tier96.
Чтобы просмотреть полную таблицу ценовых категорий, доступных для вашей учетной записи разработчика, включая рыночные цены, связанные с каждым уровнем, перейдите на страницу цен и доступности для любой из отправки приложений в Центре партнеров и щелкните ссылку на таблицу просмотра в разделе "Рынки" и пользовательские цены (для некоторых учетных записей разработчиков, эта ссылка находится в разделе "Цены").

Корпоративные значения лицензирования

Следующие значения представляют поведение лицензирования организации для приложения. Дополнительные сведения об этих параметрах см. в разделе "Параметры лицензирования организации".

Примечание.

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

значение Описание
Нет Не делайте приложение доступным для предприятий с корпоративным лицензированием, управляемым Магазином (online).
Миграция по сети Сделайте приложение доступным для предприятий с корпоративным лицензированием, управляемым Магазином (online).
OnlineAndOffline Сделайте приложение доступным для предприятий с корпоративным лицензированием, управляемым Магазином (online), и сделайте приложение доступным для предприятий через отключенное (автономное) лицензирование.

Код состояния отправки

Следующие значения представляют код состояния отправки.

значение Описание
Нет Код не указан.
InvalidArchive ZIP-архив, содержащий пакет, является недопустимым или имеет нераспознанный формат архива.
MissingFiles ZIP-архив не содержит все файлы, которые были указаны в данных отправки, или они находятся в неправильном расположении в архиве.
PackageValidationFailed Не удалось проверить один или несколько пакетов в отправке.
InvalidParameterValue Один из параметров в тексте запроса недопустим.
InvalidOperation Предпринята недопустимая операция.
InvalidState Предпринятая операция недопустима для текущего состояния тестового пакета.
ResourceNotFound Не удалось найти указанный тест пакета.
ServiceError Внутренняя ошибка службы предотвратила успешное выполнение запроса. Повторите запрос.
ЛистингOptOutWarning Разработчик удалил список из предыдущей отправки или не включал сведения о списке, поддерживаемые пакетом.
ЛистингOptInWarning Разработчик добавил описание.
UpdateOnlyWarning Разработчик пытается вставить то, что поддерживает только обновления.
Другие Отправка находится в нераспознанном или некатегоризованном состоянии.
PackageValidationWarning Процесс проверки пакета привел к предупреждению.