Skip to content


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

Etapa 2: Construindo o Podfile

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ê versione a Braze para que as atualizações do pod capturem automaticamente qualquer coisa menor que uma atualização de versão secundária. Isso se parece com 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 via 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 do seu projeto do Xcode.

Novo espaço de trabalho do projeto Xcode criado pelo CocoaPods. Use esse espaço de trabalho do Xcode em vez do seu projeto do Xcode.

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

Adicione a seguinte linha de código ao seu arquivo AppDelegate.m:

1

#import <AppboyTVOSKit/AppboyKit.h>

No arquivo AppDelegate.m, adicione o seguinte snippet no método application:didFinishLaunchingWithOptions:

1
2
3

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

Por fim, atualize YOUR-API-KEY com o valor correto na sua página Gerenciar configurações.

Se estiver integrando o SDK da Braze com o CocoaPods ou o Carthage, adicione a seguinte linha de código ao seu arquivo AppDelegate.swift:

1

import AppboyTVOSKit

Para saber mais sobre o uso de código Objective-C em projetos Swift, consulte os documentos para desenvolvedores da Apple.

Em AppDelegate.swift, adicione o seguinte snippet ao seu application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool:

1

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

Em seguida, atualize YOUR-API-KEY com o valor correto na sua página Gerenciar configurações.

Nosso singleton sharedInstance será nulo antes de startWithApiKey: ser chamado, pois esse é um pré-requisito para usar qualquer funcionalidade da Braze.

Etapa 5: Especifique seu endpoint personalizado ou cluster de dados

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

Se for fornecido um endpoint 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 de string Endpoint e defina o valor para a autoridade dos 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 endpoint personalizado pré-existente:

  • A partir do SDK da Braze para iOS 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 a autoridade do URL do seu endpoint personalizado (por exemplo, sdk.iad-01.braze.com, não https://sdk.iad-01.braze.com).

Integração do SDK concluída

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 da Braze via CocoaPods

Para atualizar um CocoaPod, basta executar o seguinte comando no diretório do projeto:

1

pod update

Personalização da 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.

Em seu arquivo AppDelegate.m, no método application:didFinishLaunchingWithOptions, adicione o seguinte método da Braze:

1
2
3
4

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

Em AppDelegate.swift, no método application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool, adicione o seguinte método da Braze:

1
2
3
4

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

em que appboyOptions é um Dictionary de valores de configuração de inicialização.

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 do seu aplicativo pode ser encontrada em Gerenciar configurações no dashboard da Braze.
  • application: O app atual.
  • launchOptions: As opções NSDictionary que você obtém em application:didFinishLaunchingWithOptions:.
  • appboyOptions: Um NSDictionary opcional com valores de configuração de inicialização para a Braze.

Veja Appboy.h para obter uma lista das chaves 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 SDK do tvOS manualmente — basta obter o framework 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.
New Stuff!