Referências, repositórios e apps de exemplo
Esta é uma lista de documentação de referência, repositórios GitHub e apps de exemplo pertencentes a cada SDK da Braze. A documentação de referência de um SDK detalha suas classes, tipos, funções e variáveis disponíveis. O repositório GitHub fornece insight sobre as declarações de funções e atributos desse SDK, alterações de código e controle de versão. Cada repositório também inclui aplicativos de exemplo totalmente compiláveis que você pode usar para testar os recursos da Braze ou implementar junto com seus próprios aplicativos.
Lista de recursos
Atualmente, alguns SDKs não possuem documentação de referência dedicada, mas estamos trabalhando ativamente nisso.
| Plataforma | Referência | Repositório | App de exemplo |
|---|---|---|---|
| Android SDK | Documentação de referência | Repositório GitHub | App de exemplo |
| Swift SDK | Documentação de referência | Repositório GitHub | App de exemplo |
| Web SDK | Documentação de referência | Repositório GitHub | App de exemplo |
| Cordova SDK | Arquivo de declaração | Repositório GitHub | App de exemplo |
| Flutter SDK | Documentação de referência | Repositório GitHub | App de exemplo |
| React Native SDK | Arquivo de declaração | Repositório GitHub | App de exemplo |
| Roku SDK | N/D | Repositório GitHub | App de exemplo |
| Unity SDK | Arquivo de declaração | Repositório GitHub | App de exemplo |
| SDK .NET MAUI (anteriormente Xamarin) | N/D | Repositório GitHub | App de exemplo |
Criando um app de exemplo
Compilando o “Droidboy”
Nosso aplicativo de teste no repositório GitHub do Android SDK é chamado Droidboy. Siga estas instruções para criar uma cópia totalmente funcional dele junto com seu projeto.
- Crie um novo espaço de trabalho e anote a chave de identificação da API da Braze.
- Copie seu ID de remetente FCM e a chave de identificação da API da Braze nos locais apropriados em
/droidboy/res/values/braze.xml(entre as tags das strings denominadascom_braze_push_fcm_sender_idecom_braze_api_key, respectivamente). - Copie a chave do servidor FCM e o ID do servidor nas configurações do espaço de trabalho em Gerenciar Configurações.
- Para montar o APK do Droidboy, execute
./gradlew assembleno diretório do SDK. Usegradlew.batno Windows. - Para instalar automaticamente o APK do Droidboy em um dispositivo de teste, execute
./gradlew installDebugno diretório do SDK:
Compilando o “Hello Braze”
O aplicativo de teste Hello Braze mostra um caso de uso mínimo do SDK da Braze e também demonstra como integrar facilmente o SDK da Braze em um projeto Gradle.
- Copie sua chave de identificador de API da página Manage Settings no seu arquivo
braze.xmlna pastares/values.
- Para instalar o app de exemplo em um dispositivo ou emulador, execute o seguinte comando no diretório do SDK:
1
./gradlew installDebug
Se você não tiver a variável
ANDROID_HOMEdefinida corretamente ou não tiver uma pastalocal.propertiescom uma pastasdk.dirválida, esse plug-in também instalará o SDK básico para você. Consulte o repositório do plug-in para mais informações.
Para saber mais sobre o sistema de compilação do Android SDK, consulte o README do repositório GitHub.
Compilando apps de teste Swift
Siga estas instruções para compilar e executar nossos aplicativos de teste.
- Crie um novo espaço de trabalho e anote a chave de API do identificador do app e o endpoint.
- Com base no seu método de integração (Swift Package Manager, CocoaPods, Manual), selecione o arquivo
xcodeprojapropriado para abrir. - Insira sua chave de API e seu endpoint no campo apropriado no arquivo
Credentials.
Ao realizar o controle de qualidade da sua integração de SDK, use o SDK Debugger para solucionar problemas sem ativar o registro detalhado no seu app.
Editar esta página no GitHub