Compartir a través de

Administración de envíos de aplicaciones

  • Artículo

La API de envío de Microsoft Store proporciona métodos que puedes usar para administrar envíos para tus aplicaciones, incluidas las implementaciones graduales de paquetes. Para obtener una introducción a la API de envío de Microsoft Store, incluidos los requisitos previos para usar la API, consulte Crear y administrar envíos mediante los servicios de Microsoft Store.

Importante

Si usas la API de envío de Microsoft Store para crear un envío para una aplicación, asegúrate de realizar más cambios en el envío solo mediante la API, en lugar del Centro de partners. Si usa el Centro de partners para cambiar un envío que creó originalmente mediante la API, ya no podrá cambiar ni confirmar ese envío mediante la API. En algunos casos, el envío podría quedar en un estado de error que le impedirá continuar con el proceso de envío. Si esto ocurre, debe eliminar el envío y crear uno nuevo.

Importante

No puede usar esta API para publicar envíos de compras por volumen a través de la Microsoft Store para Empresas y Microsoft Store para Educación o publicar envíos para aplicaciones loB directamente en empresas. En ambos escenarios, debe usar el Centro de partners para publicar el envío.

Métodos para administrar envíos de aplicaciones

Use los métodos siguientes para obtener, crear, actualizar, confirmar o eliminar un envío de aplicación. Para poder usar estos métodos, la aplicación ya debe existir en la cuenta del Centro de partners y primero debe crear un envío para la aplicación en el Centro de partners. Para más información, consulte la sección los requisitos previos.

Método URI Descripción
GET https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId} Obtener un envío de aplicación existente
GET https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/status Obtener el estado de un envío de aplicación existente
PUBLICAR https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions Creación de un nuevo envío de aplicación
PUT https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId} Actualización de un envío de aplicación existente
PUBLICAR https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/commit Confirmación de un envío de aplicación nuevo o actualizado
Delete https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId} Eliminar un envío de aplicación

Crear un envío de aplicación

Para crear un envío para una aplicación, siga este proceso.

  1. Si aún no lo ha hecho, complete todos los requisitos previos para la API de envío de Microsoft Store.

    Nota:

    Asegúrese de que la aplicación ya tiene al menos un envío completado con la información de clasificaciones por edad completada.

  2. Obtener un token de acceso de Azure AD. Debe pasar este token de acceso a los métodos de la API de envío de Microsoft Store. Una vez que haya obtenido un token de acceso, tiene 60 minutos para usarlo antes de que expire. Una vez que expire el token, puede obtener uno nuevo.

  3. Cree un envío de aplicación ejecutando el método siguiente en la API de envío de Microsoft Store. Este método crea un nuevo envío en curso, que es una copia del último envío publicado.

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

    El cuerpo de la respuesta contiene un recurso de envío de aplicación que incluye el identificador del nuevo envío, el URI de firma de acceso compartido (SAS) para cargar los archivos relacionados para el envío a Azure Blob Storage (por ejemplo, paquetes de aplicaciones, mostrar imágenes y archivos finalizados) y todos los datos del nuevo envío (como las listas e información de precios).

    Nota:

    Un URI de SAS proporciona acceso a un recurso seguro en el almacenamiento de Azure sin necesidad de claves de cuenta. Para obtener información de antecedentes sobre los URI de SAS y su uso con Azure Blob Storage, consulte Firma de acceso compartido, parte 1: comprender el modelo SAS y Firma de acceso compartido, parte 2: crear y usar un SAS con almacenamiento de blobs.

  4. Si va a agregar nuevos paquetes, enumerar imágenes o archivos finalizadores para el envío, prepare los paquetes de la aplicación y prepare las capturas de pantalla, las imágenes y los finalizadores de la aplicación. Agregue todos estos archivos a un archivo ZIP.

  5. Revise los datos de envío de la aplicación con los cambios necesarios para el nuevo envío y ejecute el siguiente método para actualizar el envío de la aplicación.

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

    Nota:

    Si va a agregar nuevos archivos para el envío, asegúrese de actualizar los datos de envío para hacer referencia al nombre y la ruta de acceso relativa de estos archivos en el archivo ZIP.

  6. Si va a agregar nuevos paquetes, enumerar imágenes o archivos finalizadores para el envío, cargue el archivo ZIP en Azure Blob Storage mediante el URI de SAS que se proporcionó en el cuerpo de la respuesta del método POST al que llamó anteriormente. Existen diferentes bibliotecas de Azure que puede usar para hacer esto en una variedad de plataformas, que incluyen:

    El siguiente ejemplo de código C# muestra cómo cargar un archivo ZIP en Azure Blob Storage mediante la clase CloudBlockBlob en la biblioteca cliente de Azure Storage para .NET. Este ejemplo supone que el archivo ZIP ya se ha escrito en un objeto de secuencia.

    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. Confirme el envío de la aplicación ejecutando el método siguiente. Esto alertará al Centro de partners de que ha terminado con el envío y que las actualizaciones ahora deberían aplicarse a su cuenta.

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

  8. Compruebe el estado de confirmación ejecutando el método siguiente para obtener el estado del envío de la aplicación.

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

    Para confirmar el estado del envío, revise el valor estado en el cuerpo de respuesta. Este valor debe cambiar de CommitStarted a PreProcessing si la solicitud se realiza correctamente, o bien a CommitFailed si hay errores en la solictud. Si hay errores, el campo statusDetails contiene más detalles sobre el error.

  9. Una vez que la confirmación se ha completado con éxito, el envío se destina al almacén para su ingesta. Puede continuar supervisando el progreso del envío utilizando el método anterior o visitando el Centro de partners.

Métodos para administrar un lanzamiento gradual de paquetes

Puedes implementar gradualmente los paquetes actualizados en un envío de aplicación a un porcentaje de los clientes de la aplicación en Windows 10 y Windows 11. Esto le permite supervisar los comentarios y los datos analíticos de los paquetes específicos para asegurarse de que está seguro de la actualización antes de implementarla de forma más amplia. Puede cambiar el porcentaje de lanzamiento (o detener la actualización) de un envío publicado sin tener que crear un nuevo envío. Para obtener más información, incluidas las instrucciones para habilitar y administrar un lanzamiento gradual de paquetes en el Centro de partners, consulte este artículo.

Para habilitar mediante programación un lanzamiento gradual de paquetes para un envío de aplicación, siga este proceso mediante métodos en la API de envío de Microsoft Store:

  1. Cree un envío de aplicación o obtenga un envío de aplicación existente.
  2. En los datos de respuesta, busque el recurso packageRollout, establezca el campo isPackageRollout en true y establezca el campo packageRolloutPercentage en el porcentaje de los clientes de la aplicación que deben obtener los paquetes actualizados.
  3. Pase los datos de envío de la aplicación actualizados al método de envío de una aplicación.

Una vez habilitada una implementación gradual de paquetes para un envío de aplicación, puedes usar los métodos siguientes para obtener, actualizar, detener o finalizar la implementación gradual mediante programación.

Método URI Descripción
GET https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/packagerollout Obtener la información de lanzamiento gradual de un envío de aplicación
PUBLICAR https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/updatepackagerolloutpercentage Actualizar el porcentaje de lanzamiento gradual de un envío de aplicación
PUBLICAR https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/haltpackagerollout Detener el lanzamiento gradual de un envío de aplicación
PUBLICAR https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/finalizepackagerollout Finalización del lanzamiento gradual de un envío de aplicación

Ejemplos de código para administrar envíos de aplicaciones

En los artículos siguientes se proporcionan ejemplos de código detallados que muestran cómo crear un envío de aplicación en varios lenguajes de programación diferentes:

Módulo StoreBroker de PowerShell

Como alternativa a llamar directamente a la API de envío de Microsoft Store, también proporcionamos un módulo de PowerShell de código abierto que implementa una interfaz de la línea de comandos sobre la API. Este módulo se denomina StoreBroker. Puede utilizar este módulo para administrar los envíos de aplicaciones, versiones piloto y complementos desde la línea de comandos en lugar de llamar directamente a la API de envío de Microsoft Store, o simplemente puede examinar el origen para ver más ejemplos de cómo llamar a esta API. El módulo StoreBroker se usa activamente en Microsoft como la principal forma en que muchas aplicaciones propias se envían al almaceń.

Para obtener más información, consulte nuestra página StoreBroker en GitHub.

Recursos de datos

Los métodos de la API de envío de Microsoft Store para administrar envíos de aplicaciones usan los siguientes recursos de datos JSON.

Recurso de envío de aplicación

Este recurso describe un envío de aplicación.

{
  "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": []
}

Este recurso tiene los siguientes valores.

Valor Tipo Descripción
id string El identificador del envío. Este identificador está disponible en los datos de respuesta de las solicitudes para crear un envío de aplicación, obtener todas las aplicaciones y obtener una aplicación. 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.
applicationCategory string Cadena que especifica la categoría o subcategoría de la aplicación. Las categorías y subcategorías se combinan en una sola cadena con el carácter de subrayado "_", como BooksAndReference_EReader.
Precios objeto Un recurso de precios que contiene información de precios para la aplicación.
visibility string Visibilidad de la aplicación. Este puede ser uno de los siguientes valores:
  • Oculto
  • Público
  • Privada
  • NotSet
targetPublishMode string El modo de publicación para el envío. Este puede ser uno de los siguientes valores:
  • Inmediato
  • Manual
  • SpecificDate
targetPublishDate string La fecha de publicación para el envío en formato ISO 8601, si targetPublishMode está establecido en SpecificDate.
listings objeto Diccionario de pares clave y valor, donde cada clave es un código de país y cada valor es un recurso de lista que contiene información de descripción de la aplicación.
hardwarePreferences array Matriz de cadenas que definen las preferencias de hardware de la aplicación. Este puede ser uno de los siguientes valores:
  • Tocar
  • Teclado
  • Mouse
  • Camera
  • NfcHce
  • Nfc
  • BluetoothLE
  • Telefonía
automaticBackupEnabled boolean Indica si Windows puede incluir los datos de la aplicación en copias de seguridad automáticas en OneDrive. Para obtener más información, consulte Declaraciones de aplicaciones.
canInstallOnRemovableMedia boolean Indica si los clientes pueden instalar la aplicación en un almacenamiento extraíble. Para obtener más información, consulte Declaraciones de aplicaciones.
isGameDvrEnabled boolean Indica si el DVR del juego está habilitado para la aplicación.
gamingOptions array Matriz que contiene un recurso de opciones de juego que define la configuración relacionada con el juego para la aplicación.
hasExternalInAppProducts boolean Indica si la aplicación permite a los usuarios realizar compras fuera del sistema de comercio de Microsoft Store. Para obtener más información, consulte Declaraciones de aplicaciones.
meetAccessibilityGuidelines boolean Indica si la aplicación se ha probado para cumplir las directrices de accesibilidad. Para obtener más información, consulte Declaraciones de aplicaciones.
notesForCertification string Contiene notas para la certificación de la aplicación.
status string El estado del envío. Este puede ser uno de los siguientes valores:
  • None
  • Canceled
  • PendingCommit
  • CommitStarted
  • CommitFailed
  • PendingPublication
  • Publicación
  • Publicado
  • PublishFailed
  • PreProcessing
  • PreProcessingFailed
  • Certificación
  • CertificationFailed
  • Versión
  • ReleaseFailed
statusDetails objeto Un recurso de detalles de estado que contiene detalles adicionales sobre el estado del envío, incluida información sobre cualquier error.
fileUploadUrl string El URI de firma de acceso compartido (SAS) para cargar cualquier paquete para el envío. Si va a agregar nuevos paquetes, enumerar imágenes o archivos finalizadores para el envío, cargue el archivo ZIP que contiene los paquetes e imágenes en este URI. Para obtener más información, consulte Creación de un envío de aplicación.
applicationPackages array Matriz de recursos del paquete de aplicación que proporcionan detalles sobre cada paquete del envío.
packageDeliveryOptions objeto Un recurso de opciones de entrega de paquetes que contiene la implementación gradual de paquetes y la configuración de actualización obligatoria para el envío.
enterpriseLicensing string Uno de los valores de licencia de empresa que indican el comportamiento de las licencias empresariales para la aplicación.
allowMicrosoftDecideAppAvailabilityToFutureDeviceFamilies boolean Indica si Microsoft puede hacer que la aplicación esté disponible para futuras familias de dispositivos windows 10 y Windows 11.
allowTargetFutureDeviceFamilies objeto Un diccionario de pares clave y valor, donde cada clave es una familia de dispositivos Windows 10 y Windows 11 y cada valor es un valor booleano que indica si la aplicación puede tener como destino la familia de dispositivos especificada.
friendlyName string El nombre descriptivo del envío, tal como se muestra en el Centro de partners. Este valor se genera para usted cuando crea el envío.
remolques array Matriz que contiene hasta 15 recursos de finalizador que representan finalizadores de vídeo para la lista de aplicaciones.

Recurso de precios

Este recurso contiene información de precios para la aplicación. Este recurso tiene los siguientes valores.

Valor Tipo Descripción
trialPeriod string Cadena que especifica el período de prueba de la aplicación. Este puede ser uno de los siguientes valores:
  • NoFreeTrial
  • OneDay
  • TrialNeverExpires
  • SevenDays
  • Quince Días
  • Treinta días
marketSpecificPricings objeto Un diccionario de pares de clave y valor, donde cada clave es un código de país ISO 3166-1 alfa-2 de dos letras y cada valor es un nivel de precios. Estos elementos representan los precios personalizados de la aplicación en mercados específicos. Cualquier elemento de este diccionario anula el precio base especificado por el valor priceId para el mercado especificado.
sales (ventas) array Obsoleto. Matriz de recursos de venta que contienen información de ventas para la aplicación.
priceId string Un plan de tarifa que especifica el precio base de la aplicación.
isAdvancedPricingModel boolean Si es true, su cuenta de desarrollador tiene acceso al conjunto ampliado de niveles de precios de 0,99 USD a 1999,99 USD. Si es false, su cuenta de desarrollador tiene acceso al conjunto original de niveles de precios de 0,99 USD a 999,99 USD. Para obtener más información sobre los diferentes niveles, consulte niveles de precios

Nota Este campo es de sólo lectura.

Recurso de venta

Estos recursos contienen información de venta para una aplicación.

Importante

El recurso Sale ya no se admite y actualmente no puede obtener ni modificar los datos de venta de un envío de aplicación mediante la API de envío de Microsoft Store. En el futuro, actualizaremos la API de envío de Microsoft Store para introducir una nueva manera de acceder mediante programación a la información de ventas para envíos de aplicaciones.

  • Después de llamar al método GET para obtener un envío de aplicación, el valor de ventas estará vacío. Puedes seguir usando el Centro de partners para obtener los datos de venta del envío de la aplicación.
  • Al llamar al método PUT para actualizar un envío de aplicación, se omite la información del valor de ventas . Puedes seguir usando el Centro de partners para cambiar los datos de venta del envío de la aplicación.

Este recurso tiene los siguientes valores.

Valor Tipo Descripción
name string El nombre de la venta.
basePriceId string El nivel de precios que se utilizará para el precio base de la venta.
startDate string La fecha de inicio de la venta en formato ISO 8601.
endDate string La fecha de finalización de la venta en formato ISO 8601.
marketSpecificPricings objeto Un diccionario de pares de clave y valor, donde cada clave es un código de país ISO 3166-1 alfa-2 de dos letras y cada valor es un nivel de precios. Estos elementos representan los precios personalizados de la aplicación en mercados específicos. Cualquier elemento de este diccionario anula el precio base especificado por el valor basePriceId para el mercado especificado.

Recurso de listado

Este recurso contiene información de descripción de una aplicación. Este recurso tiene los siguientes valores.

Valor Tipo Descripción
baseListing objeto La información de lista base de la aplicación, que define la información de descripción predeterminada para todas las plataformas.
platformOverrides objeto Diccionario de pares clave y valor, donde cada clave es una cadena que identifica una plataforma para la que se invalida la información de la descripción, y cada valor es un recurso de lista base (que contiene solo los valores de descripción a título) que especifica la información de descripción que se va a invalidar para la plataforma especificada. Las claves pueden tener los siguientes valores:
  • Unknown
  • Windows80
  • Windows81
  • WindowsPhone71
  • WindowsPhone80
  • WindowsPhone81

Recurso de lista base

Este recurso contiene información de lista base para una aplicación. Este recurso tiene los siguientes valores.

Valor Tipo Descripción
copyrightAndTrademarkInfo string Información opcional sobre derechos de autor o marca comercial.
palabras clave array Matriz de palabra clave para ayudar a la aplicación a aparecer en los resultados de la búsqueda.
licenseTerms string Los términos de licencia opcionales de la aplicación.
privacyPolicy string Este valor está obsoleto. Para establecer o cambiar la dirección URL de la directiva de privacidad de la aplicación, debe hacerlo en la página Propiedades del Centro de partners. Puede omitir este valor de las llamadas a la API de envío. Si establece este valor, se omitirá.
supportContact string Este valor está obsoleto. Para establecer o cambiar la dirección de correo electrónico o la dirección de correo electrónico de contacto de soporte técnico de la aplicación, debe hacerlo en la página Propiedades del Centro de partners. Puede omitir este valor de las llamadas a la API de envío. Si establece este valor, se omitirá.
websiteUrl string Este valor está obsoleto. Para establecer o cambiar la dirección URL de la página web de la aplicación, debe hacerlo en la página Propiedades del Centro de partners. Puede omitir este valor de las llamadas a la API de envío. Si establece este valor, se omitirá.
descripción string Descripción de la lista de aplicaciones.
Características array Matriz de hasta 20 cadenas que enumeran las características de la aplicación.
releaseNotes string Notas de la versión de la aplicación.
images array Matriz de recursos de imagen e icono para la lista de aplicaciones.
recommendedHardware array Matriz de hasta 11 cadenas que enumeran las configuraciones de hardware recomendadas para la aplicación.
minimumHardware string Matriz de hasta 11 cadenas que enumeran las configuraciones de hardware mínimas de la aplicación.
title string Título de la lista de aplicaciones.
shortDescription string Solo se usa para juegos. Esta descripción aparece en la sección Información del Centro de juegos en Xbox One y ayuda a los clientes a comprender más sobre tu juego.
shortTitle string Una versión más corta del nombre del producto. Si se proporciona, este nombre más corto puede aparecer en varios lugares en Xbox One (durante la instalación, en Logros, etc.) en lugar del título completo de su producto.
sortTitle string Si el producto podría estar alfabético de diferentes maneras, puede escribir otra versión aquí. Esto puede ayudar a los clientes a encontrar el producto más rápidamente al buscar.
voiceTitle string Un nombre alternativo para el producto que, si se proporciona, se puede utilizar en la experiencia de audio en Xbox One cuando se utiliza Kinect o un auricular.
devStudio string Especifique este valor si desea incluir un campo Desarrollado por en la lista. (El Publicado por campo mostrará el nombre para mostrar del publicador asociado a su cuenta, independientemente de si proporciona o no un valor de devStudio ).

Recurso de imagen

Este recurso contiene datos de imagen e icono para una lista de aplicaciones. Para obtener más información sobre las imágenes e iconos de una lista de aplicaciones, consulta Capturas de pantalla e imágenes de la aplicación. Este recurso tiene los siguientes valores.

Valor Tipo Descripción
fileName string Nombre del archivo de imagen en el archivo ZIP que cargó para el envío.
fileStatus string Estado del archivo de imagen. Este puede ser uno de los siguientes valores:
  • None
  • PendingUpload
  • Cargado
  • PendingDelete
id string Identificador de la imagen. Este valor lo proporciona el Centro de partners.
descripción string Descripción de la imagen.
imageType string Indica el tipo de la imagen. Actualmente se admiten las siguientes cadenas.

Imágenes de captura de pantalla:

  • Captura de pantalla (use este valor para la captura de pantalla de escritorio)
  • MobileScreenshot
  • XboxScreenshot
  • SurfaceHubScreenshot
  • HoloLensScreenshot

Logotipos de la tienda:

  • StoreLogo9x16
  • StoreLogoSquare
  • Icono (use este valor para el logotipo de 1:1 300 x 300 píxeles)

Imágenes promocionales:

  • PromotionalArt16x9
  • PromotionalArtwork2400X1200

Imágenes de Xbox:

  • XboxBrandedKeyArt
  • XboxTitledHeroArt
  • XboxFeaturedPromotionalArt

Imágenes promocionales opcionales:

  • SquareIcon358X358
  • BackgroundImage1000X800
  • PromotionalArtwork414X180

Recurso de opciones de juegos

Este recurso contiene la configuración relacionada con el juego para la aplicación. Los valores de este recurso corresponden a la configuración del juego para envíos en el Centro de partners.

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

Este recurso tiene los siguientes valores.

Valor Tipo Descripción
géneros array Matriz de una o varias de las siguientes cadenas que describen los géneros del juego:
  • 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 Indica si el juego admite multijugador local.
isLocalCooperative boolean Indica si el juego admite la cooperación local.
isOnlineMultiplayer boolean Indica si el juego admite multijugador en línea.
isOnlineCooperative boolean Indica si el juego admite la cooperación en línea.
localMultiplayerMinPlayers int Especifica el número mínimo de jugadores que admite el juego para multijugador local.
localMultiplayerMaxPlayers int Especifica el número máximo de jugadores que admite el juego para multijugador local.
localCooperativeMinPlayers int Especifica el número mínimo de jugadores que admite el juego para la cooperación local.
localCooperativeMaxPlayers int Especifica el número máximo de jugadores que admite el juego para la cooperación local.
isBroadcastingPrivilegeGranted boolean Indica si el juego admite la difusión.
isCrossPlayEnabled boolean Indica si el juego admite sesiones multijugador entre jugadores en equipos Con Windows 10 y Windows 11 y Xbox.
kinectDataForExternal string Uno de los siguientes valores de cadena que indica si el juego puede recopilar datos de Kinect y enviarlos a servicios externos:
  • NotSet
  • Unknown
  • habilitado
  • Disabled

Nota:

El recurso gamingOptions se agregó en mayo de 2017, después de que la API de envío de Microsoft Store se lanzara por primera vez a los desarrolladores. Si creó un envío para una aplicación a través de la API de envío antes de que se introdujo este recurso y este envío todavía está en curso, este recurso será nulo para los envíos de la aplicación hasta que confirme correctamente el envío o lo elimine. Si el recurso gamingOptions no está disponible para envíos para una aplicación, el campo hasAdvancedListingPermission del recurso Application devuelto por el método get an app es false.

Recurso de detalles de estado

Este recurso contiene detalles adicionales sobre el estado de un envío. Este recurso tiene los siguientes valores.

Valor Tipo Descripción
errors objeto Una matriz de recurso de detalles de estado que contiene los detalles de error para el envío.
advertencias objeto Una matriz de recurso de detalles de estado que contiene los detalles de advertencia para el envío.
certificationReports objeto Una matriz de recursos de informe de certificación que proporciona acceso a los datos del informe de certificación para el envío. Puede examinar estos informes para obtener más información si la certificación falla.

Recurso de detalle de estado

Este recurso contiene información adicional sobre cualquier error relacionado o advertencias para un envío. Este recurso tiene los siguientes valores.

Valor Tipo Descripción
código string Un código de estado de envío que describe el tipo de error o advertencia.
detalles string Un mensaje con más detalle sobre el problema.

Recurso del paquete de aplicación

Este recurso contiene detalles sobre un paquete de aplicación para el envío.

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

Este recurso tiene los siguientes valores.

Nota:

Al llamar al método de envío de la actualización de una aplicación, solo se requieren los valores fileName, fileStatus, minimumDirectXVersion y minimumSystemRam de este objeto en el cuerpo de la solicitud. Los demás valores se rellenan mediante el Centro de partners.

Valor Tipo Descripción
fileName string Nombre del paquete.
fileStatus string Estado del paquete. Este puede ser uno de los siguientes valores:
  • None
  • PendingUpload
  • Cargado
  • PendingDelete
id string Identificador que identifica de forma única el paquete. El Centro de partners proporciona este valor.
version string Versión del paquete de la aplicación. Para obtener más información, consulte Numeración de versiones del paquete.
Arquitectura string Arquitectura del paquete (por ejemplo, ARM).
languages array Matriz de códigos de idioma para los idiomas que admite la aplicación. Para obtener más información, consulte Idiomas admitidos.
capabilities array Matriz de funcionalidades requeridas por el paquete. Para obtener más información sobre las funcionalidades, consulte Declaraciones de funcionalidad de la aplicación.
minimumDirectXVersion string Versión mínima de DirectX compatible con el paquete de la aplicación. Esto solo se puede establecer para aplicaciones destinadas a Windows 8.x. En el caso de las aplicaciones que tienen como destino otras versiones del sistema operativo, este valor debe estar presente al llamar al método de envío de la actualización de una aplicación, pero se omite el valor especificado. Este puede ser uno de los siguientes valores:
  • None
  • DirectX93
  • DirectX100
minimumSystemRam string Ram mínima que requiere el paquete de la aplicación. Esto solo se puede establecer para aplicaciones destinadas a Windows 8.x. En el caso de las aplicaciones que tienen como destino otras versiones del sistema operativo, este valor debe estar presente al llamar al método de envío de la actualización de una aplicación, pero se omite el valor especificado. Este puede ser uno de los siguientes valores:
  • None
  • Memory2GB
targetDeviceFamilies array Matriz de cadenas que representan las familias de dispositivos a las que se dirige el paquete. Este valor solo se usa para paquetes destinados a Windows 10; para los paquetes que tienen como destino versiones anteriores, este valor tiene el valor None. Actualmente se admiten las siguientes cadenas de familia de dispositivos para paquetes de Windows 10 y Windows 11, donde {0} es una cadena de versión de Windows 10 o Windows 11, como 10.0.10240.0, 10.0.10586.0 o 10.0.14393.0:
  • Versión mínima de Windows.Universal {0}
  • Versión mínima de Windows.Desktop {0}
  • Versión mínima de Windows.Mobile {0}
  • Versión mínima de Windows.Xbox {0}
  • Versión mínima de Windows.Holographic {0}

id="certification-report-resource"

Recurso de informe de certificación

Este recurso proporciona acceso a los datos del informe de certificación para un envío. Este recurso tiene los siguientes valores.

Valor Tipo Descripción
date string La fecha y hora en que se generó el informe en formato ISO 8601.
reportUrl string La URL en la que puede acceder al informe.

Recurso de opciones de entrega de paquetes

Este recurso contiene la implementación gradual de paquetes y la configuración de actualización obligatoria para el envío.

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

Este recurso tiene los siguientes valores.

Valor Tipo Descripción
packageRollout objeto Un recurso de lanzamiento de paquetes que contiene la configuración gradual del lanzamiento de paquetes para el envío.
isMandatoryUpdate boolean Indica si desea tratar los paquetes de este envío como obligatorios para las actualizaciones de aplicaciones autoinstalados. Para obtener más información sobre los paquetes obligatorios para las actualizaciones de aplicaciones autoinstalados, consulta Descargar e instalar actualizaciones de paquetes para la aplicación.
mandatoryUpdateEffectiveDate date Fecha y hora en que los paquetes de este envío son obligatorios, en formato ISO 8601 y zona horaria UTC.

Recurso de lanzamiento de paquetes

Este recurso contiene la configuración de lanzamiento gradual de paquetes para el envío. Este recurso tiene los siguientes valores.

Valor Tipo Descripción
isPackageRollout boolean Indica si la implementación gradual de paquetes está habilitada para el envío.
packageRolloutPercentage flotante Porcentaje de usuarios que recibirán los paquetes en el lanzamiento gradual.
packageRolloutStatus string Una de las siguientes cadenas que indica el estado del lanzamiento gradual de paquetes:
  • PackageRolloutNotStarted
  • PackageRolloutInProgress
  • PackageRolloutComplete
  • PackageRolloutStopped
fallbackSubmissionId string Identificador del envío que recibirán los clientes que no obtengan los paquetes de lanzamiento gradual.

Nota:

El desarrollador asigna los valores packageRolloutStatus y fallbackSubmissionId y no está pensado para que lo establezca el desarrollador. Si incluye estos valores en un cuerpo de la solicitud, se omitirán estos valores.

Recurso Trailers

Este recurso representa un finalizador de vídeo para la descripción de la aplicación. Los valores de este recurso corresponden a las opciones de finalizadores para envíos en el Centro de partners.

Puede agregar hasta 15 recursos de finalizador a la matriz de finalizadores en un recurso de envío de aplicación. Para cargar archivos de vídeo finalizador e imágenes en miniatura para un envío, agregue estos archivos al mismo archivo ZIP que contiene los paquetes y las imágenes de descripción del envío y, a continuación, cargue este archivo ZIP en el URI de firma de acceso compartido (SAS) para el envío. Para obtener más información sobre cómo cargar el archivo ZIP en el URI de SAS, consulte Creación de un envío de aplicación.

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

Este recurso tiene los siguientes valores.

Valor Tipo Descripción
id string Identificador del tráiler. El Centro de partners proporciona este valor.
videoFileName string Nombre del archivo de vídeo finalizador en el archivo ZIP que contiene archivos para el envío.
videoFileId string Identificador del archivo de vídeo finalizador. El Centro de partners proporciona este valor.
trailerAssets objeto Diccionario de pares clave y valor, donde cada clave es un código de idioma y cada valor es un recurso de recursos de finalizador que contiene recursos específicos de la configuración regional adicionales para el finalizador. Para obtener más información sobre los códigos de idioma admitidos, vea Idiomas admitidos.

Nota:

El recurso trailers se agregó en mayo de 2017, después de que la API de envío de Microsoft Store se lanzó por primera vez a los desarrolladores. Si creó un envío para una aplicación a través de la API de envío antes de que se introdujo este recurso y este envío todavía está en curso, este recurso será nulo para los envíos de la aplicación hasta que confirme correctamente el envío o lo elimine. Si el recurso trailers no está disponible para envíos para una aplicación, el campo hasAdvancedListingPermission del recurso Application devuelto por el método get an app es false.

Recurso de recursos de tráiler

Este recurso contiene recursos adicionales específicos de la configuración regional para un finalizador que se define en un recurso de finalizador. Este recurso tiene los siguientes valores.

Valor Tipo Descripción
nombre string Título localizado del tráiler. El título se muestra cuando el usuario reproduce el finalizador en modo de pantalla completa.
imageList array Matriz que contiene un recurso de imagen que proporciona la imagen en miniatura del finalizador. Solo puede incluir un recurso de imagen en esta matriz.

Recurso de imagen (para un finalizador)

Este recurso describe la imagen en miniatura de un finalizador. Este recurso tiene los siguientes valores.

Valor Tipo Descripción
fileName string Nombre del archivo de imagen en miniatura en el archivo ZIP que cargó para el envío.
id string Identificador de la imagen en miniatura. El Centro de partners proporciona este valor.
descripción string Descripción de la imagen en miniatura. Este valor es solo metadatos y no se muestra a los usuarios.

Enumeraciones

Estos métodos utilizan las siguientes enumeraciones.

Franjas de precio

Los siguientes valores representan los planes de tarifa disponibles en el recurso de recursos de precios para un envío de aplicación.

Valor Descripción
Base El plan de tarifa no está establecido; use el precio base de la aplicación.
NotAvailable La aplicación no está disponible en la región especificada.
Gratuito La aplicación es gratuita.
Nivelxxx Cadena que especifica el plan de tarifa de la aplicación, con el formato tier xxxx. Actualmente, se admiten los siguientes rangos de niveles de precios:

  • Si el valor isAdvancedPricingModel del recurso de precios es true, los valores del nivel de precios disponibles para su cuenta son Tier1012 - Tier1424.
  • Si el valor isAdvancedPricingModel del recurso de precios es false, los valores del nivel de precios disponibles para su cuenta son Tier2 - Tier96.
Para ver la tabla completa de niveles de precios que están disponibles para su cuenta de desarrollador, incluidos los precios específicos del mercado asociados con cada nivel, vaya a la página de precios y disponibilidad para cualquiera de los envíos de su aplicación en el Centro de partners y haga clic en el vínculo ver tabla en la sección Mercados y precios personalizados (para algunas cuentas de desarrollador, este enlace se encuentra en la sección Precios).

Valores de licencias empresariales

Los valores siguientes representan el comportamiento de licencias de la organización para la aplicación. Para obtener más información sobre estas opciones, consulte Opciones de licencias de la organización.

Nota:

Aunque puede configurar las opciones de licencia de la organización para un envío de aplicación a través de la API de envío, no puede usar esta API para publicar envíos para las compras por volumen a través de los Microsoft Store para Empresas y Microsoft Store para Educación. Para publicar envíos al Microsoft Store para Empresas y Microsoft Store para Educación, debe usar el Centro de partners.

Valor Descripción
None No hagas que tu aplicación esté disponible para empresas con licencias por volumen administradas por la Tienda (en línea).
En línea Haga que la aplicación esté disponible para empresas con licencias por volumen administradas por la Tienda (en línea).
OnlineAndOffline Haga que la aplicación esté disponible para empresas con licencias por volumen administradas por la Tienda (en línea) y haga que la aplicación esté disponible para las empresas a través de licencias desconectadas (sin conexión).

Código de estado de envío

Los valores siguientes representan el código de estado de un envío.

Valor Descripción
None No se ha especificado ningún código.
InvalidArchive El archivo ZIP que contiene el paquete no es válido o tiene un formato de archivo desconocido.
MissingFiles El archivo ZIP no tiene todos los archivos que figuran en los datos de envío o están en la ubicación incorrecta del archivo.
PackageValidationFailed Uno o más paquetes de su envío no se pudieron validar.
InvalidParameterValue Uno de los parámetros del cuerpo de la solicitud no es válido.
InvalidOperation La operación que intentó no es válida.
InvalidState La operación que intentó no es válida para el estado actual de la versión piloto del paquete.
ResourceNotFound No se pudo encontrar la versión piloto del paquete especificado.
ServiceError Un error de servicio interno impidió que la solicitud se realizara correctamente. Inténtelo de nuevo.
ListingOptOutWarning El desarrollador eliminó un listado de un envío anterior o no incluyó información de listado compatible con el paquete.
ListingOptInWarning El desarrollador agregó un listado.
UpdateOnlyWarning El desarrollador está intentando insertar algo que sólo admite actualizaciones.
Otros El envío se encuentra en un estado no reconocido o sin clasificar.
PackageValidationWarning El proceso de validación del paquete generó una advertencia.