Compartilhar via

Criar uma campanha de promoção de aplicativo personalizado

  • Artigo

Além de criar uma campanha publicitária para seu aplicativo que serão executados em aplicativos do Windows, você também pode promover seu aplicativo usando outros canais. Por exemplo, você pode promover seu aplicativo usando um provedor de marketing de aplicativo de terceiros ou pode postar links para seu aplicativo em sites de mídia social. Essas atividades são chamadas de campanhas personalizadas.

Se você executar campanhas personalizadas para seu aplicativo, poderá acompanhar o desempenho relativo de cada campanha criando uma URL diferente para cada campanha personalizada, em que cada URL contém uma ID de campanha diferente. Quando um cliente que executa o Windows 10 clica em uma URL que contém uma ID de campanha, a Microsoft associa o clique à campanha personalizada correspondente e disponibiliza esses dados para você no Partner Center.

Importante

Esses dados são acompanhados apenas para clientes em dispositivos com Windows 10. Os clientes que usam outros sistemas operacionais ainda podem seguir o link para a listagem do aplicativo, mas os dados sobre as atividades desses clientes não serão incluídos.

Há dois tipos principais de dados associados a campanhas personalizadas: exibições de página, para a página do seu aplicativo na Loja, e conversões. Uma conversão é uma aquisição de aplicativo que resulta de um cliente que visualiza a página do seu aplicativo na Loja a partir de um URL que inclui um ID de campanha personalizada. Para obter mais detalhes sobre conversões, consulte Noções básicas sobre como as aquisições de aplicativos se qualificam como conversões neste tópico.

Você pode recuperar dados personalizados de desempenho de campanha para seu aplicativo das seguintes maneiras:

  • Você pode visualizar dados sobre exibições de página e conversões do seu aplicativo ou complemento nos gráficos Exibições de página e conversões do aplicativo por ID de campanha e Total de conversões da campanha no Relatório de aquisições.
  • Se seu aplicativo for um aplicativo UWP (Plataforma Universal do Windows), você poderá usar APIs no SDK do Windows para recuperar programaticamente a ID da campanha personalizada que resultou em uma conversão.

Exemplo de cenário de campanha personalizado

Considere uma desenvolvedora de jogos que terminou de criar um novo jogo e gostaria de promovê-lo aos jogadores de seus jogos existentes. Ela posta o anúncio do novo lançamento do jogo em sua página no Facebook, incluindo um link para a listagem da Store do jogo. Muitos jogadores também a seguem no Twitter, então ela tweeta um anúncio com o link para a página do jogo na Loja.

Para acompanhar o sucesso de cada um desses canais de promoção, o desenvolvedor cria duas variantes da URL para a listagem da Store do jogo:

  • A URL que ela postará em sua página no Facebook inclui a ID da campanha personalizada my-facebook-campaign

  • A URL que ela postará no Twitter inclui a ID da campanha personalizada my-twitter-campaign

Enquanto seus seguidores do Facebook e do Twitter clicam nas URLs, a Microsoft rastreia cada clique e o associa à campanha personalizada correspondente. Aquisições subsequentes que qualificam o jogo e quaisquer compras adicionais são associadas à campanha personalizada e relatadas como conversões.

Noções básicas sobre como as aquisições se qualificam como conversões

Uma conversão em campanha personalizada refere-se a uma aquisição resultante de um cliente clicando em uma URL promovida por meio de uma campanha personalizada. Há diferentes cenários para qualificar como uma conversão para os gráficos Exibições de página e conversões do aplicativo por ID de campanha e Total de conversões da campanha no Relatório de aquisições, assim como para qualificar como uma conversão a recuperação programática do ID de campanha.

Qualificação das conversões no relatório de Aquisições

Os cenários a seguir se qualificam como uma conversão para os gráficos Exibições de página e conversões do aplicativo por ID de campanha e Total de conversões da campanha no Relatório de aquisições:

  • Um cliente com ou sem uma conta da Microsoft reconhecida clica em uma URL do app que contém um ID de campanha personalizada e é redirecionado para a lista do app na Store. Em seguida, esse mesmo cliente adquire o aplicativo dentro de 24 horas depois de clicar pela primeira vez na URL da Microsoft Store com a ID da campanha personalizada.

  • Se o cliente adquirir o aplicativo em um dispositivo diferente do em que clicou na URL com a ID da campanha personalizada, a conversão só será contada se o cliente estiver conectado com a mesma conta da Microsoft que quando clicar na URL.

Nota

Para aquisições de aplicativos que são contadas como conversões para uma campanha personalizada, todas as compras de complemento nesse aplicativo também são contadas como conversões para a mesma campanha personalizada.

Qualificação de conversões ao recuperar programaticamente a ID da campanha

Para se qualificar como uma conversão ao recuperar programaticamente a ID da campanha associada ao aplicativo, as seguintes condições devem ser atendidas:

  • Em um dispositivo que executa Windows 10, versão 1607 ou posterior: um cliente (conectado a uma conta da Microsoft reconhecida ou não) clica em uma URL que contém uma ID de campanha personalizada e é redirecionado para a página de listagem da Store para o aplicativo. O cliente adquire o aplicativo ao visualizar a página na Loja como resultado de clicar no URL.

  • Em um dispositivo que executa Windows 10, versão 1511 ouanterior: um cliente (que deve estar conectado com uma conta da Microsoft reconhecida) clica em uma URL que contém uma ID de campanha personalizada e é redirecionado para a página de listagem da Loja para o aplicativo. O cliente adquire o aplicativo ao visualizar a página na Loja como resultado de clicar no URL. Nessas versões do Windows 10 ou Windows 11, o usuário deve estar conectado com uma conta reconhecida da Microsoft para que a aquisição se qualifique como uma conversão ao recuperar programaticamente a ID da campanha.

Nota

Se o cliente sair da página na Loja, mas retornar à página em 24 horas (no mesmo dispositivo ou em um dispositivo diferente quando conectado com a mesma conta da Microsoft) e adquirir o aplicativo, isso se qualificará como uma conversão nos gráficos Exibições de página e conversões do aplicativo por ID de campanha e Total de conversões da campanha no Relatório de aquisições. No entanto, isso não se qualificará como uma conversão se você recuperar programaticamente o ID da campanha.

Inserir uma ID de campanha personalizada na URL da página da Microsoft Store do aplicativo

Para criar uma URL de página da Microsoft Store para seu aplicativo com uma ID de campanha personalizada:

  1. Crie uma cadeia de caracteres de ID para sua campanha personalizada. Essa cadeia de caracteres pode conter até 100 caracteres, embora seja recomendável definir IDs de campanha curtas que sejam facilmente identificáveis.

Nota

A string de ID da campanha pode ficar visível para outros desenvolvedores quando eles visualizarem o Relatório de aquisições para os aplicativos. Isso pode ocorrer quando um cliente clica em sua ID de campanha personalizada para entrar na Loja e compra o aplicativo de outro desenvolvedor na mesma sessão, atribuindo essa conversão à sua ID de campanha. Esse desenvolvedor verá quantas conversões de seu próprio aplicativo resultaram de um clique inicial em sua ID de campanha, incluindo o nome da ID da campanha, mas eles não verão dados sobre quantos usuários compraram seus próprios aplicativos (ou aplicativos de outros desenvolvedores) depois de clicar em sua ID de campanha.

  1. Obtenha o link para a página do aplicativo na Loja nos formatos HTML ou de protocolo.

    • Use a URL HTML se quiser que os clientes naveguem até a listagem da Loja baseada na Web do seu aplicativo em um navegador em qualquer sistema operacional. Em dispositivos Windows, o aplicativo da loja também vai abrir e mostrar a listagem do seu aplicativo. Essa URL tem o formato https://apps.microsoft.com/detail/*your app ID*. Por exemplo, a URL HTML do Skype é https://apps.microsoft.com/detail/9wzdncrfj364. Você pode encontrar esse URL na página Identidade do aplicativo.

    • Use o formato de protocolo se você estiver promovendo seu aplicativo de dentro de outros aplicativos do Windows que estão em execução em um dispositivo ou computador com o aplicativo UWP instalado ou quando souber que seus clientes estão em um dispositivo que dá suporte à Microsoft Store. Este link vai diretamente para a listagem da loja do seu aplicativo sem abrir um navegador. Essa URL tem o formato ms-windows-store://pdp/?PRODUCTID=*your app id*. Por exemplo, a URL de protocolo do Skype é ms-windows-store://pdp/?PRODUCTID=9wzdncrfj364.

  2. Acrescente a seguinte cadeia de caracteres ao final da URL do seu aplicativo:

    • Para uma URL de formato HTML, acrescente ?cid=*my custom campaign ID*. Por exemplo, se o Skype introduzir uma ID de campanha com o valor custom_campaign, a nova URL incluindo a ID da campanha será: https://apps.microsoft.com/detail/9wzdncrfj364?cid=custom_campaign.

    • Para uma URL de formato de protocolo, acrescente &cid=*my custom campaign ID*. Por exemplo, se o Skype introduzir uma ID de campanha com o valor custom_campaign, a nova URL de protocolo, incluindo a ID da campanha, será: ms-windows-store://pdp/?PRODUCTID=9wzdncrfj364&cid=custom_campaign.

Recuperar programaticamente a ID da campanha personalizada para um aplicativo

Se seu aplicativo for um aplicativo UWP, você poderá recuperar programaticamente a ID de campanha personalizada associada à aquisição de um aplicativo usando APIs no SDK do Windows. Essas APIs possibilitam muitos cenários de análise e monetização. Por exemplo, você pode descobrir se o usuário atual adquiriu seu aplicativo depois de descobri-lo por meio de sua campanha no Facebook e personalizar a experiência do aplicativo adequadamente. Como alternativa, se você estiver usando um provedor de marketing de aplicativo de terceiros, poderá enviar dados de volta para o provedor.

Essas APIs retornarão uma cadeia de caracteres de ID de campanha somente se o cliente clicar na URL com a ID da campanha inserida, exibir a página da Microsoft Store para seu aplicativo e, em seguida, adquirir seu aplicativo sem sair da página de listagem da Loja. Se o usuário sair da página e, depois, retornar e adquirir o aplicativo, isso não se qualificará como uma conversão ao usar essas APIs.

Há APIs diferentes para você usar dependendo da versão do Windows direcionada ao aplicativo:

  • Windows 10, versão 1607 ou posterior: use a classe StoreContext no namespace Windows.Services.Store. Ao usar esta API, é possível recuperar IDs de campanha personalizada para aquisições qualificadas, independentemente de o usuário estar conectado com uma conta da Microsoft reconhecida.

  • Windows 10, versão 1511 ou anterior: use a classe CurrentApp no namespace Windows.ApplicationModel.Store. Ao usar esta API, é possível recuperar somente IDs de campanha personalizada para aquisições qualificadas, onde o usuário está conectado com uma conta da Microsoft reconhecida.

Nota

Embora o namespace Windows.ApplicationModel.Store esteja disponível em todas as versões do Windows 10 ou Windows 11, recomendamos que você use as APIs no namespace Windows.Services.Store se o aplicativo for direcionado ao Windows 10, versão 1607 ou posterior. Para obter mais informações sobre as diferenças entre esses namespaces, consulte Compras no aplicativo e trials. O exemplo de código a seguir mostra como estruturar seu código para usar ambas as APIs no mesmo projeto.

Exemplo de código

O exemplo de código a seguir mostra como recuperar a ID da campanha personalizada. Este exemplo usa conjuntos de APIs nos namespaces Windows.Services.Store e Windows.ApplicationModel.Store usando código adaptável de versão. Seguindo esse processo, seu código pode ser executado em qualquer versão do Windows 10 ou windows 11. Para usar esse código, a versão do sistema operacional de destino do seu projeto deve ser Edição de Aniversário do Windows 10 (10.0; Build 14394) ou posterior, embora a versão mínima do sistema operacional possa ser uma versão anterior.

// This example assumes the code file has using statements for
// System.Linq, System.Threading.Tasks, Windows.Data.Json,
// and Windows.Services.Store.
public async Task<string> GetCampaignId()
{
    // Use APIs in the Windows.Services.Store namespace if they are available
    // (the app is running on a device with Windows 10, version 1607, or later).
    if (Windows.Foundation.Metadata.ApiInformation.IsTypePresent(
         "Windows.Services.Store.StoreContext"))
    {
        StoreContext context = StoreContext.GetDefault();

        // Try to get the campaign ID for users with a recognized Microsoft account.
        StoreProductResult result = await context.GetStoreProductForCurrentAppAsync();
        if (result.Product != null)
        {
            StoreSku sku = result.Product.Skus.FirstOrDefault(s => s.IsInUserCollection);

            if (sku != null)
            {
                return sku.CollectionData.CampaignId;
            }
        }

        // Try to get the campaign ID from the license data for users without a
        // recognized Microsoft account.
        StoreAppLicense license = await context.GetAppLicenseAsync();
        JsonObject json = JsonObject.Parse(license.ExtendedJsonData);
        if (json.ContainsKey("customPolicyField1"))
        {
            return json["customPolicyField1"].GetString();
        }

        // No campaign ID was found.
        return String.Empty;
    }
    // Fall back to using APIs in the Windows.ApplicationModel.Store namespace instead
    // (the app is running on a device with Windows 10, version 1577, or earlier).
    else
    {
#if DEBUG
        return await Windows.ApplicationModel.Store.CurrentAppSimulator.GetAppPurchaseCampaignIdAsync();
#else
        return await Windows.ApplicationModel.Store.CurrentApp.GetAppPurchaseCampaignIdAsync() ;
#endif
    }
}

Esse código faz o seguinte:

  1. Primeiro, verifica se a classe StoreContext no namespace Windows.Services.Store está disponível no dispositivo atual (isso significa que o dispositivo está executando o Windows 10, versão 1607 ou posterior). Nesse caso, o código continuará a usar essa classe.

  2. Em seguida, ele tenta obter a ID da campanha personalizada para o caso em que o usuário atual tem uma conta da Microsoft reconhecida. Para fazer isso, o código obtém um objeto StoreSku que representa o SKU do aplicativo atual e, em seguida, acessa a propriedade CampaignId para recuperar a ID da campanha, se houver uma disponível.

  3. Em seguida, o código tenta recuperar a ID da campanha para o caso em que o usuário atual não tem uma conta da Microsoft reconhecida. Nesse caso, a ID da campanha é inserida na licença do aplicativo. O código recupera a licença usando o método GetAppLicenseAsync e analisa o conteúdo JSON da licença para o valor de uma chave chamada customPolicyField1. Esse valor contém a ID da campanha.

  4. Se a classe StoreContext no namespace Windows.Services.Store não estiver disponível, o código voltará a usar o método GetAppPurchaseCampaignIdAsync no namespace Windows.ApplicationModel.Store para recuperar a ID da campanha personalizada (esse namespace está disponível em todas as versões do Windows 10 ou windows 11). Ao usar esse método, você pode recuperar somente IDs de campanha personalizada para aquisições qualificadas em que o usuário tem uma conta da Microsoft reconhecida.

Especificar a ID da campanha no arquivo proxy para o namespace Windows.ApplicationModel.Store

O namespace Windows.ApplicationModel.Store inclui CurrentAppSimulator, uma classe especial que simula operações da Store para testar seu código antes de enviar seu aplicativo para a Loja. Essa classe recupera dados de um arquivo local chamado Windows.StoreProxy.xml. O exemplo de código anterior mostra como incluir o uso de CurrentApp e CurrentAppSimulator em código de depuração e não depuração em seu projeto. Para testar esse código em um ambiente de depuração, adicione um elemento AppPurchaseCampaignId ao arquivo WindowsStoreProxy.xml em seu computador de desenvolvimento, conforme mostrado no exemplo a seguir. Quando você executa o aplicativo, o método GetAppPurchaseCampaignIdAsync sempre retornará esse valor.

<CurrentApp>
    ...
    <AppPurchaseCampaignId>your custom campaign ID</AppPurchaseCampaignId>
</CurrentApp>

O namespace Windows.Services.Store não fornece uma classe que você pode usar para simular informações de licença durante o teste. Em vez disso, você deve publicar um aplicativo na Loja e baixar esse aplicativo em seu dispositivo de desenvolvimento para usar sua licença para teste. Para obter mais informações, confira Compras e avaliações no aplicativo.

Testar sua campanha personalizada

Antes de promover uma URL de campanha personalizada, recomendamos que você teste sua campanha personalizada fazendo o seguinte:

  1. Entre em uma conta da Microsoft no dispositivo que você está usando para teste.

  2. Clique na URL da campanha personalizada. Verifique se você foi levado para a página do aplicativo e feche o aplicativo UWP ou a página do navegador.

  3. Clique na URL várias vezes, fechando o aplicativo UWP ou a página do navegador após cada visita à página do aplicativo. Durante uma das visitas à página do aplicativo, adquira seu aplicativo para gerar uma conversão. Conte o número total de vezes que você clicou na URL.

  4. Verifique se as exibições de página e conversões esperadas aparecem nos gráficos Exibições de página e conversões do aplicativo por ID de campanha e Total de conversões da campanha no Relatório de aquisições, e teste o código do aplicativo para confirmar se ele pode obter o ID da campanha usando as APIs descritas acima.