Partilhar via


Envolva os clientes com o SDK de Serviços da Microsoft Store

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 o envio de notificações direcionadas para seus aplicativos e a execução de experimentos A/B em seus aplicativos. Este SDK é uma extensão para o 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 na sua aplicação.

Cenários suportados pelo SDK de Serviços da Microsoft Store

Atualmente, o SDK de Serviços da Microsoft Store oferece 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
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, revise 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 no computador de desenvolvimento:

  • Instalador MSI Você pode instalar o SDK através 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 do Microsoft Store Engagement and Monetization, o SDK do Universal Ad Client ou a extensão do Ad Mediator, desinstale esses SDKs agora. Opcionalmente, abra uma janela de prompt de comando e execute estes comandos para limpar quaisquer 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 no 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. A instalação pode demorar alguns minutos. Certifique-se e aguarde até que o processo tenha terminado.

  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 reconstrua 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 você está pronto para adicionar a referência de assembly ao seu projeto.

Instalar via NuGet

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

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

  2. Se você instalou anteriormente o SDK do Microsoft Store Engagement and Monetization, o SDK do Universal Ad Client ou a extensão do Ad Mediator, desinstale esses SDKs agora. Opcionalmente, abra uma janela de prompt de comando e execute estes comandos para limpar quaisquer 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 no 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 seu projeto já inclui referências de biblioteca de uma instalação MSI anterior do SDK, remova essas referências do seu projeto. Essas referências terão ícones de aviso ao lado delas porque as bibliotecas às quais fazem referência foram removidas nas etapas anteriores.

  4. No Visual Studio, clique em Projeto 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 estiver concluída, salve sua solução.

    Observação

    Se a janela Saída relatar um erro Install-Package que indique 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 valor repositoryPath a um arquivo nuget.config em seu computador e atribua-o a um caminho de pasta curto onde 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 valor globalPackagesFolder ao seu arquivo nuget.config.

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

  7. Se o seu projeto já faz referência a bibliotecas de uma versão anterior do SDK de Serviços da Microsoft Store que foi instalada via NuGet e você atualizou seu projeto para uma versão mais recente do SDK, recomendamos que você limpe e reconstrua 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 você está pronto para adicionar a referência de assembly ao seu projeto.

Adicionar a referência de assemblagem ao seu projeto

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

  1. Abra seu projeto no Visual Studio.

    Observação

    Se o seu projeto for um aplicativo JavaScript destinado a Qualquer CPU, atualize seu projeto para usar uma saída de compilação 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 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 instalaste as bibliotecas do SDK via NuGet, o teu 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 framework . Esta 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 nesta 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.