Atualizar um envio de complementoUpdate an add-on submission

Use este método na API de envio da Microsoft Store para atualizar um envio existente do complemento (também conhecido como produto no app ou 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. Depois de atualizar com êxito um envio usando esse método, você deverá confirmar o envio para ingestão e publicação.After you successfully update a submission by using this method, you must commit the submission for ingestion and publishing.

Para obter mais informações sobre como esse método se adapta ao processo de criação de um envio de complemento, usando a API de envio da Microsoft Store, consulte Gerenciar envios de complemento.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.

Pré-requisitosPrerequisites

Para usar este método, primeiro você precisa do seguinte:To use this method, you need to first do the following:

  • Se você não tiver feito isso, conclua todos os pré-requisitos para a API de envio da Microsoft Store.If you have not done so already, complete all the prerequisites for the Microsoft Store submission API.
  • Obtenha um token de acesso do Azure AD a ser usado no cabeçalho da solicitação para este método.Obtain an Azure AD access token to use in the request header for this method. Depois de obter um token de acesso, você terá 60 minutos para usá-lo antes que ele expire.After you obtain an access token, you have 60 minutes to use it before it expires. Depois que o token expirar, você poderá obter um novo.After the token expires, you can obtain a new one.
  • Crie um envio de complemento de um dos seus aplicativos.Create an add-on submission for one of your apps. Você pode fazer isso no Partner Center, ou você pode fazer isso usando o criar um envio de complemento método.You can do this in Partner Center, or you can do this by using the Create an add-on submission method.

SolicitaçãoRequest

Esse método tem a seguinte sintaxe.This method has the following syntax. Veja as seções a seguir para obter exemplos de uso e descrições do corpo da solicitação e do cabeçalho.See the following sections for usage examples and descriptions of the header and request body.

MétodoMethod URI da solicitaçãoRequest URI
PUTPUT https://manage.devcenter.microsoft.com/v1.0/my/inappproducts/{inAppProductId}/submissions/{submissionId}

Cabeçalho da solicitaçãoRequest header

CabeçalhoHeader TipoType DescriçãoDescription
AutorizaçãoAuthorization cadeia de caracteresstring Obrigatório.Required. O token de acesso do AD do Azure no formato portador < token>.The Azure AD access token in the form Bearer <token>.

Parâmetros solicitadosRequest parameters

NomeName TipoType DescriçãoDescription
inAppProductIdinAppProductId cadeia de caracteresstring Obrigatório.Required. A ID da Loja do complemento para o qual você deseja atualizar um envio.The Store ID of the add-on for which you want to update a submission. A ID de Store está disponível no Partner Center e ele é incluído nos dados de resposta para solicitações para criar um complemento ou obter detalhes de complemento.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 cadeia de caracteresstring Obrigatório.Required. A ID do envio para atualizar.The ID of the submission to update. Esse ID está disponível nos dados de resposta para solicitações para criar um envio de complemento.This ID is available in the response data for requests to create an add-on submission. Para um envio que foi criado no Partner Center, essa ID também está disponível na URL para a página de envio no Partner Center.For a submission that was created in Partner Center, this ID is also available in the URL for the submission page in Partner Center.

Corpo da solicitaçãoRequest body

O corpo da solicitação tem os parâmetros a seguir.The request body has the following parameters.

ValorValue TipoType DescriçãoDescription
contentTypecontentType cadeia de caracteresstring O tipo de conteúdo fornecido no complemento.The type of content that is provided in the add-on. Isso pode ter um dos seguintes valores:This can be one of the following values:
  • NotSetNotSet
  • BookDownloadBookDownload
  • EMagazineEMagazine
  • ENewspaperENewspaper
  • MusicDownloadMusicDownload
  • MusicStreamMusicStream
  • OnlineDataStorageOnlineDataStorage
  • VideoDownloadVideoDownload
  • VideoStreamVideoStream
  • AspAsp
  • OnlineDownloadOnlineDownload
keywordskeywords matrizarray Uma matriz de cadeias de caracteres que contenham até 10 palavras-chave do complemento.An array of strings that contain up to 10 keywords for the add-on. O aplicativo pode consultar complementos usando essas palavras-chave.Your app can query for add-ons using these keywords.
lifetimelifetime cadeia de caracteresstring O tempo de vida do complemento.The lifetime of the add-on. Isso pode ter um dos seguintes valores:This can be one of the following values:
  • ForeverForever
  • OneDayOneDay
  • ThreeDaysThreeDays
  • FiveDaysFiveDays
  • OneWeekOneWeek
  • TwoWeeksTwoWeeks
  • OneMonthOneMonth
  • TwoMonthsTwoMonths
  • ThreeMonthsThreeMonths
  • SixMonthsSixMonths
  • OneYearOneYear
listingslistings objetoobject Um objeto que contém as informações de listagem do complemento.An object that contains listing info for the add-on. Para obter mais informações, consulte Recurso de listagem.For more information, see Listing resource.
pricingpricing objetoobject Um objeto que contém as informações de preços do complemento.An object that contains pricing info for the add-on. Para obter mais informações, consulte Recurso de preços.For more information, see Pricing resource.
targetPublishModetargetPublishMode cadeia de caracteresstring O modo de publicação do envio.The publish mode for the submission. Isso pode ter um dos seguintes valores:This can be one of the following values:
  • ImediataImmediate
  • ManualManual
  • SpecificDateSpecificDate
targetPublishDatetargetPublishDate cadeia de caracteresstring A data de publicação do envio em formato ISO 8601, se o targetPublishMode estiver definido como SpecificDate.The publish date for the submission in ISO 8601 format, if the targetPublishMode is set to SpecificDate.
tagtag cadeia de caracteresstring Os dados de desenvolvedor personalizados do complemento (essas informações foram anteriormente chamadas de marca).The custom developer data for the add-on (this information was previously called the tag).
visibilidadevisibility cadeia de caracteresstring A visibilidade do complemento.The visibility of the add-on. Isso pode ter um dos seguintes valores:This can be one of the following values:
  • HiddenHidden
  • PublicPublic
  • PrivatePrivate
  • NotSetNotSet

Exemplo de solicitaçãoRequest example

O exemplo a seguir demonstra como atualizar um envio de complemento.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",
}

RespostaResponse

O exemplo a seguir demonstra o corpo da resposta JSON para uma chamada bem-sucedida para esse método.The following example demonstrates the JSON response body for a successful call to this method. O corpo da resposta contém informações sobre o envio atualizado.The response body contains information about the updated submission. Para obter mais detalhes sobre os valores no corpo da resposta, veja Recurso do envio de complemento.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"
}

Códigos de erroError codes

Se não for possível concluir a solicitação, a resposta conterá um dos seguintes códigos de erro HTTP.If the request cannot be successfully completed, the response will contain one of the following HTTP error codes.

Código de erroError code DescriçãoDescription
400400 O envio não pôde ser atualizado porque a solicitação não é válida.The submission could not be updated because the request is invalid.
409409 O envio de mensagens não pôde ser atualizado devido ao estado atual do complemento, ou o complemento usa um recurso do Partner Center que está atualmente não tem suporte da API de envio a 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.