Referencias, repositorios y aplicaciones de ejemplo
Esta es una lista de documentación de referencia, repositorios GitHub y aplicaciones de ejemplo pertenecientes a cada SDK de Braze. La documentación de referencia de un SDK detalla las clases, tipos, funciones y variables disponibles. El repositorio GitHub proporciona información sobre las declaraciones de funciones y atributos de ese SDK, los cambios en el código y el versionado. Cada repositorio también incluye aplicaciones de ejemplo totalmente compilables que puedes utilizar para probar las características de Braze o implementar junto con tus propias aplicaciones.
Lista de recursos
Actualmente, algunos SDK no cuentan con documentación de referencia específica, pero estamos trabajando activamente para solucionarlo.
| Plataforma | Referencia | Repositorio | Aplicación de ejemplo |
|---|---|---|---|
| SDK para Android | Documentación de referencia | Repositorio GitHub | Aplicación de ejemplo |
| SDK de Swift | Documentación de referencia | Repositorio GitHub | Aplicación de ejemplo |
| SDK Web | Documentación de referencia | Repositorio GitHub | Aplicación de ejemplo |
| SDK de Cordova | Archivo de declaración | Repositorio GitHub | Aplicación de ejemplo |
| SDK de Flutter | Documentación de referencia | Repositorio GitHub | Aplicación de ejemplo |
| SDK de React Native | Archivo de declaración | Repositorio GitHub | Aplicación de ejemplo |
| SDK de Roku | N/A | Repositorio GitHub | Aplicación de ejemplo |
| SDK de Unity | Archivo de declaración | Repositorio GitHub | Aplicación de ejemplo |
| SDK de .NET MAUI (antes Xamarin) | N/A | Repositorio GitHub | Aplicación de ejemplo |
Creación de una aplicación de ejemplo
Compilar “Droidboy”
Nuestra aplicación de prueba dentro del repositorio GitHub del SDK para Android se llama Droidboy. Sigue estas instrucciones para crear una copia totalmente funcional junto a tu proyecto.
- Crea un nuevo espacio de trabajo y anota la clave de identificador de API de Braze.
- Copia tu ID de remitente de FCM y la clave de identificador de API de Braze en los lugares correspondientes dentro de
/droidboy/res/values/braze.xml(entre las etiquetas de las cadenas denominadascom_braze_push_fcm_sender_idycom_braze_api_key, respectivamente). - Copia la clave de tu servidor FCM y el ID del servidor en la configuración de tu espacio de trabajo, en Administrar configuración.
- Para montar el APK de Droidboy, ejecuta
./gradlew assembledentro del directorio del SDK. Utilizagradlew.baten Windows. - Para instalar automáticamente el APK de Droidboy en un dispositivo de prueba, ejecuta
./gradlew installDebugdentro del directorio del SDK:
Compilar “Hello Braze”
La aplicación de prueba Hello Braze muestra un caso de uso mínimo del SDK de Braze y, además, muestra cómo integrar fácilmente el SDK de Braze en un proyecto Gradle.
- Copia tu clave de identificador de API de la página Administrar configuración en tu archivo
braze.xmlde la carpetares/values.
- Para instalar la aplicación de ejemplo en un dispositivo o emulador, ejecuta el siguiente comando dentro del directorio del SDK:
1
./gradlew installDebug
Si no tienes bien configurada la variable
ANDROID_HOMEo no tienes una carpetalocal.propertiescon una carpetasdk.dirválida, este complemento también instalará el SDK base por ti. Consulta el repositorio del complemento para obtener más información.
Para obtener más información sobre el sistema de compilación del SDK para Android, consulta el README del repositorio de GitHub.
Compilar las aplicaciones de prueba de Swift
Sigue estas instrucciones para compilar y ejecutar nuestras aplicaciones de prueba.
- Crea un nuevo espacio de trabajo y anota la clave de API del identificador de la aplicación y el punto de conexión.
- Según tu método de integración (Swift Package Manager, CocoaPods, manual), selecciona el archivo
xcodeprojadecuado para abrirlo. - Coloca tu clave de API y tu punto de conexión en el campo correspondiente del archivo
Credentials.
Mientras realizas el control de calidad de tu integración de SDK, utiliza el depurador del SDK para solucionar problemas sin activar el registro detallado de tu aplicación.
Editar esta página en GitHub