Referencias, repositorios y aplicaciones de ejemplo
Esta es una lista de documentación de referencia, repositorios de GitHub y aplicaciones de ejemplo pertenecientes a cada SDK de Braze. La documentación de referencia de un SDK detalla sus clases, tipos, funciones y variables disponibles. Mientras que el repositorio de GitHub proporciona información sobre las declaraciones de funciones y atributos, los cambios de código y las versiones de ese SDK. Cada repositorio incluye también aplicaciones de ejemplo totalmente compilables que puedes utilizar para probar las características de Braze o implementarlas junto con tus propias aplicaciones.
Lista de recursos
Actualmente, algunos SDK no tienen documentación de referencia específica, pero estamos trabajando activamente en ello.
Plataforma | Referencia | Repositorio | Ejemplo de aplicación |
---|---|---|---|
SDK para Android | Documentación de referencia | Repositorio GitHub | Ejemplo de aplicación |
SDK de Swift | Documentación de referencia | Repositorio GitHub | Ejemplo de aplicación |
SDK Web | Documentación de referencia | Repositorio GitHub | Ejemplo de aplicación |
SDK de Cordova | Archivo de declaración | Repositorio GitHub | Ejemplo de aplicación |
SDK de Flutter | Documentación de referencia | Repositorio GitHub | Ejemplo de aplicación |
SDK nativo de React | Archivo de declaración | Repositorio GitHub | Ejemplo de aplicación |
SDK de Roku | N/A | Repositorio GitHub | Ejemplo de aplicación |
SDK de Unity | Archivo de declaración | Repositorio GitHub | Ejemplo de aplicación |
SDK de Unreal Engine | N/A | Repositorio GitHub | Ejemplo de aplicación |
SDK de Xamarin | N/A | Repositorio GitHub | Ejemplo de aplicación |
Construir una aplicación de ejemplo
Construyendo a “Droidboy”
Nuestra aplicación de prueba dentro del repositorio SDKBraze 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 la API Braze.
- Copia tu ID de remitente del FCM y la clave de identificador de la API de Braze en los lugares adecuados dentro de
/droidboy/res/values/braze.xml
(entre las etiquetas de las cadenas denominadascom_braze_push_fcm_sender_id
ycom_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 assemble
dentro del directorio del SDK. Utilizagradlew.bat
en Windows. - Para instalar automáticamente el APK de Droidboy en un dispositivo de prueba, ejecuta
./gradlew installDebug
dentro del directorio del SDK:
Construir “Hola 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.xml
de la carpetares/values
. - Para instalar la aplicación de muestra 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_HOME
o no tienes una carpetalocal.properties
con una carpetasdk.dir
válida, este complemento también instalará el SDK base por ti. Consulta el repositorio de plugins para obtener más información.
Para obtener más información sobre el sistema de compilación del SDK de Android, consulta el README del repositorio de GitHub.
Creación de aplicaciones Swift de prueba
Sigue estas instrucciones para crear y ejecutar nuestras aplicaciones de prueba.
- Crea un nuevo espacio de trabajo y anota la clave de API y el punto final del identificador de la aplicación.
- Según tu método de integración (Swift Package Manager, CocoaPods, Manual), selecciona el archivo
xcodeproj
adecuado para abrirlo. - Coloca tu clave de API y tu punto final en el campo correspondiente del archivo
Credentials
.
Mientras realizas el control de calidad de tu integración de SDK, utiliza el depurador de SDK para solucionar problemas sin activar el registro detallado de tu aplicación.