Compartilhar via


Atualizar um envio de complemento

Use esse método na API de envio da Microsoft Store para atualizar um 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 esse método, primeiro você precisa fazer o seguinte:

  • Se você ainda não fez isso, conclua todos os pré-requisitos da API de envio da Microsoft Store.
  • Obter um token de acesso do Azure AD a ser usado no cabeçalho de solicitação para esse método. Depois de obter um token de acesso, você terá 60 minutos para usá-lo antes que ele expire. Depois que o token expirar, você poderá obter um novo.
  • Crie uma submissão de complemento para um de seus aplicativos. Você pode fazer isso no Partner Center ou usando o método Criar um envio de complemento.

Solicitação

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

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

Cabeçalho da solicitação

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

Parâmetros de solicitação

Nome Tipo Descrição
ID do Produto In-App corda Obrigatório. O ID da Loja do complemento para o qual você deseja atualizar uma submissão. O ID da Loja está disponível no Partner Center e está incluído nos dados de resposta de solicitações para Criar um complemento ou obter detalhes do complemento.
ID de submissão corda Obrigatório. O ID do envio a ser atualizado. Esse ID está disponível nos dados de resposta de solicitações de criar um envio de complemento. Para um envio criado no Partner Center, essa ID também está disponível na URL para a página de envio no Partner Center.

Corpo da solicitação

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

Valor Tipo Descrição
tipo de conteúdo corda O tipo de conteúdo fornecido no complemento. Esse pode ser um dos seguintes valores:
  • Não definido
  • Download de Livro
  • EMagazine
  • E-Jornal
  • Baixar Música
  • MusicStream
  • OnlineDataStorage
  • Download de Vídeo
  • 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.
duração da vida corda O tempo de vida do complemento. Esse pode ser um dos seguintes valores:
  • Eternamente
  • Um Dia
  • ThreeDays
  • FiveDays
  • OneWeek
  • TwoWeeks
  • UmMês
  • DoisMeses
  • Três Meses
  • SeisMeses
  • UmAno
Listas objeto Um objeto que contém informações de listagem para o complemento. Para obter mais informações, confira Listagem de recursos.
preços objeto Um objeto que contém informações de preço para o complemento. Para saber mais informações, confira Preços do recurso.
modo de publicação alvo corda O modo de publicação da submissão. Esse pode ser um dos seguintes valores:
  • Imediato
  • Manual
  • Data específica
data-alvo de publicação corda A data de publicação para o envio no formato ISO 8601, se o targetPublishMode estiver definido como SpecificDate.
etiqueta corda Os dados personalizados do desenvolvedor para o complemento (essas informações eram anteriormente chamadas de tag).
visibilidade corda A visibilidade do complemento. Esse pode ser um dos seguintes valores:
  • Escondido
  • Público
  • Privado
  • Não definido

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 a submissão atualizada. Para obter mais detalhes sobre os valores no corpo da resposta, consulte o 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 de 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 de erro Descrição
400 O envio não pôde ser atualizado porque a solicitação é inválida.
409 Não foi possível atualizar o envio devido ao estado atual do complemento ou o complemento usa um recurso do Partner Center que atualmente não tem suporte da API de envio da Microsoft Store.