Configuração inicial do SDK
Saiba como instalar o Braze SDK para Xamarin. A instalação do SDK da Braze fornecerá a funcionalidade básica de análise de dados, bem como mensagens no app com as quais você poderá engajar seus usuários.
A partir de version 3.0.0
, esse SDK requer o uso do .NET 6+ e remove o suporte para projetos que usam a estrutura Xamarin.
A partir de version 4.0.0
, esse SDK deixou de oferecer suporte ao Xamarin e ao Xamarin.Forms e adicionou suporte ao .NET MAUI.
Consulte a política da Microsoft com relação ao fim do suporte para o Xamarin.
Etapa 1: Obter a vinculação do Xamarin
Uma ligação Xamarin é uma maneira de usar bibliotecas nativas em apps Xamarin. A implementação de uma associação consiste em criar uma interface C# para a biblioteca e, em seguida, usar essa interface em seu aplicativo. Consulte a documentação da Xamarin. Há duas maneiras de incluir a associação do SDK da Braze: usando o NuGet ou compilando a partir da fonte.
O método mais simples de integração envolve a obtenção do SDK da Braze no NuGet.org repositório central. Na barra lateral do Visual Studio, clique com o botão direito do mouse na pasta Packages
e clique em Add Packages...
. Procure por “Braze” e instale o pacote BrazePlatform.BrazeAndroidBinding
em seu projeto.
O segundo método de integração é incluir a fonte de ligação. Em appboy-component/src/androidnet6
você encontrará nosso código-fonte de vinculação; adicionar uma referência de projeto a BrazeAndroidBinding.csproj
em seu aplicativo Xamarin fará com que a vinculação seja criada com seu projeto e fornecerá acesso ao SDK para Android.
As ligações do iOS para o Xamarin SDK versão 4.0.0 e posteriores usam o SDK para Swift, enquanto as versões anteriores usam o AppboyKit SDK legado.
Uma ligação Xamarin é uma maneira de usar bibliotecas nativas em apps Xamarin. A implementação de uma associação consiste em criar uma interface C# para a biblioteca e, em seguida, usar essa interface em seu aplicativo. Há duas maneiras de incluir a associação do SDK da Braze: usando o NuGet ou compilando a partir da fonte.
O método mais simples de integração envolve a obtenção do SDK da Braze no NuGet.org repositório central. Na barra lateral do Visual Studio, clique com o botão direito do mouse na pasta Packages
e clique em Add Packages...
. Procure por “Braze” e instale os pacotes NuGet mais recentes do Xamarin iOS: Braze.iOS.BrazeKit, Braze.iOS.BrazeUI, e [Braze.iOS.BrazeLocation]https://www.nuget.org/packages/Braze.iOS.BrazeLocation em seu projeto.
Também fornecemos os pacotes de bibliotecas de compatibilidade: Braze.iOS.BrazeKitCompat e Braze.iOS.BrazeUICompatpara ajudar a facilitar sua migração para o .NET MAUI.
O segundo método de integração é incluir a fonte de ligação. Em appboy-component/src/iosnet6
você encontrará nosso código-fonte de associação; adicionar uma referência de projeto a BrazeiOSBinding.csproj
em seu aplicativo Xamarin fará com que a associação seja criada com seu projeto e fornecerá acesso ao SDK da Braze para iOS. Verifique se o site BrazeiOSBinding.csproj
está sendo exibido na pasta “Reference” do seu projeto.
Etapa 2: Configure sua instância do Braze
Etapa 2.1: Configure o SDK da Braze em Braze.xml
Agora que as bibliotecas foram integradas, você precisa criar um arquivo Braze.xml
na pasta Resources/values
do seu projeto. O conteúdo desse arquivo deve se parecer com o seguinte trecho de código:
Certifique-se de substituir YOUR_API_KEY
pela chave de API localizada em Configurações > Chaves de API no dashboard do Braze.
Se estiver usando a navegação mais antiga, poderá encontrar as chaves de API em Console do desenvolvedor > Configurações de API.
1
2
3
4
5
6
7
8
9
<?xml version="1.0" encoding="utf-8"?>
<resources>
<string translatable="false" name="com_braze_api_key">YOUR_API_KEY</string>
<string translatable="false" name="com_braze_custom_endpoint">YOUR_CUSTOM_ENDPOINT_OR_CLUSTER</string>
<string-array name="com_braze_internal_sdk_metadata">
<item>XAMARIN</item>
<item>NUGET</item>
</string-array>
</resources>
Se estiver incluindo a fonte de vinculação manualmente, remova <item>NUGET</item>
do seu código.
Para ver um exemplo em Braze.xml
, confira nosso app de amostra Android MAUI.
Etapa 2.2: Adicionar permissões necessárias ao manifesto do Android
Agora que adicionou sua chave de API, você precisa adicionar as seguintes permissões ao arquivo AndroidManifest.xml
:
1
<uses-permission android:name="android.permission.INTERNET" />
Para obter um exemplo de seu AndroidManifest.xml
, consulte o aplicativo de amostra do Android MAUI.
Etapa 2.3: Rastreie as sessões de usuários e o registro de mensagens no app
Para ativar o rastreamento da sessão do usuário e registrar seu aplicativo para mensagens no app, adicione a seguinte chamada ao método de ciclo de vida OnCreate()
da classe Application
do seu aplicativo:
1
RegisterActivityLifecycleCallbacks(new BrazeActivityLifecycleCallbackListener());
Ao configurar sua instância da Braze, adicione o seguinte snippet para configurar sua instância:
Certifique-se de substituir YOUR_API_KEY
pela chave de API localizada em Configurações > Chaves de API no dashboard do Braze.
Se estiver usando a navegação mais antiga, poderá encontrar as chaves de API em Console do desenvolvedor > Configurações de API.
1
2
3
var configuration = new BRZConfiguration("YOUR_API_KEY", "YOUR_ENDPOINT");
configuration.Api.AddSDKMetadata(new[] { BRZSDKMetadata.Xamarin });
braze = new Braze(configuration);
Consulte o arquivo App.xaml.cs
no aplicativo de amostra MAUI do iOS.
Etapa 3: Teste a integração
Agora você pode iniciar seu aplicativo e ver as sessões sendo registradas no dashboard do Braze (juntamente com informações do dispositivo e outras análises de dados). Para uma discussão mais aprofundada sobre as práticas recomendadas para a integração básica do SDK, consulte as instruções de integração do Android.
Agora você pode iniciar seu aplicativo e ver as sessões sendo registradas no dashboard do Braze. Para uma discussão mais aprofundada sobre as práticas recomendadas para a integração básica do SDK, consulte as instruções de integração do iOS.
Nossa atual vinculação pública do Xamarin para o SDK do iOS não se conecta ao SDK do Facebook do iOS (vinculando dados sociais) e não inclui o envio do IDFA para a Braze.