Atualizar um envio de aplicativo

  • Artigo

Use este método na API de envio da Microsoft Store para atualizar um envio de aplicativo existente. Depois de atualizar com êxito um envio usando esse método, você deverá confirmar o envio para ingestão e publicação.

Para obter mais informações sobre como esse método se adapta ao processo de criação de um envio de app, usando a API de envio da Microsoft Store, consulte Gerenciar envios de aplicativo.

Pré-requisitos

Para usar este método, primeiro você precisa do seguinte:

  • Se você não tiver feito isso, conclua todos os pré-requisitos para a API de envio da Microsoft Store.
  • Obtenha um token de acesso do Azure AD a ser usado no cabeçalho da solicitação para este método. Após obter um token de acesso, você tem 60 minutos para usá-lo antes dele expirar. Depois que o token expirar, você poderá obter um novo.
  • Crie um envio para um de seus aplicativos. Você pode fazer isso no Partner Center ou pode fazer isso usando o método criar um envio de aplicativo .

Solicitação

Esse método tem a seguinte sintaxe. Veja as seções a seguir para obter exemplos de uso e descrições do corpo da solicitação e do cabeçalho.

Método URI da solicitação
PUT https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}

Cabeçalho da solicitação

parâmetro Tipo Descrição
Autorização string Obrigatórios. O token de acesso Azure AD notoken> de portador< de formulário.

Parâmetros da solicitação

Nome Type Descrição
applicationId string Obrigatórios. A ID da Loja do aplicativo para o qual você deseja atualizar um envio. Para saber mais informações sobre a ID da Loja, consulte Exibir detalhes de identidade de aplicativo.
submissionId string Obrigatórios. A ID do envio para atualizar. Esse ID está disponível nos dados de resposta para solicitações para criar um envio de aplicativo. Para um envio criado no Partner Center, essa ID também está disponível na URL da página de envio no Partner Center.

Corpo da solicitação

O corpo da solicitação tem os parâmetros a seguir.

Valor Type Descrição
applicationCategory string Uma cadeia de caracteres que especifica a categoria e/ou subcategoria para o aplicativo. Categorias e subcategorias são combinadas em uma única cadeia de caracteres com o caractere de sublinhado '_', como BooksAndReference_EReader.
preços objeto Um objeto que contém informações de preços do aplicativo. Para saber mais, veja a seção Preços de recurso.
visibility string A visibilidade do aplicativo. Esse valor pode ser um dos seguintes:
  • Hidden
  • Público
  • Privados
  • NotSet
targetPublishMode string O modo de publicação do envio. Esse valor pode ser um dos seguintes:
  • Imediata
  • Manual
  • SpecificDate
targetPublishDate string A data de publicação do envio em formato ISO 8601, se o targetPublishMode estiver definido como SpecificDate.
listings objeto Um dicionário de pares de chave e valor, no qual cada chave é um código de país e cada valor é um objeto recurso de listagem objeto que contém as informações de listagem do aplicativo.
hardwarePreferences array Uma matriz de cadeias de caracteres que definem as preferências de hardware do aplicativo. Esse valor pode ser um dos seguintes:
  • Touch
  • Keyboard
  • Mouse
  • Câmera
  • NfcHce
  • Nfc
  • BluetoothLE
  • Telefonia
automaticBackupEnabled booleano Indica se o Windows pode incluir dados do aplicativo em backups automáticos no OneDrive. Para obter mais informações, consulte Declarações de aplicativo.
canInstallOnRemovableMedia booleano Indica se os clientes podem instalar o aplicativo em armazenamento removível. Para obter mais informações, consulte Declarações de aplicativo.
isGameDvrEnabled booleano Indica se o DVR de jogos está habilitado para o aplicativo.
gamingOptions objeto Uma matriz que contém um recurso de opções de jogo que define as configurações relacionadas a jogos para o app.
hasExternalInAppProducts booleano Indica se o aplicativo permite que os usuários façam compras fora do sistema de comércio da Microsoft Store. Para obter mais informações, consulte Declarações de aplicativo.
meetAccessibilityGuidelines booleano Indica se o aplicativo foi testado para atender às diretrizes de acessibilidade. Para obter mais informações, consulte Declarações de aplicativo.
notesForCertification string Contém observações de certificação do aplicativo.
applicationPackages array Contém objetos que fornecem detalhes sobre cada pacote no envio. Para saber mais, veja a seção Pacote de aplicativos. Durante a chamada desse método para atualizar um envio de aplicativo, somente os valores fileName, fileStatus, minimumDirectXVersion e minimumSystemRam desses objetos são necessários no corpo da solicitação. Os outros valores são preenchidos pelo Partner Center.
packageDeliveryOptions objeto Contém as configurações de distribuição de pacote gradual e de atualização obrigatória para o envio. Para obter mais informações, consulte Objeto de opções de entrega de pacote.
enterpriseLicensing string Um dos valores de licenciamento empresarial que indicam o comportamento de licenciamento empresarial para o aplicativo.
allowMicrosftDecideAppAvailabilityToFutureDeviceFamilies booleano Indica se a Microsoft tem permissão para disponibilizar o aplicativo para futuras famílias de dispositivos Windows 10 e Windows 11.
allowTargetFutureDeviceFamilies booleano Indica se seu aplicativo tem permissão para direcionar futuras famílias de dispositivos Windows 10 e Windows 11.
trailers matriz Uma matriz que contém até recursos de trailer que representam trailers de vídeo para a listagem de apps.

Exemplo de solicitação

O exemplo a seguir demonstra como atualizar um envio de aplicativo.

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

Resposta

O exemplo a seguir demonstra o corpo da resposta JSON para uma chamada bem-sucedida para esse método. O corpo da resposta contém informações sobre o envio atualizado. Para obter mais detalhes sobre os valores no corpo da resposta, veja Recurso do envio de aplicativo.

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

Códigos do Erro

Se não for possível concluir a solicitação, a resposta conterá um dos seguintes códigos de erro HTTP.

Código do erro Descrição
400 O envio não pôde ser atualizado porque a solicitação não é válida.
409 O envio não pôde ser atualizado devido ao estado atual do aplicativo ou o aplicativo usa um recurso do Partner Center que atualmente não é compatível com a API de envio da Microsoft Store.