Criar uma campanha de promoção de aplicativo personalizada

Além de criar uma campanha publicitária para seu aplicativo que será veiculada 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 publicar 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 um URL diferente para cada campanha personalizada, onde cada URL contém um 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ê em Partner Center.

Há dois tipos principais de dados associados a campanhas personalizadas: visualizações de página para a listagem do seu aplicativo na Loja e conversões. Uma conversão é uma aquisição de aplicação que resulta de um cliente visualizar a página de detalhes da Loja da sua aplicação a partir de um endereço URL que inclui um ID de campanha personalizado. 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 da campanha para seu aplicativo das seguintes maneiras:

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

Exemplo de cenário de campanha personalizada

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

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

• O URL que ela publicará em sua página do Facebook inclui o ID personalizado da campanha my-facebook-campaign

• O URL que ela publicará no Twitter inclui o ID personalizado da campanha my-twitter-campaign

À medida que seus seguidores do Facebook e do Twitter clicam nos URLs, a Microsoft rastreia cada clique e o associa à campanha personalizada correspondente. As aquisições qualificadas subsequentes do jogo e quaisquer compras adicionais são associadas à campanha personalizada e reportadas como conversões.

Compreender como as aquisições se qualificam como conversões

Uma campanha personalizada conversão é uma aquisição que resulta de um cliente clicar num URL que é promovido através de uma campanha personalizada. Há diferentes cenários para qualificar como uma conversão para as visualizações de página e conversões do aplicativo por ID de campanha e Total de conversões gráficos no relatório Aquisições e para se qualificar como uma conversão para recuperar programaticamente o ID da campanha.

Conversões qualificadas no Relatório de Aquisições

Os cenários seguintes qualificam-se como uma conversão para as visualizações de página e conversões pela página do aplicativo por ID de campanha, bem como os gráficos Totais de conversões por campanha no relatório de Aquisições :

• Um cliente com ou sem uma conta Microsoft reconhecida clica num URL de aplicação que contém um ID de campanha personalizado e é redirecionado para a listagem da Loja para a aplicação. Em seguida, esse mesmo cliente adquire o aplicativo dentro de 24 horas após clicar pela primeira vez na URL da Microsoft Store com a ID da campanha personalizada.

• Se o cliente adquirir a aplicação num dispositivo diferente daquele em que clicou no URL com o ID de campanha personalizado, a conversão só será contabilizada se o cliente tiver sessão iniciada com a mesma conta Microsoft de quando clicou no URL.

Qualificação de conversões ao recuperar de forma programática o ID da campanha

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

• Num dispositivo com Windows 10, versão 1607 ou posterior: Um cliente (quer tenha sessão iniciada numa conta Microsoft reconhecida ou não) clica num URL que contém um ID de campanha personalizado e é redirecionado para a página de listagem da Loja da aplicação. O cliente adquire a aplicação enquanto visualiza a listagem da loja como resultado de clicar no URL.

• Num dispositivo com Windows 10, versão 1511 ou anterior: Um cliente (que tem de ter sessão iniciada com uma conta Microsoft reconhecida) clica numa URL que contém um ID de campanha personalizado e é redirecionado para a página da loja do aplicativo. O cliente adquire o aplicativo enquanto visualiza a listagem da 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 da Microsoft reconhecida para que a aquisição se qualifique como uma conversão ao recuperar programaticamente o ID da campanha.

Incorporar um ID de campanha personalizado ao URL da página da Microsoft Store do seu aplicativo

Para criar um 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.

2. Obtenha o link para a listagem da Loja da sua aplicação em formato HTML ou 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, a aplicação Loja também será iniciada e exibirá a listagem da sua aplicação. Este URL tem o formato https://apps.microsoft.com/detail/*your app ID*. Por exemplo, o URL HTML do Skype é https://apps.microsoft.com/detail/9wzdncrfj364. Pode encontrar o URL na página de identidade da aplicação .

   • Utilize o formato de protocolo se estiver a promover a sua aplicação a partir de outras aplicações do Windows em execução num dispositivo ou computador com a aplicação UWP instalada ou quando souber que os seus clientes estão num dispositivo compatível com a Microsoft Store. Esse link irá diretamente para a listagem do seu aplicativo na Loja sem abrir um navegador. Este URL tem o formato ms-windows-store://pdp/?PRODUCTID=*your app id*. Por exemplo, a URL do protocolo para Skype é ms-windows-store://pdp/?PRODUCTID=9wzdncrfj364.

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

   • Para um URL de formato HTML, acrescente ?cid=*my custom campaign ID*. Por exemplo, se o Skype introduzir um ID de campanha com o valor custom_campaign, o novo URL, incluindo o 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 um ID de campanha com o valor custom_campaign, o novo URL de protocolo, incluindo o ID da campanha, será: ms-windows-store://pdp/?PRODUCTID=9wzdncrfj364&cid=custom_campaign.

Recuperar programaticamente o ID de campanha personalizado de 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 do Facebook e, em seguida, personalizar a experiência do aplicativo de acordo. 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 em sua URL com a ID de campanha incorporada, 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, posteriormente, retornar e adquirir o aplicativo, isso não se qualificará como um de conversão ao usar essas APIs.

Há APIs diferentes para você usar, dependendo da versão do Windows que seu aplicativo destina:

• Windows 10, versão 1607, ou posterior: use a classe StoreContext no namespace Windows.Services.Store. Ao usar essa API, você pode recuperar IDs de campanha personalizadas para qualquer aquisições qualificadas, independentemente de o usuário estar ou não 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 essa API, você só pode recuperar IDs de campanha personalizadas para aquisições qualificadas em que o usuário está conectado com uma conta da Microsoft reconhecida.

Exemplo de código

O exemplo de código a seguir mostra como recuperar o ID da campanha personalizada. Este exemplo usa conjuntos de APIs nos namespaces Windows.Services.Store e Windows.ApplicationModel.Store usando versão adaptável. 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 Windows 10 Anniversary Edition (10.0; Build 14394) ou posterior, embora a versão mínima do SO 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
    }
}

Este código faz o seguinte:

1. Primeiro, ele 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). Em caso afirmativo, o código continua a usar essa classe.

2. Em seguida, ele tenta obter a ID de 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 a 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, o ID da campanha é incorporado na licença do aplicativo. O código recupera a licença usando o método GetAppLicenseAsync e, em seguida, analisa o conteúdo JSON da licença para o valor de uma chave chamada customPolicyField1. Esse valor contém o 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). Observe que, ao usar esse método, você só pode recuperar IDs de campanha personalizadas para aquisições qualificadas em que o usuário tenha uma conta da Microsoft reconhecida.

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

O namespace Windows.ApplicationModel.Store inclui CurrentAppSimulator, uma classe especial que simula as operações da Loja 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 arquivo. O exemplo de código anterior mostra como utilizar CurrentApp e CurrentAppSimulator no código de depuração e não depuração no seu projeto. Para testar este código num ambiente de depuração, adicione um elemento AppPurchaseCampaignId ao ficheiro WindowsStoreProxy.xml no computador de desenvolvimento, conforme mostrado no exemplo a seguir. Quando você executa o aplicativo, o GetAppPurchaseCampaignIdAsync método sempre retornará esse valor.

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

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

Teste a sua campanha personalizada

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

1. Inicie sessão numa conta Microsoft no dispositivo que está a utilizar para teste.

2. Clique no URL da sua campanha personalizada. Certifique-se de que foi direcionado para a página da aplicação e, em seguida, feche a aplicação UWP ou a página do browser.

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

4. Confirme se as visualizações de página e as conversões esperadas aparecem no Visualizações de página e conversões de página do aplicativo por ID de campanha e Total de conversões gráficos no relatório Aquisições e teste o código do seu aplicativo para confirmar se ele pode recuperar com êxito o ID da campanha usando as APIs descritas acima.