Обновление отправки надстройкиUpdate an add-on submission

Используйте этот метод в API отправки Microsoft Store, чтобы обновить данные для существующей отправки надстройки (также известной как продукт внутри приложения или IAP).Use this method in the Microsoft Store submission API to update an existing add-on (also known as in-app product or IAP) submission. После успешного обновления отправки с помощью этого метода необходимо зафиксировать отправку для проверки и публикации.After you successfully update a submission by using this method, you must commit the submission for ingestion and publishing.

Дополнительные сведения об использовании этого метода в процессе создания отправки надстройки с помощью API отправки Microsoft Store см. в разделе Управление отправками надстроек.For more information about how this method fits into the process of creating an add-on submission by using the Microsoft Store submission API, see Manage add-on submissions.

Предварительные условияPrerequisites

Для использования этого метода сначала необходимо сделать следующее:To use this method, you need to first do the following:

  • Если вы еще не сделали этого, выполните все необходимые условия для API отправки в Microsoft Store.If you have not done so already, complete all the prerequisites for the Microsoft Store submission API.
  • Получите маркер доступа Azure AD, который будет использоваться в заголовке запроса этого метода.Obtain an Azure AD access token to use in the request header for this method. После получения токена доступа у вас будет 60 минут, чтобы использовать его до окончания его срока действия.After you obtain an access token, you have 60 minutes to use it before it expires. После истечения срока действия токена можно получить новый токен.After the token expires, you can obtain a new one.
  • Создайте надстройку адресация, одно из приложений.Create an add-on submission for one of your apps. Это можно сделать в центре партнеров, или это можно сделать с помощью создать надстройку отправки метод.You can do this in Partner Center, or you can do this by using the Create an add-on submission method.

ЗапросRequest

У этого метода следующий синтаксис.This method has the following syntax. Примеры использования и описание текста заголовка и запроса приведены в следующих разделах.See the following sections for usage examples and descriptions of the header and request body.

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

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

ЗаголовокHeader ТипType ОписаниеDescription
AuthorizationAuthorization Строкаstring Обязательный.Required. Маркер доступа Azure AD в форме носителя < маркера>.The Azure AD access token in the form Bearer <token>.

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

ИмяName ТипType ОписаниеDescription
inAppProductIdinAppProductId Строкаstring Обязательный.Required. Код продукта в Магазине для надстройки, отправку которой необходимо обновить.The Store ID of the add-on for which you want to update a submission. Идентификатор Store доступен в центре партнеров, и она включена в данные ответа для запросов к создать надстройку или получение сведений о надстройка.The Store ID is available in Partner Center, and it is included in the response data for requests to Create an add-on or get add-on details.
submissionIdsubmissionId Строкаstring Обязательный.Required. Идентификатор отправки для обновления.The ID of the submission to update. Этот идентификатор добавляется в данные ответов для запросов на создание отправки надстройки.This ID is available in the response data for requests to create an add-on submission. Для отправки, который был создан в центре партнеров этот идентификатор также доступна в URL-АДРЕСЕ для отправки страницы в центре партнеров.For a submission that was created in Partner Center, this ID is also available in the URL for the submission page in Partner Center.

Тело запросаRequest body

Текст запроса содержит следующие параметры.The request body has the following parameters.

ЗначениеValue ТипType ОписаниеDescription
contentTypecontentType Строкаstring Тип содержимого, которое предоставляется в надстройке.The type of content that is provided in the add-on. Может принимать одно из следующих значений.This can be one of the following values:
  • NotSet (Не задано)NotSet
  • BookDownload (Загрузка книги)BookDownload
  • EMagazine (Электронный журнал)EMagazine
  • ENewspaper (Электронная газета)ENewspaper
  • MusicDownload (Загрузка музыки)MusicDownload
  • MusicStream (Потоковая передача музыки)MusicStream
  • OnlineDataStorage (Сетевое хранилище данных)OnlineDataStorage
  • VideoDownload (Загрузка видео)VideoDownload
  • VideoStream (Потоковая передача видео)VideoStream
  • AspAsp
  • OnlineDownload (Загрузка по Интернету)OnlineDownload
keywordskeywords Массивarray Массив строк, содержащих до 10 ключевых слов для надстройки.An array of strings that contain up to 10 keywords for the add-on. Приложение может запрашивать надстройки с помощью этих ключевых слов.Your app can query for add-ons using these keywords.
lifetimelifetime Строкаstring Время существования надстройки.The lifetime of the add-on. Может принимать одно из следующих значений.This can be one of the following values:
  • Forever (Навсегда)Forever
  • OneDay (Один день)OneDay
  • ThreeDays (3 дня)ThreeDays
  • FiveDays (5 дней)FiveDays
  • OneWeek (Одна неделя)OneWeek
  • TwoWeeks (Две недели)TwoWeeks
  • OneMonth (Один месяц)OneMonth
  • TwoMonths (Два месяца)TwoMonths
  • ThreeMonths (Три месяца)ThreeMonths
  • SixMonths (Шесть месяцев)SixMonths
  • OneYear (Один год)OneYear
listingslistings Объектobject Объект, содержащий сведения об описании надстройки.An object that contains listing info for the add-on. Дополнительные сведения см. в разделе Ресурс описания.For more information, see Listing resource.
pricingpricing Объектobject Объект, содержащий сведения о цене надстройки.An object that contains pricing info for the add-on. Дополнительные сведения см. в разделе Ресурс цены.For more information, see Pricing resource.
targetPublishModetargetPublishMode Строкаstring Режим публикации для отправки.The publish mode for the submission. Может принимать одно из следующих значений.This can be one of the following values:
  • Immediate (Незамедлительно)Immediate
  • Manual (Вручную)Manual
  • SpecificDate (Указанная дата)SpecificDate
targetPublishDatetargetPublishDate Строкаstring Дата публикации отправки в формате ISO 8601, если для targetPublishMode задано значение SpecificDate.The publish date for the submission in ISO 8601 format, if the targetPublishMode is set to SpecificDate.
tagtag Строкаstring Настраиваемые данные разработчика для надстройки (ранее эта информация называлась tag).The custom developer data for the add-on (this information was previously called the tag).
visibilityvisibility Строкаstring Видимость надстройки.The visibility of the add-on. Может принимать одно из следующих значений.This can be one of the following values:
  • Hidden (Скрыто)Hidden
  • Public (Общее)Public
  • Private (Частное)Private
  • NotSet (Не задано)NotSet

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

В следующем примере показано обновление отправки надстройки.The following example demonstrates how to update an add-on submission.

PUT https://manage.devcenter.microsoft.com/v1.0/my/inappproducts/9NBLGGH4TNMP/submissions/1152921504621230023 HTTP/1.1
Authorization: Bearer <your access token>
Content-Type: application/json
{
  "contentType": "EMagazine",
  "keywords": [
    "books"
  ],
  "lifetime": "FiveDays",
  "listings": {
    "en": {
      "description": "English add-on description",
      "icon": {
        "fileName": "add-on-en-us-listing2.png",
        "fileStatus": "Uploaded"
      },
      "title": "Add-on Title (English)"
    },
    "ru": {
      "description": "Russian add-on description",
      "icon": {
        "fileName": "add-on-ru-listing.png",
        "fileStatus": "Uploaded"
      },
      "title": "Add-on Title (Russian)"
    }
  },
  "pricing": {
    "marketSpecificPricings": {
      "RU": "Tier3",
      "US": "Tier4",
    },
    "sales": [],
    "priceId": "Free"
  },
  "targetPublishDate": "2016-03-15T05:10:58.047Z",
  "targetPublishMode": "Immediate",
  "tag": "SampleTag",
  "visibility": "Public",
}

ОтветResponse

В следующем примере представлен текст ответа JSON в случае успешного вызова этого метода.The following example demonstrates the JSON response body for a successful call to this method. В теле ответа содержатся сведения об обновленной отправке.The response body contains information about the updated submission. Дополнительные сведения о значениях в тексте ответа см. в разделе Ресурс отправки надстройки.For more details about the values in the response body, see Add-on submission resource.

{
  "id": "1152921504621243680",
  "contentType": "EMagazine",
  "keywords": [
    "books"
  ],
  "lifetime": "FiveDays",
  "listings": {
    "en": {
      "description": "English add-on description",
      "icon": {
        "fileName": "add-on-en-us-listing2.png",
        "fileStatus": "Uploaded"
      },
      "title": "Add-on Title (English)"
    },
    "ru": {
      "description": "Russian add-on description",
      "icon": {
        "fileName": "add-on-ru-listing.png",
        "fileStatus": "Uploaded"
      },
      "title": "Add-on Title (Russian)"
    }
  },
  "pricing": {
    "marketSpecificPricings": {
      "RU": "Tier3",
      "US": "Tier4",
    },
    "sales": [],
    "priceId": "Free"
  },
  "targetPublishDate": "2016-03-15T05:10:58.047Z",
  "targetPublishMode": "Immediate",
  "tag": "SampleTag",
  "visibility": "Public",
  "status": "PendingCommit",
  "statusDetails": {
    "errors": [
      {
        "code": "None",
        "details": "string"
      }
    ],
    "warnings": [
      {
        "code": "ListingOptOutWarning",
        "details": "You have removed listing language(s): []"
      }
    ],
    "certificationReports": [
      {
      }
    ]
  },
  "fileUploadUrl": "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",
  "friendlyName": "Submission 2"
}

Коды ошибокError codes

Если запрос не удается выполнить, ответ будет содержать один из следующих кодов ошибок HTTP.If the request cannot be successfully completed, the response will contain one of the following HTTP error codes.

Код ошибкиError code ОписаниеDescription
400400 Не удалось обновить отправку. Недопустимый запрос.The submission could not be updated because the request is invalid.
409409 Не удалось обновить отправки из-за текущее состояние надстройки или надстройки использует возможности центра партнеров, в настоящее время не поддерживается API отправки Microsoft Store.The submission could not be updated because of the current state of the add-on, or the add-on uses a Partner Center feature that is currently not supported by the Microsoft Store submission API.