Обновление отправки надстройки

  • Статья

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

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

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

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

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

Запрос

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

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

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

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

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

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

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

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

Значение Тип Описание
сontentType строка Тип содержимого, которое предоставляется в надстройке. Может иметь одно из следующих значений:
  • NotSet
  • BookDownload (Загрузка книги)
  • EMagazine (Электронный журнал)
  • ENewspaper (Электронная газета)
  • MusicDownload (Загрузка музыки)
  • MusicStream (Потоковая передача музыки)
  • OnlineDataStorage (Сетевое хранилище данных)
  • VideoDownload (Загрузка видео)
  • VideoStream (Потоковая передача видео)
  • Asp
  • OnlineDownload (Загрузка по Интернету)
keywords array Массив строк, содержащих до 10 ключевых слов для надстройки. Приложение может запрашивать надстройки с помощью этих ключевых слов.
lifetime строка Время существования надстройки. Может иметь одно из следующих значений:
  • Постоянно
  • OneDay (Один день)
  • ThreeDays (3 дня)
  • FiveDays (5 дней)
  • OneWeek (Одна неделя)
  • TwoWeeks (Две недели)
  • OneMonth (Один месяц)
  • TwoMonths (Два месяца)
  • ThreeMonths (Три месяца)
  • SixMonths (Шесть месяцев)
  • OneYear (Один год)
listings объект Объект, содержащий сведения об описании надстройки. Дополнительные сведения см. в разделе Ресурс описания.
цены объект Объект, содержащий сведения о цене надстройки. Дополнительные сведения см. в разделе Ресурс цены.
targetPublishMode строка Режим публикации для отправки. Может иметь одно из следующих значений:
  • Немедленно
  • Вручную
  • SpecificDate (Указанная дата)
targetPublishDate строка Дата публикации отправки в формате ISO 8601, если для targetPublishMode задано значение SpecificDate.
тег строка Настраиваемые данные разработчика для надстройки (ранее эта информация называлась tag).
видимость строка Видимость надстройки. Может иметь одно из следующих значений:
  • Скрытый
  • Общедоступные
  • Личные
  • NotSet

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

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

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",
}

Ответ

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

{
  "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"
}

Коды ошибок

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

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