Configuração inicial do SDK

Este artigo de referência aborda como instalar o SDK da Braze para tvOS. A instalação do SDK da Braze fornecerá a funcionalidade básica de análise de dados.

O SDK da Braze para tvOS deve ser instalado ou atualizado usando o CocoaPods, um gerenciador de dependências para projetos Objective C e Swift. O CocoaPods oferece mais simplicidade para integração e atualização.

Integração do SDK do tvOS com o CocoaPods

Etapa 1: Instalar o CocoaPods

A instalação do SDK por meio do tvOS CocoaPods automatiza a maior parte do processo de instalação para você. Antes de iniciar esse processo, verifique se você está usando a versão 2.0.0 ou superior do Ruby

Execute o seguinte comando para começar:

1
$ sudo gem install cocoapods

• Se o sistema pedir que você substitua o executável rake, consulte Getting Started (Como começar) em CocoaPods.org para obter mais detalhes.
• Se você tiver problemas relacionados ao CocoaPods, consulte o guia de solução de problemas do CocoaPods.

Etapa 2: Construindo o arquivo de pod

Agora que você instalou o CocoaPods Ruby Gem, precisará criar um arquivo no diretório do projeto Xcode chamado Podfile.

Adicione a seguinte linha ao seu Podfile:

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

Sugerimos que você faça uma versão da Braze para que as atualizações do pod capturem automaticamente qualquer coisa menor que uma atualização de versão secundária. Parece o site pod 'Appboy-tvOS-SDK' ~> Major.Minor.Build. Se quiser integrar automaticamente a versão mais recente do SDK da Braze, mesmo com grandes alterações, você poderá usar pod 'Appboy-tvOS-SDK' em seu Podfile.

Etapa 3: Instalação do SDK da Braze

Para instalar o SDK da Braze CocoaPods, navegue até o diretório do seu projeto de app do Xcode em seu terminal e execute o seguinte comando:

1
pod install

Nesse ponto, você deve conseguir abrir o novo espaço de trabalho do projeto Xcode criado pelo CocoaPods. Use esse espaço de trabalho do Xcode em vez de seu projeto do Xcode.

Etapa 4: Atualização do delegate do seu app

• 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)

Etapa 5: Especifique seu endpoint personalizado ou cluster de dados

Seu representante da Braze já deve ter informado sobre o endpoint correto.

Configuração do endpoint em tempo de compilação (recomendado)

Se for fornecido um ponto de extremidade personalizado pré-existente:

• A partir do SDK da Braze para iOS v3.0.2, você pode definir um endpoint personalizado usando o arquivo Info.plist. Adicione o dicionário Appboy ao seu arquivo Info.plist. Dentro do dicionário Appboy, adicione a subentrada Endpoint string e defina o valor para a autoridade de seus URLs de endpoint personalizados (por exemplo, sdk.iad-01.braze.com, não https://sdk.iad-01.braze.com).

Configuração do endpoint em tempo de execução

Se for fornecido um ponto de extremidade personalizado pré-existente:

• A partir da Braze iOS SDK v3.17.0+, você pode substituir a definição do seu endpoint por meio do ABKEndpointKey dentro do parâmetro appboyOptions passado para startWithApiKey:inApplication:withLaunchOptions:withAppboyOptions:. Defina o valor como sua autoridade de URL de endpoint personalizado (por exemplo, sdk.iad-01.braze.com, não https://sdk.iad-01.braze.com).

Integração completa de SDK

Agora, a Braze está coletando dados do seu aplicativo e sua integração básica está concluída. Note que, ao compilar seu app para tvOS e quaisquer outras bibliotecas de terceiros, o Bitcode deve ser ativado.

Atualizando o SDK do Braze via CocoaPods

Para atualizar um CocoaPod, basta executar os seguintes comandos no diretório do projeto:

1
pod update

Personalização do Braze na inicialização

Se desejar personalizar a Braze na inicialização, você poderá usar o método de inicialização da Braze startWithApiKey:inApplication:withLaunchOptions:withAppboyOptions e passar um NSDictionary opcional de chaves de inicialização da 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)

Esse método substituiria o método de inicialização startWithApiKey:inApplication:withLaunchOptions: e é chamado com os seguintes parâmetros:

• YOUR-API-KEY: A chave de API de seu aplicativo pode ser encontrada em Manage Settings (Gerenciar configurações) no dashboard do Braze.
• application: O app atual.
• launchOptions: As opções NSDictionary que você obtém em application:didFinishLaunchingWithOptions:.
• appboyOptions: Um site opcional NSDictionary com valores de configuração de inicialização para a Braze.

Veja Appboy.h para obter uma lista das teclas de inicialização da Braze.

Appboy.sharedInstance() e a anulabilidade do Swift

Diferentemente da prática comum, o singleton Appboy.sharedInstance() é opcional. Isso ocorre porque sharedInstance é nil antes da chamada de startWithApiKey:, e há algumas implementações não padronizadas, mas ainda válidas, nas quais uma inicialização postergada pode ser utilizada.

Se você chamar startWithApiKey: em seu delegado didFinishLaunchingWithOptions: antes de qualquer acesso ao sharedInstance do Appboy (a implementação padrão), poderá usar o encadeamento opcional, como Appboy.sharedInstance()?.changeUser("testUser"), para evitar verificações complicadas. Isso terá paridade com uma implementação em Objective-C que assume um sharedInstance não nulo.

Opções de integração manual

Você também pode integrar nosso tvOS SDK manualmente - basta obter a estrutura do nosso repositório público e inicializar a Braze conforme descrito nas seções anteriores.

Identificação de usuários e análise de dados

Consulte nossa documentação do iOS para obter informações sobre a definição de IDs de usuário, registro de eventos personalizados e definição de atributos de usuário. Recomendamos também que você se familiarize com nossas convenções de nomenclatura de eventos.