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

Обновление отправки приложения

  • Статья

Используйте этот метод в API отправки Microsoft Store для обновления существующей отправки приложения. После успешного обновления отправки с помощью этого метода необходимо зафиксировать отправку для проверки и публикации.

Дополнительные сведения об использовании этого метода в процессе создания отправки приложения с помощью API отправки Microsoft Store см. в разделе Управление отправками приложений.

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

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

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

Запрос

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

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

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

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

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

Имя Тип Описание
applicationId строка Обязательный. Код продукта в Магазине для приложения, отправку которого необходимо обновить. Дополнительные сведения о коде продукта в Магазине см. в разделе Просмотр сведений об идентификации приложения.
submissionId строка Обязательный. Идентификатор отправки для обновления. Этот идентификатор добавляется в данные ответов для запросов на создание отправки приложения. Для отправки, созданной в Центре партнеров, этот идентификатор также доступен в URL-адресе страницы отправки в Центре партнеров.

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

Текст запроса содержит следующие параметры.

Значение Тип Описание
applicationCategory строка Строка, указывающая категорию или подкатегорию для вашего приложения. Категории и подкатегории объединяются в одну строку с помощью символа подчеркивания "_", например BooksAndReference_EReader.
цены object Объект, содержащий сведения о цене приложения. Дополнительные сведения см. в разделе Ресурс Pricing.
видимость строка Видимость приложения. Может иметь одно из следующих значений:
  • Скрытый
  • Общедоступные
  • Личные
  • NotSet
targetPublishMode строка Режим публикации для отправки. Может иметь одно из следующих значений:
  • Немедленно
  • Вручную
  • SpecificDate (Указанная дата)
targetPublishDate строка Дата публикации отправки в формате ISO 8601, если для targetPublishMode задано значение SpecificDate.
listings объект Словарь пар "ключ-значение", где каждый ключ является кодом страны, а каждое значение — объект ресурса Listing, содержащий данные описания приложения.
hardwarePreferences array Массив строк, определяющих предпочтения оборудования для приложения. Может иметь одно из следующих значений:
  • Touch
  • Клавиатура
  • Мышь
  • Камера
  • NfcHce
  • Nfc
  • BluetoothLE
  • Telephony (Телефония)
automaticBackupEnabled Логическое Указывает, может ли Windows включать данные этого приложения в автоматические резервные копии, записываемые в OneDrive. Подробные сведения см. в разделе Объявления приложений.
canInstallOnRemovableMedia Логическое Указывает, могут ли клиенты устанавливать приложение на съемный носитель. Подробные сведения см. в разделе Объявления приложений.
isGameDvrEnabled Логическое Указывает, включена ли для приложения функция DVR для игр.
gamingOptions object Массив, содержащий один ресурс параметров игры, который определяет относящиеся к игре параметры для приложения.
hasExternalInAppProducts Логическое Указывает, позволяет ли приложение пользователям делать покупки без использования коммерческой системы Microsoft Store. Подробные сведения см. в разделе Объявления приложений.
meetAccessibilityGuidelines Логическое Указывает, проверено ли приложение на соответствие рекомендациям по специальным возможностям. Подробные сведения см. в разделе Объявления приложений.
notesForCertification строка Содержит заметки по сертификации приложения.
applicationPackages array Содержит объекты, предоставляющие сведения о каждом пакете в отправке. Дополнительные сведения см. в разделе Пакет приложения. При вызове этого метода для обновления отправки приложения в теле запроса должны присутствовать только значения fileName, fileStatus, minimumDirectXVersion и minimumSystemRam этих объектов. Остальные значения заполняются Центром партнеров.
packageDeliveryOptions object Содержит параметры постепенного выпуска пакета и обязательного обновления для отправки. Подробнее см. в разделе Объект параметров доставки пакета.
enterpriseLicensing строка Одно из значений, связанных с корпоративным лицензированием, задающих поведение приложения в отношении корпоративного лицензирования.
allowMicrosftDecideAppAvailabilityToFutureDeviceFamilies Логическое Указывает, разрешено ли корпорации Майкрософт сделать приложение доступным для будущих семейств устройств Windows 10 и Windows 11.
allowTargetFutureDeviceFamilies Логическое Указывает, разрешено ли приложению использовать будущие семейства устройств Windows 10 и Windows 11.
trailers array Массив, содержащий до ресурсов трейлеров, представляющие видеотрейлеры для описания приложения.

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

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

PUT https://manage.devcenter.microsoft.com/v1.0/my/applications/9NBLGGH4R315/submissions/1152921504621230023 HTTP/1.1
Authorization: Bearer <your access token>
Content-Type: application/json
{
  "applicationCategory": "BooksAndReference_EReader",
  "pricing": {
    "trialPeriod": "FifteenDays",
    "marketSpecificPricings": {},
    "sales": [],
    "priceId": "Tier2"
  },
  "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",
            "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": "",
  "applicationPackages": [
    {
      "fileName": "contoso_app.appx",
      "fileStatus": "PendingUpload",
      "minimumDirectXVersion": "None",
      "minimumSystemRam": "None"
    }
  ],
  "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
  },
  "trailers": []
}

Ответ

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

{
  "id": "1152921504621243540",
  "applicationCategory": "BooksAndReference_EReader",
  "pricing": {
    "trialPeriod": "FifteenDays",
    "marketSpecificPricings": {},
    "sales": [],
    "priceId": "Tier2"
  },
  "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",
            "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": "PendingUpload",
      "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": []
}

Коды ошибок

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

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