Actualización de un envío de complemento

  • Artículo

Usa este método en la API de envío de Microsoft Store para actualizar un envío de complemento existente (también conocido como producto desde la aplicación o IAP). Después de actualizar correctamente un envío mediante este método, debes confirmar el envío para su ingesta y publicación.

Para obtener más información sobre cómo encaja este método en el proceso de creación de un envío de complemento mediante la API de envío de Microsoft Store, consulta Administrar envíos de complementos.

Requisitos previos

Para usar este método, primero debes hacer lo siguiente:

  • Si aún no lo ha hecho, complete todos los requisitos previos para la API de envío de Microsoft Store.
  • Obtén un token de acceso de Azure AD para usarlo en el encabezado de la solicitud de este método. Una vez que haya obtenido un token de acceso, tiene 60 minutos para usarlo antes de que expire. Si el token expira, puedes obtener uno nuevo.
  • Cree un envío de complemento para una de las aplicaciones. Puedes hacerlo en el Centro de partners o puedes hacerlo mediante el método Crear un envío de complemento .

Solicitud

Este método tiene la siguiente sintaxis. Consulta las siguientes secciones para ver ejemplos de uso y descripciones tanto del encabezado como del cuerpo de la solicitud.

Método URI de la solicitud
PUT https://manage.devcenter.microsoft.com/v1.0/my/inappproducts/{inAppProductId}/submissions/{submissionId}

Encabezado de solicitud

Encabezado Tipo Descripción
Authorization string Necesario. Token de acceso de Azure AD con el formato Token de portador<>.

Parámetros de solicitud

Nombre Tipo Descripción
inAppProductId string Necesario. Id. de la Tienda del complemento para el cual deseas actualizar un envío. El id. de la Tienda está disponible en el Centro de partners y se incluye en los datos de respuesta de las solicitudes para crear un complemento o obtener detalles del complemento.
submissionId string Necesario. Identificador del envío que se debe actualizar. Este identificador está disponible en los datos de respuesta de las solicitudes para crear un envío de complemento. Para un envío creado en el Centro de partners, este identificador también está disponible en la dirección URL de la página de envío en el Centro de partners.

Cuerpo de la solicitud

El cuerpo de la solicitud tiene los siguientes parámetros.

Valor Tipo Descripción
contentType string Tipo de contenido que se proporciona en el complemento. Puede ser uno de los siguientes valores:
  • NotSet
  • BookDownload
  • EMagazine
  • ENewspaper
  • MusicDownload
  • MusicStream
  • OnlineDataStorage
  • VideoDownload
  • VideoStream
  • Asp
  • OnlineDownload
keywords array Matriz de cadenas que contienen hasta 10 palabras clave para el complemento. Gracias a estas palabras clave, la aplicación puede consultar complementos.
lifetime cadena Duración del complemento. Puede ser uno de los siguientes valores:
  • Siempre
  • OneDay
  • ThreeDays
  • FiveDays
  • OneWeek
  • TwoWeeks
  • OneMonth
  • TwoMonths
  • ThreeMonths
  • SixMonths
  • OneYear
listings object Objeto que contiene la información de la descripción del complemento. Para obtener más información, consulta Listing resource (Recurso de descripción).
Precios object Objeto que contiene la información del precio del complemento. Para obtener más información, consulta Pricing resource (Recurso de precio).
targetPublishMode cadena Modo de publicación del envío. Puede ser uno de los siguientes valores:
  • Inmediata
  • Manual
  • SpecificDate
targetPublishDate cadena Fecha de publicación del envío en formato ISO 8601, si el valor targetPublishMode se establece en SpecificDate.
etiqueta string Los datos del desarrollador personalizados para el complemento (esta información se denominaba anteriormente tag).
visibilidad string Visibilidad del complemento. Puede ser uno de los siguientes valores:
  • Hidden
  • Público
  • Privada
  • NotSet

Ejemplo de solicitud

En el siguiente ejemplo se muestra cómo actualizar un envío de complemento.

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

En el siguiente ejemplo se muestra el cuerpo de la respuesta JSON de una llamada satisfactoria a este método. El cuerpo de la respuesta contiene información sobre el envío actualizado. Para obtener más información acerca de los valores en el cuerpo de la respuesta, consulta Add-on submission resource (Recurso de envío de complemento).

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

Códigos de error

Si la solicitud no se puede completar correctamente, la respuesta contendrá uno de los siguientes códigos de error HTTP.

Código de error Descripción
400 No se pudo actualizar el envío porque la solicitud no es válida.
409 No se pudo actualizar el envío debido al estado actual del complemento o el complemento usa una característica del Centro de partners que actualmente no es compatible con la API de envío de Microsoft Store.