Esta página foi traduzida automaticamente e pode conter imprecisões. Para relatar um erro de tradução, use o componente de feedback na parte inferior do sumário, à direita da página.

Aviso

AppboyKit (também conhecido como o SDK Objective-C) não é mais suportado e foi substituído pelo Swift SDK. Não receberá mais novos recursos, correções de bugs, atualizações de segurança ou suporte técnico—no entanto, o envio de mensagens e a análise de dados continuarão a funcionar normalmente. Para saber mais, veja Apresentando o Novo SDK Braze Swift.

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.

Nota

Nosso SDK do tvOS atualmente oferece suporte à funcionalidade de análise de dados. Para adicionar um app para tvOS em seu dashboard, abra um ticket de suporte.

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 para tvOS com CocoaPods

Etapa 1: Instale o CocoaPods

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

Execute o seguinte comando para começar:

$ sudo gem install cocoapods

Se for solicitado a substituir o executável rake, consulte Getting started no CocoaPods.org para mais detalhes.
Se você tiver problemas com o CocoaPods, consulte o guia de solução de problemas do CocoaPods.

Etapa 2: Criação do Podfile

Agora que você instalou a gem Ruby do CocoaPods, será necessário criar um arquivo chamado Podfile no diretório do seu projeto Xcode.

Adicione a seguinte linha ao seu Podfile:

target 'YourAppTarget' do
  pod 'Appboy-tvOS-SDK'
end

Sugerimos que você versione a Braze para que as atualizações do pod capturem automaticamente qualquer atualização menor que uma versão minor. A configuração fica assim: pod 'Appboy-tvOS-SDK' ~> Major.Minor.Build. Se quiser integrar automaticamente a versão mais recente do SDK da Braze, mesmo com mudanças maiores, você pode usar pod 'Appboy-tvOS-SDK' no seu Podfile.

Etapa 3: Instalação do SDK da Braze

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

pod install

Neste ponto, você deve conseguir abrir o novo espaço de trabalho do projeto Xcode criado pelo CocoaPods. Certifique-se de usar esse espaço de trabalho do Xcode em vez do seu projeto Xcode.

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

#import <AppboyTVOSKit/AppboyKit.h>

No seu arquivo AppDelegate.m, adicione o seguinte snippet dentro do método application:didFinishLaunchingWithOptions:

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

Por fim, atualize YOUR-API-KEY com o valor correto da sua página Manage Settings.

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

import AppboyTVOSKit

Para saber mais sobre o uso de código Objective-C em projetos Swift, consulte a documentação da Apple para desenvolvedores.

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

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

Em seguida, atualize YOUR-API-KEY com o valor correto da sua página Manage Settings.

Nosso singleton sharedInstance será nil antes que startWithApiKey: seja chamado, pois isso é um pré-requisito para usar qualquer funcionalidade da Braze.

Aviso

Certifique-se de inicializar a Braze na thread principal do seu aplicativo. A inicialização assíncrona pode resultar em funcionalidades com defeito.

Etapa 5: Especifique seu endpoint personalizado ou cluster de dados

Nota

Desde dezembro de 2019, endpoints personalizados não são mais fornecidos. Se você tem um endpoint personalizado pré-existente, pode continuar a usá-lo. Para saber mais, consulte nossa lista de endpoints disponíveis.

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

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

Se você recebeu um endpoint personalizado pré-existente:

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

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

Se você recebeu um endpoint personalizado pré-existente:

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

Nota

O suporte para definir endpoints em tempo de execução usando ABKAppboyEndpointDelegate foi removido no SDK iOS da Braze v3.17.0. Se você já usa ABKAppboyEndpointDelegate, observe que nas versões v3.14.1 a v3.16.0 do SDK iOS da Braze, qualquer referência a dev.appboy.com no seu método getApiEndpoint() deve ser substituída por uma referência a sdk.iad-01.braze.com.

Integração do SDK concluída

A Braze agora deve estar coletando dados do seu aplicativo, e sua integração básica deve estar concluída. Observe que, ao compilar seu app tvOS e quaisquer outras bibliotecas de terceiros, o Bitcode deve estar ativado.

Atualizando o SDK da Braze via CocoaPods

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

pod update

Personalizando a Braze na inicialização

Se quiser personalizar a Braze na inicialização, você pode 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

No arquivo AppDelegate.m, dentro do método application:didFinishLaunchingWithOptions, adicione o seguinte método da Braze:

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

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

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

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

Esse método substitui 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 Manage Settings no dashboard da Braze.
application: O app atual.
launchOptions: O NSDictionary de opções que você obtém de application:didFinishLaunchingWithOptions:.
appboyOptions: Um NSDictionary opcional com valores de configuração de inicialização para a Braze.

Consulte Appboy.h para ver a lista de chaves de inicialização da Braze.

Appboy.sharedInstance() e nullability no Swift

Diferente da prática comum, o singleton Appboy.sharedInstance() é opcional. Isso ocorre porque sharedInstance é nil antes de startWithApiKey: ser chamado, e existem algumas implementações não convencionais — mas válidas — em que uma inicialização tardia pode ser usada.

Se você chamar startWithApiKey: no delegate didFinishLaunchingWithOptions: antes de qualquer acesso ao sharedInstance do Appboy (a implementação padrão), é possível usar optional chaining, como Appboy.sharedInstance()?.changeUser("testUser"), para evitar verificações trabalhosas. Isso terá paridade com uma implementação em Objective-C que presumia um sharedInstance não nulo.

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

Identificando usuários e reportando análise de dados

Consulte nossa documentação do iOS para informações sobre como definir IDs de usuário, registrar eventos personalizados e definir atributos de usuário. Também recomendamos que você se familiarize com nossas convenções de nomenclatura de eventos.

New Stuff!