Centro de Aplicações – Distribuição Unity – Atualizações dentro da aplicação

A Distribuição do App Center permite que seus usuários/testadores instalem novas versões de um aplicativo depois de distribuí-lo por meio do App Center. Uma vez habilitado, o SDK apresenta uma caixa de diálogo de atualização aos usuários para baixar ou adiar a instalação da atualização mais recente. Assim que eles optarem por atualizar, o SDK começará a atualizar seu aplicativo.

Adicionar atualizações na aplicação ao seu aplicativo

Adicionar o módulo Distribuir do App Center

O SDK do App Center foi projetado com uma abordagem modular – um desenvolvedor só precisa integrar os módulos dos serviços em que está interessado.

Siga os documentos de introdução do Unity se você ainda não configurou e iniciou o SDK em seu aplicativo. Certifique-se de importar o pacote App Center Distribute. Seu nome deve estar no formato AppCenterDistribute-v{version}.unitypackage.

Remover atualizações no aplicativo para compilações do Google Play

O Google Play considera o código de atualização no aplicativo como um comportamento mal-intencionado, mesmo que não seja usado em tempo de execução. Remova esse código antes de enviar seu aplicativo para o Google Play. A não remoção do código de atualização no aplicativo pode levar à não conformidade e à remoção do aplicativo do Google Play. Desmarque a caixa de seleção Usar distribuição na seção Distribuir no objeto de jogo com AppCenterBehavior anexado para remover o código nativo das atualizações no aplicativo.

Usar grupo de distribuição privado

Por padrão, Distribuir usa um grupo de distribuição público. Se pretender utilizar um grupo de distribuição privado, terá de mudar UpdateTrack para Privado. Para fazer isso, escolha Privado no menu Faixa de atualização na seção Distribuir no objeto de jogo com ComportamentoAppCenter anexado.

Ao usar a faixa privada, uma janela do navegador será aberta para autenticar o usuário. Todas as verificações de atualização subsequentes receberão a versão mais recente no canal privado.

Se um usuário estiver no caminho privado, isso significa que, após a autenticação bem-sucedida, ele receberá a versão mais recente de todos os grupos de distribuição privados dos quais é membro. Se um usuário estiver no caminho público, isso significa que ele receberá a versão mais recente de qualquer grupo de distribuição público.

Desativar a verificação automática de atualizações

Por padrão, o SDK verifica automaticamente se há novas versões:

• Quando a aplicação é iniciada.
• Quando o aplicativo entra em segundo plano e depois torna ao primeiro plano novamente.
• Ao ativar o módulo Distribuir, caso esteja desativado anteriormente.

Se você quiser verificar novas versões manualmente, você pode desativar a verificação automática de atualização.

Para fazer isso, desmarque a caixa de seleção Verificação automática de atualizações na seção Distribuir no objeto de jogo ao qual está anexado AppCenterBehavior.

Em seguida, você pode usar a CheckForUpdate API descrita na seção a seguir.

Verificar manualmente se há atualização

Distribute.CheckForUpdate();

Isso envia uma solicitação para o App Center e exibe uma caixa de diálogo de atualização caso haja uma nova versão disponível.

Personalizar ou localizar a caixa de diálogo de atualização no aplicativo

1. Personalizar ou localizar texto

Você pode fornecer suas próprias cadeias de caracteres de recursos se quiser localizar o texto exibido na caixa de diálogo de atualização. Observe os arquivos de cadeia de caracteres para iOS neste arquivo de recurso do iOS e para Android neste arquivo de recurso do Android. Use o mesmo nome/chave de cadeia de caracteres e especifique o valor localizado a ser refletido na caixa de diálogo em seus próprios arquivos de recursos do aplicativo.

2. Personalize a caixa de diálogo de atualização

Você pode personalizar a aparência da caixa de diálogo de atualização padrão implementando o "callback" ReleaseAvailable.

// In this example, OnReleaseAvailable is a method name in same class
Distribute.ReleaseAvailable = OnReleaseAvailable;

Aqui está uma implementação de callback que substitui a caixa de diálogo do SDK por uma lógica personalizada:

bool OnReleaseAvailable(ReleaseDetails releaseDetails)
{
    // Look at releaseDetails public properties to get version information, release notes text or release notes URL
    string versionName = releaseDetails.ShortVersion;
    string versionCodeOrBuildNumber = releaseDetails.Version;
    string releaseNotes = releaseDetails.ReleaseNotes;
    Uri releaseNotesUrl = releaseDetails.ReleaseNotesUrl;

    // (Do something with the values if you want)

    // On mandatory update, user can't postpone
    if (releaseDetails.MandatoryUpdate)
    {
        // Force user to update (you should probably show some custom UI here)
        Distribute.NotifyUpdateAction(UpdateAction.Update);
    }
    else
    {
        // Allow user to update or postpone (you should probably show some custom UI here)
        // "GetUserUpdateAction()" isn't part of the SDK; it just represents a way of getting user response.
        // This blocks the thread while awaiting the user's response! This example shouldn't be used literally
        UpdateAction updateAction = GetUserUpdateAction();
        Distribute.NotifyUpdateAction(updateAction);
    }
    // Return true if you're using your own UI to get user response, false otherwise
    return true;
}

Notas de implementação para Android:

Como mostrado no exemplo, você deve chamar um dos Distribute.NotifyUpdateAction(UpdateAction.UPDATE); ou Distribute.NotifyUpdateAction(UpdateAction.POSTPONE); se o retorno de chamada retornar true.

Se não chamares NotifyUpdateAction, o retorno de chamada irá repetir-se a cada mudança de atividade.

O callback pode ser chamado novamente com o mesmo lançamento se a atividade mudar antes que a ação do usuário seja notificada ao SDK.

Esse comportamento é necessário para cobrir os seguintes cenários:

• Seu aplicativo é enviado para o plano de fundo (como pressionar HOME) e, em seguida, retomado em uma atividade diferente.
• Sua atividade é coberta por outra sem sair do aplicativo (como clicar em algumas notificações).
• Cenários semelhantes aos acima.

Nesse caso, a atividade que hospeda a caixa de diálogo pode ser substituída sem interação do usuário. Assim, o SDK chama o ouvinte novamente para que você possa restaurar a caixa de diálogo personalizada.

3. Execute o código se nenhuma atualização for encontrada

Nos casos em que o SDK verifica se há atualizações e não encontra nenhuma atualização disponível mais recente do que a usada atualmente, um callback NoReleaseAvailable é invocado. Isso permite que você execute código personalizado em tais cenários. Você precisa registrar o retorno de chamada antes de ligar AppCenter.Start , conforme mostrado no exemplo a seguir:

// In this example OnNoReleaseAvailable is a method name in same class
Distribute.NoReleaseAvailable = OnNoReleaseAvailable;
AppCenter.Start(...);

void OnNoReleaseAvailable()
{
    AppCenterLog.Info(LogTag, "No release available callback invoked.");
}

## Enable or disable App Center Distribute at runtime

You can enable and disable App Center Distribute at runtime. If you disable it, the SDK won't provide any in-app update functionality but you can still use the Distribute service in the App Center portal.

To disable the Distribute service, use the following code:

```csharp
Distribute.SetEnabledAsync(false);

Para habilitar o App Center Distribute novamente, use a mesma API, mas passe true como parâmetro.

Distribute.SetEnabledAsync(true);

Essa API é assíncrona, você pode ler mais sobre em nosso guia de APIs assíncronas do App Center .

Você não precisa esperar essa chamada para tornar outras chamadas de API (como IsEnabledAsync) consistentes.

O estado é persistido no armazenamento do dispositivo em todas as inicializações de aplicativos.

Verifique se o App Center Distribute está ativado

Você também pode verificar se o App Center Distribute está habilitado:

Distribute.IsEnabledAsync();

Essa API é assíncrona, você pode ler mais sobre em nosso guia de APIs assíncronas do App Center .

Habilitar atualizações no aplicativo para compilações de depuração

Por padrão, as atualizações no aplicativo são habilitadas apenas para compilações de versão.

Para habilitar atualizações no aplicativo para compilações de depuração no Android e iOS, marque a caixa de seleção Ativar distribuição na depuração na seção Distribuir no objeto de jogo com AppCenterBehavior anexado.

No Unity, uma compilação depurável é uma compilação com a opção Development build marcada.

Execute a limpeza antes que o aplicativo feche para atualização

Registe o callback como mostrado no exemplo seguinte:

// In this example, OnWillExitApp is a method name in same class
Distribute.WillExitApp = OnWillExitApp;

void OnWillExitApp()
{
    // Perform clean up here
}

Com isso, OnWillExitApp() será invocado quando Distribute estiver prestes a fechar.

Como funcionam as atualizações no aplicativo

O recurso de atualizações no aplicativo funciona da seguinte maneira:

1. Esse recurso só funciona com compilações RELEASE (por padrão) que são distribuídas usando o serviço App Center Distribuir . Não funcionará se a funcionalidade de Acesso Guiado do iOS estiver ativada.
2. Depois de integrar o SDK, crie uma versão de lançamento do seu aplicativo e carregue-a para o App Center. Os usuários do grupo de distribuição são notificados sobre a nova versão por e-mail.
3. Quando cada usuário abre o link em seu e-mail, o aplicativo será instalado em seu dispositivo. É importante que eles usem o link por e-mail para instalar - não damos suporte a carregamento lateral. Quando um aplicativo é baixado do link, o SDK salva informações importantes dos cookies para verificar se há atualizações posteriormente, caso contrário, o SDK não terá essas informações importantes.
4. Se o aplicativo definir a faixa como privada, um navegador será aberto para autenticar o usuário e habilitar atualizações no aplicativo. O navegador não voltará a abrir enquanto as informações de autenticação permanecerem válidas, mesmo ao alternar para a faixa pública e voltando novamente para a privada mais tarde. Se a autenticação do navegador for bem-sucedida, o usuário será redirecionado de volta para o aplicativo automaticamente. Se a faixa for pública (que é o padrão), o próximo passo ocorre imediatamente.
5. Uma nova versão do aplicativo mostra a caixa de diálogo de atualização no aplicativo solicitando que os usuários atualizem seu aplicativo se for:
   • iOS:
     • um valor superior a CFBundleShortVersionString ou
     • um valor igual de CFBundleShortVersionString mas um valor superior de CFBundleVersion.
     • As versões são as mesmas, mas o identificador exclusivo de compilação é diferente.
   • Android:
     • um valor superior a versionCode ou
     • um valor igual de versionCode mas um valor diferente de versionName.

Como faço para testar as atualizações no aplicativo?

Você deve carregar compilações de distribuição (que usam o módulo Distribuir do SDK do App Center) no Portal do App Center para testar as atualizações no aplicativo, aumentando os números de versão a cada vez.

1. Crie seu aplicativo no Portal do App Center, se ainda não o fez.
2. Crie um novo grupo de distribuição e atribua-lhe um nome.
3. Adicione a si mesmo (ou a todas as pessoas que você deseja incluir no teste do recurso de atualização no aplicativo). Use um endereço de e-mail novo ou descartável para esta etapa, um ainda não usado com este aplicativo. Isso garante que sua experiência esteja próxima da experiência de seus testadores reais.
4. Crie uma nova compilação do seu aplicativo que inclua o App Center Distribute e contenha a lógica de configuração conforme descrito abaixo. Se o grupo for privado, não se esqueça de definir a faixa de atualização privada no aplicativo antes de começar a usar a UpdateTrack propriedade.
5. Clique no botão Distribuir nova versão no portal e carregue sua compilação do aplicativo.
6. Quando o carregamento terminar, clique em Avançar e selecione o grupo de distribuição que você criou anteriormente como o Destino da distribuição desse aplicativo.
7. Revise a Distribuição e distribua a compilação para seu grupo de teste no aplicativo.
8. As pessoas desse grupo receberão um convite para serem testadores do aplicativo. Assim que aceitarem o convite, podem descarregar a aplicação do Portal do App Center nos seus dispositivos móveis. Depois que eles tiverem as atualizações no aplicativo instaladas, você estará pronto para testar as atualizações no aplicativo.
9. Aumente a versão do seu aplicativo (CFBundleShortVersionString CFBundleVersion ou para iOS, versionCode para Android).
10. Crie a versão de lançamento do seu aplicativo e carregue uma nova compilação como fez na etapa anterior. Distribua para o Grupo de Distribuição criado anteriormente. Os membros do Grupo de Distribuição serão solicitados a fornecer uma nova versão na próxima vez que o aplicativo for iniciado.