AppboyKit (también conocido como SDK Objective-C) ya no recibe soporte y ha sido sustituido por Swift SDK. Ya no recibirá nuevas características, correcciones de errores, actualizaciones de seguridad ni soporte técnico; sin embargo, la mensajería y los análisis seguirán funcionando con normalidad. Para obtener más información, consulta Presentación del nuevo SDK Swift de Braze.
Completa la integración.
Antes de seguir estos pasos, asegúrate de haber integrado el SDK mediante Carthage, CocoaPods, Swift Package Manager o una integración manual.
Paso 1: Actualiza el delegado de tu aplicación
Si estás integrando el SDK de Braze con CocoaPods, Carthage o con una integración manual dinámica, añade la siguiente línea de código a tu archivo AppDelegate.m:
1
#import "Appboy-iOS-SDK/AppboyKit.h"
Si estás integrando con Swift Package Manager o con una integración manual estática, utiliza esta línea en su lugar:
1
#import "AppboyKit.h"
A continuación, dentro de tu archivo AppDelegate.m, añade el siguiente fragmento de código dentro de tu método application:didFinishLaunchingWithOptions::
1
2
3
[Appboy startWithApiKey:@"YOUR-APP-IDENTIFIER-API-KEY"
inApplication:application
withLaunchOptions:launchOptions];
Actualiza YOUR-APP-IDENTIFIER-API-KEY con el valor correcto desde tu página Administrar configuración. Consulta nuestra documentación sobre la API para obtener más información sobre dónde encontrar la clave de API del identificador de tu aplicación.
Si estás integrando el SDK de Braze con CocoaPods, Carthage o con una integración manual dinámica, añade la siguiente línea de código a tu archivo AppDelegate.swift:
1
import Appboy_iOS_SDK
Si estás integrando con Swift Package Manager o con una integración manual estática, utiliza esta línea en su lugar:
1
import AppboyKit
Consulta la documentación para desarrolladores de Apple para obtener más información sobre el uso de código Objective-C en proyectos Swift.
A continuación, en AppDelegate.swift, añade el siguiente fragmento de código a tu application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool:
1
Appboy.start(withApiKey: "YOUR-APP-IDENTIFIER-API-KEY", in:application, withLaunchOptions:launchOptions)
Actualiza YOUR-APP-IDENTIFIER-API-KEY con el valor correcto desde tu página Administrar configuración. Consulta nuestra documentación sobre la API para obtener más información sobre dónde encontrar la clave de API del identificador de tu aplicación.
El singleton sharedInstance será nulo antes de llamar a startWithApiKey:, ya que es un requisito previo para utilizar cualquier función de Braze.
Asegúrate de inicializar Braze en el hilo principal de tu aplicación. Inicializar de forma asíncrona puede provocar fallos en la funcionalidad.
Paso 2: Especifica tu clúster de datos
Ten en cuenta que, a partir de diciembre de 2019, ya no se proporcionarán puntos finales personalizados. Si tienes un punto final personalizado preexistente, puedes seguir utilizándolo. Para más detalles, consulta nuestra lista de puntos finales disponibles.
Configuración del punto final en tiempo de compilación (recomendado)
Si se te da un punto final personalizado preexistente:
- A partir de la versión 3.0.2 del SDK iOS de Braze, puedes establecer un punto final personalizado utilizando el archivo
Info.plist. Añade el diccionarioBrazea tu archivoInfo.plist. Dentro del diccionarioBraze, añade la subentrada de cadenaEndpointy establece el valor en la autoridad de la URL de tu punto final personalizado (por ejemplo,sdk.iad-01.braze.com, nohttps://sdk.iad-01.braze.com). Ten en cuenta que antes de la versión 4.0.2 del SDK iOS de Braze, se debe utilizar la clave de diccionarioAppboyen lugar deBraze.
Tu representante de Braze ya debería haberte indicado el punto final correcto.
Configuración del punto final en tiempo de ejecución
Si se te da un punto final personalizado preexistente:
- A partir de la versión 3.17.0 del SDK iOS de Braze, puedes anular la configuración de tu punto final a través de
ABKEndpointKeydentro del parámetroappboyOptionspasado astartWithApiKey:inApplication:withLaunchOptions:withAppboyOptions:. Establece el valor de la autoridad de la URL de tu punto final personalizado (por ejemplo,sdk.iad-01.braze.com, nohttps://sdk.iad-01.braze.com).
Integración de SDK completa
Ahora Braze debería estar recopilando datos de tu aplicación, y tu integración básica debería estar completa. Consulta los artículos siguientes para habilitar el seguimiento de eventos personalizado, la mensajería push y la línea completa de características de Braze.
Personalizar Braze al iniciarse
Si deseas personalizar Braze al iniciarse, puedes utilizar en su lugar el método de inicialización de Braze startWithApiKey:inApplication:withLaunchOptions:withAppboyOptions: y pasar un NSDictionary opcional de claves de inicio de Braze.
En tu archivo AppDelegate.m, dentro de tu método application:didFinishLaunchingWithOptions:, añade el siguiente método Braze:
1
2
3
4
[Appboy startWithApiKey:@"YOUR-APP-IDENTIFIER-API-KEY"
inApplication:application
withLaunchOptions:launchOptions
withAppboyOptions:appboyOptions];
Nota que este método sustituiría al método de inicialización startWithApiKey:inApplication:withLaunchOptions:.
En AppDelegate.swift, dentro de tu método application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool, añade el siguiente método Braze donde appboyOptions es un Dictionary de valores de configuración de inicio:
1
2
3
4
Appboy.start(withApiKey: "YOUR-APP-IDENTIFIER-API-KEY",
in:application,
withLaunchOptions:launchOptions,
withAppboyOptions:appboyOptions)
Nota que este método sustituiría al método de inicialización startWithApiKey:inApplication:withLaunchOptions:.
Este método se llama con los siguientes parámetros:
YOUR-APP-IDENTIFIER-API-KEY- Tu clave de API identificadora de la aplicación desde el panel de Braze.application- La aplicación actual.launchOptions- Las opcionesNSDictionaryque obtienes deapplication:didFinishLaunchingWithOptions:.appboyOptions- UnNSDictionaryopcional con valores de configuración de inicio para Braze.
Consulta Appboy.h para ver una lista de las teclas de inicio de Braze.
Appboy.sharedInstance() y anulabilidad Swift
A diferencia de la práctica habitual, el singleton Appboy.sharedInstance() es opcional. Esto se debe a que sharedInstance es nil antes de que se llame a startWithApiKey:, y hay algunas implementaciones no estándar pero no inválidas en las que se puede utilizar una inicialización retardada.
Si llamas a startWithApiKey: en tu delegado didFinishLaunchingWithOptions: antes de cualquier acceso a sharedInstance de Appboy (la implementación estándar), puedes utilizar el encadenamiento opcional, como Appboy.sharedInstance()?.changeUser("testUser"), para evitar comprobaciones engorrosas. Esto tendrá paridad con una implementación de Objective-C que haya asumido un sharedInstance no nulo.
Recursos adicionales
La documentación completa de las clases de iOS está disponible para proporcionar orientación adicional sobre cualquier método del SDK.
Editar esta página en GitHub