Compartilhar via

Envolver os clientes com o Microsoft Store Services SDK

  • Artigo

O SDK de Serviços da Microsoft Store fornece recursos que ajudam você a interagir com os clientes em seus aplicativos da Plataforma Universal do Windows (UWP), como enviar notificações direcionadas para seus aplicativos e executar experimentos A/B em seus aplicativos. Este SDK é uma extensão para Visual Studio 2015 e versões posteriores do Visual Studio.

Observação

Para exibir anúncios em seus aplicativos UWP, use o SDK do Microsoft Advertising em vez do SDK de Serviços da Microsoft Store. As bibliotecas de publicidade foram movidas do SDK de Serviços da Microsoft Store para o SDK do Microsoft Advertising. Para obter mais informações, consulte Anúncios gráficos em seu aplicativo.

Cenários compatíveis com o SDK de Serviços da Microsoft Store

Atualmente, o SDK de Serviços da Microsoft Store dá suporte aos seguintes cenários para aplicativos UWP. Para obter a documentação de referência da API, consulte Referência da API do SDK dos Serviços da Microsoft Store.

Cenário Descrição
Executar experimentos em seu aplicativo UWP com testes A/B Execute testes A/B em seu aplicativo UWP (Plataforma Universal do Windows) para medir a eficácia dos recursos em alguns clientes antes de liberar os recursos para todos. Depois de definir um experimento no Partner Center, use a classe StoreServicesExperimentVariation para obter variações para seu experimento em seu aplicativo, use esses dados para modificar o comportamento do recurso que você está testando e, em seguida, use o método LogForVariation para enviar eventos de exibição e eventos de conversão para o Partner Center. Por fim, use o Partner Center para exibir os resultados e gerenciar o experimento.
Iniciar o Hub de Feedback do seu aplicativo UWP Use a classe StoreServicesFeedbackLauncher em seu aplicativo UWP para direcionar seus clientes do Windows 10 e Windows 11 para o Hub de Feedback, onde eles podem enviar problemas, sugestões e votos positivos. Em seguida, gerencie esses comentários em Relatório de comentários no Partner Center.
Configurar seu aplicativo UWP para receber notificações por push do Partner Center Use a classe StoreServicesEngagementManager em seu aplicativo UWP para registrar seu aplicativo para receber notificações por push direcionadas que você envia aos seus clientes usando o Partner Center.
Registrar eventos personalizados em seu aplicativo UWP para o relatório de uso no Partner Center Use a classe StoreServicesCustomEventLogger em seu aplicativo UWP para registrar eventos personalizados associados ao seu aplicativo no Partner Center. Em seguida, examine o total de ocorrências de seus eventos personalizados na seção Eventos personalizados do relatório de uso no Partner Center.

Pré-requisitos

O SDK de Serviços da Microsoft Store requer:

  • Visual Studio 2015 ou uma versão posterior.
  • Ferramentas do Visual Studio para Aplicativos Universais do Windows instaladas com sua versão do Visual Studio.

Instalar o SDK

Há duas opções para instalar o SDK de Serviços da Microsoft Store em seu computador de desenvolvimento:

  • Instalador MSI Você pode instalar o SDK por meio do instalador MSI disponível aqui.
  • Pacote NuGet Você pode instalar o SDK como um pacote NuGet.

A Microsoft lança periodicamente novas versões do SDK de Serviços da Microsoft Store com melhorias de desempenho e novos recursos. Se você tiver projetos existentes que usam o SDK e quiser usar a versão mais recente, baixe e instale a versão mais recente do SDK em seu computador de desenvolvimento.

Instalar via MSI

Para instalar o SDK de Serviços da Microsoft Store por meio do instalador MSI:

  1. Feche todas as instâncias do Visual Studio.

  2. Se você instalou anteriormente o SDK de Engajamento e Monetização da Microsoft Store, o SDK do Universal Ad Client ou a extensão do Ad Mediador, desinstale esses SDKs agora. Opcionalmente, abra uma janela do Prompt de Comando e execute estes comandos para limpar todas as versões mais antigas do SDK que podem ter sido instaladas com o Visual Studio, mas que podem não aparecer na lista de programas instalados em seu computador:

    MsiExec.exe /x{5C87A4DB-31C7-465E-9356-71B485B69EC8}
MsiExec.exe /x{6AB13C21-C3EC-46E1-8009-6FD5EBEE515B}
MsiExec.exe /x{6AC81125-8485-463D-9352-3F35A2508C11}

  3. Baixe e instale o SDK de Serviços da Microsoft Store. Pode levar alguns minutos para instalar. Certifique-se e espere até que o processo seja concluído.

  4. Reinicie o Visual Studio.

  5. Se você tiver um projeto existente que faça referência a bibliotecas de qualquer versão anterior do SDK de Serviços da Microsoft Store, SDK do Microsoft Advertising, SDK do Universal Ad Client ou SDK de Engajamento e Monetização da Microsoft Store, recomendamos que você abra seu projeto no Visual Studio e limpe e recompile seu projeto (no Gerenciador de Soluções, clique com o botão direito do mouse no nó do projeto e escolha Limpar, e, em seguida, clique com o botão direito do mouse no nó do projeto novamente e escolha Reconstruir).

Caso contrário, se você estiver usando o SDK pela primeira vez em seu projeto, agora estará pronto para adicionar a referência de assembly ao seu projeto.

Instalar por meio do NuGet

Para instalar as bibliotecas do SDK de Serviços da Microsoft Store por meio do NuGet:

  1. Feche todas as instâncias do Visual Studio.

  2. Se você instalou anteriormente o SDK de Engajamento e Monetização da Microsoft Store, o SDK do Universal Ad Client ou a extensão do Ad Mediador, desinstale esses SDKs agora. Opcionalmente, abra uma janela do Prompt de Comando e execute estes comandos para limpar todas as versões mais antigas do SDK que podem ter sido instaladas com o Visual Studio, mas que podem não aparecer na lista de programas instalados em seu computador:

    MsiExec.exe /x{5C87A4DB-31C7-465E-9356-71B485B69EC8}
MsiExec.exe /x{6AB13C21-C3EC-46E1-8009-6FD5EBEE515B}
MsiExec.exe /x{6AC81125-8485-463D-9352-3F35A2508C11}

  3. Inicie o Visual Studio e abra o projeto no qual você deseja usar o SDK de Serviços da Microsoft Store.

    Observação

    Se o projeto já incluir referências de biblioteca de uma instalação MSI anterior do SDK, remova essas referências do projeto. Essas referências terão ícones de aviso ao lado delas porque as bibliotecas às quais elas fazem referência foram removidas nas etapas anteriores.

  4. No Visual Studio, clique em Projetar e Gerenciar Pacotes NuGet.

  5. Na caixa de pesquisa, digite Microsoft.Services.Store.Engagement e instale o pacote Microsoft.Services.Store.Engagement. Quando a instalação do pacote terminar, salve sua solução.

    Observação

    Se a janela Saída relatar um erro Install-Package que indica que o caminho especificado é muito longo, talvez seja necessário configurar o NuGet para extrair pacotes para um local alternativo com um caminho mais curto do que o local padrão. Para fazer isso, adicione o repositoryPath valor a um arquivo nuget.config em seu computador e atribua-o a um caminho de pasta curto em que os pacotes NuGet podem ser extraídos. Para obter mais informações, consulte este artigo na documentação do NuGet. Como alternativa, você pode tentar mover seu projeto do Visual Studio para uma pasta alternativa com um caminho mais curto. O problema também pode ser causado pelo caminho dos pacotes globais ser muito longo. Nesse caso, adicione o globalPackagesFolder valor ao arquivo nuget.config.

  6. Feche a solução do Visual Studio que contém seu projeto e reabra a solução.

  7. Se o projeto já faz referência a bibliotecas de uma versão anterior do SDK de Serviços da Microsoft Store que foi instalado por meio do NuGet e você atualizou seu projeto para uma versão mais recente do SDK, recomendamos que você limpe e recompile seu projeto (no Gerenciador de Soluções, clique com o botão direito do mouse no nó do projeto e escolha Limpar e, em seguida, clique com o botão direito do mouse no nó do projeto novamente e escolha Recompilar).

Caso contrário, se você estiver usando o SDK pela primeira vez em seu projeto, agora estará pronto para adicionar a referência de assembly ao seu projeto.

Adicionar a referência de assembly ao seu projeto

Depois de instalar o SDK de Serviços da Microsoft Store por meio do instalador MSI ou do NuGet, siga estas instruções para fazer referência ao assembly do SDK em seu projeto UWP.

  1. Abra o projeto no Visual Studio.

    Observação

    Se o projeto for um aplicativo JavaScript direcionado a qualquer CPU, atualize seu projeto para usar uma saída de build específica da arquitetura (por exemplo, x86).

  2. No Gerenciador de Soluções, clique com o botão direito do mouse em Referências e selecione Adicionar Referência...

  3. No Gerenciador de Referências, expanda Universal do Windows, clique em Extensões e marque a caixa de seleção ao lado de Microsoft Engagement Framework. Isso permite que você use as APIs no namespace Microsoft.Services.Store.Engagement .

  4. Clique em OK.

Observação

Se você instalou as bibliotecas do SDK por meio do NuGet, seu projeto conterá uma referência Microsoft.Services.Store.Engagement . A referência Microsoft.Services.Store.Engagement representa o pacote NuGet (em vez das bibliotecas nele) e você pode ignorá-lo.

Noções básicas sobre pacotes de estrutura no SDK

A biblioteca Microsoft.Services.Store.Engagement.dll no SDK de Serviços da Microsoft Store é configurada como um pacote de estrutura. Essa biblioteca contém as APIs no namespace Microsoft.Services.Store.Engagement .

Como essa biblioteca é um pacote de estrutura, isso significa que, depois que um usuário instala uma versão do seu aplicativo que usa essa biblioteca, essa biblioteca é atualizada automaticamente em seu dispositivo por meio do Windows Update sempre que publicamos uma nova versão da biblioteca com correções e melhorias de desempenho. Isso ajuda a garantir que seus clientes sempre tenham a versão mais recente disponível da biblioteca instalada em seus dispositivos.

Se lançarmos uma nova versão do SDK que introduza novas APIs ou recursos nessa biblioteca, você precisará instalar a versão mais recente do SDK para usar esses recursos. Nesse cenário, você também precisaria publicar seu aplicativo atualizado na Loja.