Atividades ao vivo para Swift

Aprenda como implementar Atividades ao Vivo para o SDK Swift da Braze. Atividades ao Vivo são notificações persistentes e interativas exibidas diretamente na tela de bloqueio, permitindo que os usuários recebam atualizações dinâmicas em tempo real—sem desbloquear o dispositivo.

Como funciona

As Live Activities apresentam uma combinação de informações estáticas e dinâmicas que você atualiza. Por exemplo, você pode criar uma Live Activity que fornece um rastreador de status para uma entrega. Essa Live Activity teria o nome da sua empresa como informação estática, bem como um “Tempo para entrega” dinâmico que seria atualizado à medida que o motorista de entrega se aproximasse do destino.

Como desenvolvedor, você pode usar a Braze para gerenciar os ciclos de vida das suas Live Activities, fazer chamadas para a API REST da Braze para realizar atualizações e fazer com que todos os dispositivos inscritos recebam a atualização o mais rápido possível. E, como você está gerenciando as Live Activities por meio da Braze, pode usá-las em conjunto com seus outros canais de envio de mensagens—notificações por push, mensagens no app, Cartões de conteúdo—para promover a adoção.

Diagrama de sequência

• live activities sequence diagram

---
config:
  theme: mc
---
sequenceDiagram
  participant Server as Client Server
  participant Device as User Device
  participant App as iOS App / Braze SDK
  participant BrazeAPI as Braze API
  participant APNS as Apple Push Notification Service
  Note over Server, APNS: Launch Option 1<br/>Locally Start Activities
  App ->> App: Register a Live Activity using <br>`launchActivity(pushTokenTag:activity:)`
  App ->> App: Get push token from iOS
  App ->> BrazeAPI: Activity ID & Push token<br>automatically sent to Braze
  Note over Server, APNS: Launch Option 2<br/>Remotely Start Activities
  Device ->> App: Call `registerPushToStart`<br>to collect push tokens early
  App ->> BrazeAPI: Push-to-start tokens sent to Braze
  Server ->> BrazeAPI: POST /messages/live_activity/start
  Note right of BrazeAPI: Payload includes:<br>- push_token<br>- activity_id<br>- external_id<br>- event_name<br>- content_state (optional)
  BrazeAPI ->> APNS: Live activity start request
  APNS ->> Device: APNS sends activity to device
  App ->> App: Get push token from iOS
  App ->> BrazeAPI: Activity ID & Push token<br>automatically sent to Braze
  Note over Server, APNS: Resuming activities upon app launch
  App ->> App: Call `resumeActivities(ofType:)` on each app launch
  Note over Server, APNS: Updating a Live Activity
  loop update a live activity
  Server ->> BrazeAPI: POST /messages/live_activity/update
  Note right of BrazeAPI: Payload includes changes<br>to ContentState (dynamic variables)
  BrazeAPI ->> APNS: Update sent to APNS
  APNS ->> Device: APNS sends update to device
  end
  Note over Server, APNS: Ending a Live Activity
  Server ->> BrazeAPI: POST /messages/live_activity/update
  Note right of BrazeAPI: Activity can be ended via:<br> - User manually dismisses<br>- Times out after 12 hours<br>- Setting `end_activity: true` on `/messages/live_activity/update`
  APNS ->> Device: Live activity is dismissed

Implementação de uma Live Activity

Pré-requisitos

Antes de poder usar esse recurso, você precisará integrar o Swift Braze SDK. Você também precisará completar o seguinte:

• Certifique-se de que seu projeto está direcionado para iOS 16.1 ou posterior.
• Adicione a autorização Push Notification em Signing & Capabilities no seu projeto Xcode.
• Certifique-se de que chaves .p8 são usadas para enviar notificações. Não há suporte para arquivos mais antigos, como .p12 ou .pem.
• A partir da versão 8.2.0 do SDK Swift da Braze, é possível registrar remotamente uma Live Activity. Para usar esse recurso, é necessário o iOS 17.2 ou posterior.

Etapa 1: Crie uma atividade

Primeiro, certifique-se de ter seguido o procedimento Exibindo dados ao vivo com Live Activities na documentação da Apple para configurar Live Activities no seu aplicativo iOS. Como parte dessa tarefa, inclua NSSupportsLiveActivities definido como YES no seu Info.plist.

Como a natureza exata da sua Live Activity será específica para o seu caso de negócios, você precisará configurar e inicializar os objetos Activity. É importante ressaltar que você definirá:

• ActivityAttributes: Esse protocolo define o conteúdo estático (imutável) e dinâmico (mutável) que aparecerá na sua Live Activity.
• ActivityAttributes.ContentState: Esse tipo define os dados dinâmicos que serão atualizados no decorrer da atividade.

Você também usará o SwiftUI para criar a apresentação da interface do usuário da tela de bloqueio e do Dynamic Island nos dispositivos compatíveis.

Certifique-se de estar familiarizado com os pré-requisitos e as limitações da Apple para Live Activities, pois essas restrições são independentes da Braze.

Exemplo

Vamos imaginar que queremos criar uma Live Activity para fornecer aos nossos usuários atualizações sobre o show Superb Owl, em que dois resgates de animais selvagens concorrentes recebem pontos pelas corujas que têm em sua residência. Neste exemplo, criamos uma struct chamada SportsActivityAttributes, mas você pode usar sua própria implementação de ActivityAttributes.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
#if canImport(ActivityKit)
  import ActivityKit
#endif

@available(iOS 16.1, *)
struct SportsActivityAttributes: ActivityAttributes {
  public struct ContentState: Codable, Hashable {
    var teamOneScore: Int
    var teamTwoScore: Int
  }

  var gameName: String
  var gameNumber: String
}

Etapa 2: Inicie a atividade

Primeiro, escolha como deseja registrar sua atividade:

• Remoto: Use o método registerPushToStart no início do ciclo de vida do usuário e antes que o token de push-to-start seja necessário, e então inicie uma atividade usando o endpoint /messages/live_activity/start.
• Local: Crie uma instância da sua Live Activity e, em seguida, use o método launchActivity para criar tokens push para a Braze gerenciar.

• remote
• local

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
import BrazeKit

#if canImport(ActivityKit)
  import ActivityKit
#endif

@available(iOS 16.1, *)
// 1. Add the `BrazeLiveActivityAttributes` conformance to your `ActivityAttributes` struct.
struct SportsActivityAttributes: ActivityAttributes, BrazeLiveActivityAttributes {
  public struct ContentState: Codable, Hashable {
    var teamOneScore: Int
    var teamTwoScore: Int
  }

  var gameName: String
  var gameNumber: String

  // 2. Add the `String?` property to represent the activity ID.
  var brazeActivityId: String?
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
import BrazeKit

#if canImport(ActivityKit)
  import ActivityKit
#endif

class LiveActivityManager {

  @available(iOS 17.2, *)
  func registerActivityType() {
    // This method returns a Swift background task.
    // You may keep a reference to this task if you need to cancel it wherever appropriate, or ignore the return value if you wish.
    let pushToStartObserver: Task = Self.braze?.liveActivities.registerPushToStart(
      forType: Activity<SportsActivityAttributes>.self,
      name: "SportsActivityAttributes"
    )
  }

}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
import BrazeKit

#if canImport(ActivityKit)
  import ActivityKit
#endif

class LiveActivityManager {
  
  @available(iOS 16.2, *)
  func createActivity() {
    let activityAttributes = SportsActivityAttributes(gameName: "Superb Owl", gameNumber: "Game 1")
    let contentState = SportsActivityAttributes.ContentState(teamOneScore: "0", teamTwoScore: "0")
    let activityContent = ActivityContent(state: contentState, staleDate: nil)
    if let activity = try? Activity.request(attributes: activityAttributes,
                                            content: activityContent,
      // Setting your pushType as .token allows the Activity to generate push tokens for the server to watch.
                                            pushType: .token) {
      // Register your Live Activity with Braze using the pushTokenTag.
      // This method returns a Swift background task.
      // You may keep a reference to this task if you need to cancel it wherever appropriate, or ignore the return value if you wish.
      let liveActivityObserver: Task = AppDelegate.braze?.liveActivities.launchActivity(pushTokenTag: "sports-game-2024-03-15",
                                                                                        activity: activity)
    }
  }
  
}

Etapa 3: Retome o rastreamento de atividades

Para garantir que a Braze rastreie sua Live Activity na inicialização do app:

1. Abra seu arquivo AppDelegate.
2. Importe o módulo ActivityKit se ele estiver disponível.
3. Chame resumeActivities(ofType:) em application(_:didFinishLaunchingWithOptions:) para todos os tipos de ActivityAttributes que você registrou no seu aplicativo.

Isso permite que a Braze retome as tarefas para rastrear atualizações de tokens push para todas as Live Activities ativas. Observe que, se um usuário tiver descartado explicitamente a Live Activity no dispositivo, ela será considerada removida e a Braze não a rastreará mais.

Exemplo

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
import UIKit
import BrazeKit

#if canImport(ActivityKit)
  import ActivityKit
#endif

@main
class AppDelegate: UIResponder, UIApplicationDelegate {

  static var braze: Braze? = nil

  func application(
    _ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
  ) -> Bool {
    
    if #available(iOS 16.1, *) {
      Self.braze?.liveActivities.resumeActivities(
        ofType: Activity<SportsActivityAttributes>.self
      )
    }

    return true
  }
}

Etapa 4: Atualize a atividade

O endpoint /messages/live_activity/update permite que você atualize uma Live Activity por meio de notificações por push enviadas pela API REST da Braze. Use esse endpoint para atualizar o ContentState da sua Live Activity.

Ao atualizar o ContentState, o widget da Live Activity exibirá as novas informações. Veja como seria o show Superb Owl no final do primeiro tempo.

Consulte nosso artigo sobre o endpoint /messages/live_activity/update para obter todos os detalhes.

Etapa 5: Encerre a atividade

Quando uma Live Activity está ativa, ela é exibida na tela de bloqueio do usuário e no Dynamic Island. Para encerrá-la pela Braze, use o endpoint /messages/live_activity/update com end_activity definido como true.

Para melhorar a confiabilidade ao encerrar uma Live Activity, siga estas etapas opcionais:

1. Opcionalmente, inclua dismissal_date na mesma solicitação de update para sugerir quando o iOS deve remover a interface da Live Activity.
2. Verifique os resultados de entrega no Registro de Atividades de Mensagem.

Organizando o descarte automático

Para organizar o descarte automático, agende uma solicitação de acompanhamento para o endpoint de atualização após iniciar a Live Activity.

1. Envie uma solicitação /messages/live_activity/start com um activity_id que você possa rastrear.
2. Armazene esse activity_id e o horário de encerramento desejado no agendador do seu backend.
3. No horário de encerramento desejado, envie uma solicitação /messages/live_activity/update com end_activity definido como true.
4. Configure a data de descarte na mesma solicitação de atualização. Para saber mais, consulte o endpoint /messages/live_activity/update.

Observe que o momento do descarte é controlado pelo iOS. Mesmo após enviar uma solicitação de encerramento válida, a remoção da tela de bloqueio ou do Dynamic Island pode ser atrasada ou se comportar de forma diferente com base em condições do sistema operacional.

Uma Live Activity também pode ser encerrada fora da Braze:

• Descarte pelo usuário: Um usuário pode descartar manualmente uma Live Activity.
• Tempo limite: Após um tempo padrão de 8 horas, o iOS removerá a Live Activity do Dynamic Island do usuário. Após um tempo padrão de 12 horas, o iOS removerá a Live Activity da tela de bloqueio do usuário.

Consulte nosso artigo sobre o endpoint /messages/live_activity/update para obter todos os detalhes.

Rastreamento de Live Activities

Os eventos de Live Activity estão disponíveis em Currents, Compartilhamento de Dados Snowflake e Criador de Consultas. Os eventos a seguir podem ajudar você a entender e monitorar o ciclo de vida das suas Live Activities, rastrear a disponibilidade de tokens e diagnosticar problemas ou verificar status de entrega de forma independente.

• Mudança de Token Push-to-Start de Live Activity: Captura quando um token push-to-start (PTS) é adicionado ou atualizado na Braze, permitindo que você rastreie registros e disponibilidade de tokens por usuário.
• Mudança de Token de Atualização de Live Activity: Rastreia a adição, atualização ou remoção de tokens de Atualização de Live Activity (LAU).
• Envio de Live Activity: Registra cada vez que uma Live Activity é iniciada, atualizada ou encerrada pela Braze.
• Resultado de Live Activity: Indica o status final de entrega ao serviço de Notificações por Push da Apple (APNs) para cada Live Activity enviada pela Braze.

Perguntas frequentes (FAQ)

Funcionalidade e suporte

Quais plataformas suportam Live Activities?

Atualmente, as Live Activities são um recurso específico do iOS e iPadOS. Por padrão, atividades lançadas em um iPhone ou iPad também serão exibidas em qualquer dispositivo watchOS 11+ ou macOS 26+ emparelhado.

O artigo sobre Live Activities aborda os pré-requisitos para o gerenciamento de Live Activities por meio do SDK Swift da Braze.

Os apps React Native são compatíveis com Live Activities?

Sim, o React Native SDK 3.0.0+ oferece suporte a Live Activities por meio do SDK Swift da Braze. Ou seja, você precisa escrever código React Native iOS diretamente sobre o SDK Swift da Braze.

Não há uma API de conveniência JavaScript específica do React Native para Live Activities porque os recursos de Live Activities fornecidos pela Apple usam linguagens intraduzíveis em JavaScript (por exemplo, concorrência Swift, genéricos, SwiftUI).

A Braze oferece suporte a Live Activities como uma campanha ou etapa do canva?

Não, isso não é suportado no momento.

Notificações por push e Live Activities

O que acontece se uma notificação por push for enviada enquanto uma Live Activity estiver ativa?

As Live Activities e as notificações por push ocupam espaços diferentes na tela e não entram em conflito na tela do usuário.

Se as Live Activities utilizam a funcionalidade de mensagens push, as notificações por push precisam estar ativadas para receber Live Activities?

Embora as Live Activities dependam de notificações por push para atualizações, elas são controladas por configurações de usuário diferentes. Um usuário pode aceitar Live Activities, mas não as notificações por push, e vice-versa.

Os tokens de atualização de Live Activity expiram após oito horas.

As Live Activities requerem push primers?

Os push primers são uma prática recomendada para solicitar que os usuários aceitem notificações por push do seu app. No entanto, não há nenhum prompt do sistema para aceitar Live Activities. Por padrão, os usuários aceitam Live Activities para um app individual quando instalam esse app no iOS 16.1 ou posterior. Essa permissão pode ser ativada ou desativada nas configurações do dispositivo por app.

Tópicos técnicos e solução de problemas

Como posso saber se as Live Activities têm erros?

Todos os erros de Live Activities serão registrados no dashboard da Braze no Registro de Atividades de Mensagem, onde é possível filtrar por “LiveActivity Errors”.

Depois de enviar uma notificação push-to-start, por que não recebi minha Live Activity?

Primeiro, verifique se sua carga útil inclui todos os campos obrigatórios descritos no endpoint messages/live_activity/start. Os campos activity_attributes e content_state devem corresponder às propriedades definidas no código do seu projeto. Se tiver certeza de que a carga útil está correta, é possível que você esteja sendo limitado pelos APNs. Esse limite é imposto pela Apple e não pela Braze.

Para verificar se a notificação push-to-start chegou com sucesso ao dispositivo, mas não foi exibida devido a limites de taxa, você pode depurar o projeto usando o app Console no Mac. Anexe o processo de gravação do dispositivo desejado e, em seguida, filtre os registros por process:liveactivitiesd na barra de pesquisa.

Depois de iniciar minha Live Activity com push-to-start, por que ela não está recebendo novas atualizações?

Verifique se você implementou corretamente as instruções descritas acima. Seu ActivityAttributes deve conter tanto a conformidade com o protocolo BrazeLiveActivityAttributes quanto a propriedade brazeActivityId.

Depois de receber uma notificação push-to-start de Live Activity, verifique se você consegue ver uma solicitação de rede de saída para o endpoint /push_token_tag da sua URL da Braze e se ela contém o ID da atividade correto no campo "tag".

Por fim, certifique-se de que o tipo de atributo da Live Activity na sua carga útil de atualização corresponda exatamente à string e à classe usadas na chamada do método do SDK para registerPushToStart. Use constantes para evitar erros de digitação.

Estou recebendo uma resposta de acesso negado quando tento usar o endpoint live_activity/update. Por quê?

As chaves de API que você usa precisam ter as permissões corretas para acessar os diferentes endpoints da API da Braze. Se estiver usando uma chave de API criada anteriormente, é possível que tenha se esquecido de atualizar as permissões. Leia nossa visão geral da segurança da chave de API para relembrar.

O endpoint messages/send compartilha os limites de taxa com o endpoint messages/live_activity/update?

Por padrão, o limite de taxa do endpoint messages/live_activity/update é de 250.000 solicitações por hora, por espaço de trabalho e em vários endpoints. Consulte os limites de taxa da API para obter mais informações.