Obter um envio de complementoGet an add-on submission

Use este método na API de envio da Microsoft Store para obter dados para um envio de complemento (também conhecido como produto no aplicativo ou IAP) existente.Use this method in the Microsoft Store submission API to get data for an existing add-on (also known as in-app product or IAP) submission. Para obter mais informações sobre o 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 the process of 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
OBTERGET 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 que contém o envio que você deseja obter.The Store ID of the add-on that contains the submission you want to get. 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 a ser obtida.The ID of the submission to get. 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

Não forneça um corpo da solicitação para esse método.Do not provide a request body for this method.

Exemplo de solicitaçãoRequest example

O exemplo a seguir demonstra como obter um envio de complemento.The following example demonstrates how to get an add-on submission.

GET https://manage.devcenter.microsoft.com/v1.0/my/inappproducts/9NBLGGH4TNMP/submissions/1152921504621243680 HTTP/1.1
Authorization: Bearer <your access token>

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 especificado.The response body contains information about the specified 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",
    "isAdvancedPricingModel": true
  },
  "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
404404 O envio não foi encontrado.The submission could not be found.
409409 O envio não pertence ao complemento especificado 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 does not belong to the specified add-on, or the add-on uses a Partner Center feature that is currently not supported by the Microsoft Store submission API.