Compartilhar via

Atualizar um envio de complemento

  • Artigo

Use esse método na API de envio da Microsoft Store para atualizar um envio de complemento existente (também conhecido como produto no aplicativo ou IAP). Depois de atualizar com êxito um envio usando esse método, você deve confirmar o envio para ingestão e publicação.

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

Pré-requisitos

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

  • Se você ainda 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 esse 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 de complemento para um de seus aplicativos. Você pode fazer isso no Partner Center ou pode fazer isso usando o método Criar um envio de complemento.

Solicitar

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

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

Cabeçalho da solicitação

Cabeçalho Tipo Descrição
Autorização string Obrigatório. O token de acesso do Azure AD no Token<de portador> do formulário.

Parâmetros da solicitação

Nome Tipo Descrição
inAppProductId string Obrigatória. A ID da Loja do complemento para o qual você deseja atualizar um envio. A ID da Loja está disponível no Partner Center e está incluída nos dados de resposta para solicitações para Criar um complemento ou obter detalhes do complemento.
submissionId string Obrigatória. A ID do envio a ser atualizado. Essa ID está disponível nos dados de resposta para solicitações para criar um envio de complemento. 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 seguintes parâmetros.

Valor Type Descrição
contentType string O tipo de conteúdo fornecido no complemento. Esse valor pode ser um dos seguintes:
  • NotSet
  • BookDownload
  • EMagazine
  • ENewspaper
  • MusicDownload
  • MusicStream
  • OnlineDataStorage
  • VideoDownload
  • VideoStream
  • ASP
  • OnlineDownload
palavras-chave matriz Uma matriz de cadeias de caracteres que contém até 10 palavras-chave para o complemento. Seu aplicativo pode consultar complementos usando essas palavras-chave.
lifetime string O tempo de vida do complemento. Esse valor pode ser um dos seguintes:
  • Para sempre
  • OneDay
  • ThreeDays
  • FiveDays
  • OneWeek
  • TwoWeeks
  • OneMonth
  • TwoMonths
  • ThreeMonths
  • SixMonths
  • OneYear
listagens objeto Um objeto que contém informações de listagem para o complemento. Para obter mais informações, consulte Recurso de listagem.
preços objeto Um objeto que contém informações de preços para o complemento. Para obter mais informações, consulte Recurso de preços.
targetPublishMode string O modo de publicação para o envio. Esse valor pode ser um dos seguintes:
  • Imediata
  • Manual
  • SpecificDate
targetPublishDate string A data de publicação para o envio no formato ISO 8601, se o targetPublishMode estiver definido como SpecificDate.
marcação string Os dados personalizados do desenvolvedor para o complemento (essas informações eram anteriormente chamadas de tag).
visibility string A visibilidade do complemento. Esse valor pode ser um dos seguintes:
  • Oculto
  • Setor Público
  • Privados
  • NotSet

Exemplo de solicitação

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

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, consulte Recurso de envio 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 do Erro

Se a solicitação não puder ser concluída com êxito, a resposta conterá um dos seguintes códigos de erro HTTP.

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