Configuración inicial del SDK

En este artículo de referencia se explica cómo instalar el SDK de Braze para tvOS. La instalación del SDK de Braze te proporcionará una funcionalidad básica de análisis.

El SDK Braze de tvOS debe instalarse o actualizarse mediante CocoaPods, un administrador de dependencias para proyectos Objective-C y Swift. CocoaPods proporciona una mayor simplicidad para la integración y la actualización.

Integración del SDK de tvOS en CocoaPods

Paso 1: Instalar CocoaPods

La instalación del SDK a través de los CocoaPods de tvOS automatiza la mayor parte del proceso de instalación por ti. Antes de comenzar este proceso, asegúrate de que utilizas la versión de Ruby 2.0.0 o superior.

Ejecuta el siguiente comando para empezar:

1
$ sudo gem install cocoapods

• Si se te pide que sobrescribas el ejecutable rake, consulta Introducción en CocoaPods.org para más detalles.
• Si tienes problemas relacionados con CocoaPods, consulta la guía de solución de problemas de CocoaPods.

Paso 2: Construir el archivo de bibliotecas

Ahora que has instalado la Gema Ruby de CocoaPods, tendrás que crear un archivo en el directorio de tu proyecto de Xcode llamado Podfile.

Añade la siguiente línea a tu archivo de bibliotecas:

1
2
3
target 'YourAppTarget' do
  pod 'Appboy-tvOS-SDK'
end

Te sugerimos que versiones Braze para que las actualizaciones de vainas cojan automáticamente cualquier cosa menor que una actualización de versión menor. Esto parece pod 'Appboy-tvOS-SDK' ~> Major.Minor.Build. Si quieres integrar automáticamente la última versión del SDK de Braze, incluso con cambios importantes, puedes utilizar pod 'Appboy-tvOS-SDK' en tu archivo de bibliotecas.

Paso 3: Instalación del SDK de Braze

Para instalar los SDK de Braze CocoaPods, ve al directorio de tu proyecto de aplicación Xcode en tu terminal y ejecuta el siguiente comando:

1
pod install

En este punto, deberías poder abrir el nuevo espacio de trabajo del proyecto Xcode creado por CocoaPods. Asegúrate de utilizar este espacio de trabajo de Xcode en lugar de tu proyecto de Xcode.

Paso 4: Actualizar el delegado de tu aplicación

• objective-c
• swift

1
#import <AppboyTVOSKit/AppboyKit.h>

1
2
3
[Appboy startWithApiKey:@"YOUR-API-KEY"
         inApplication:application
     withLaunchOptions:launchOptions];

1
import AppboyTVOSKit

1
Appboy.start(withApiKey: "YOUR-API-KEY", in:application, withLaunchOptions:launchOptions)

Paso 5: Especifica tu punto final personalizado o clúster de datos

Tu representante de Braze ya debería haberte informado del punto final correcto.

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 diccionario Appboy a tu archivo Info.plist. Dentro del diccionario Appboy, añade la subentrada de cadena Endpoint y establece el valor a tu autoridad de URL de punto final personalizada (por ejemplo, sdk.iad-01.braze.com, no https://sdk.iad-01.braze.com).

Configuración del punto final en tiempo de ejecución

Si se le 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 ABKEndpointKey dentro del parámetro appboyOptions pasado a startWithApiKey:inApplication:withLaunchOptions:withAppboyOptions:. Establece el valor a tu autoridad de URL de punto final personalizada (por ejemplo, sdk.iad-01.braze.com, no https://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. Ten en cuenta que al compilar tu aplicación tvOS y cualquier otra biblioteca de terceros, Bitcode debe estar habilitado.

Actualizar el SDK de Braze mediante CocoaPods

Para actualizar un CocoaPod, simplemente ejecuta los siguientes comandos dentro del directorio de tu proyecto:

1
pod update

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.

• objective-c
• swift

1
2
3
4
[Appboy startWithApiKey:@"YOUR-API-KEY"
          inApplication:application
      withLaunchOptions:launchOptions
      withAppboyOptions:appboyOptions];

1
2
3
4
Appboy.start(withApiKey: "YOUR-API-KEY",
                 in:application,
                 withLaunchOptions:launchOptions,
                 withAppboyOptions:appboyOptions)

Este método sustituiría al método de inicialización startWithApiKey:inApplication:withLaunchOptions: y se llama con los siguientes parámetros:

• YOUR-API-KEY: La clave de API de tu aplicación se encuentra en Administrar configuración en el panel de Braze.
• application: La aplicación actual.
• launchOptions: Las opciones NSDictionary que obtienes de application:didFinishLaunchingWithOptions:.
• appboyOptions: Un NSDictionary opcional 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.

Opciones de integración manual

También puedes integrar nuestro SDK para tvOS manualmente: simplemente coge el Framework de nuestro Repositorio Público e inicializa Braze como se indica en las secciones anteriores.

Identificador de usuarios y análisis de informes

Consulta nuestra documentación de iOS para obtener información sobre la configuración de ID de usuario, el registro de eventos personalizados y la configuración de atributos de usuario. También te recomendamos que te familiarices con nuestras convenciones de denominación de eventos.