Notificações de Rich push

Pré-requisitos

Antes de poder usar esse recurso, você precisará integrar o Braze Swift SDK. Você também precisará configurar notificações por push.

Configuração de notificações por push ricas

Etapa 1: Criar uma extensão de serviço

Para criar uma extensão de serviço de notificação, acesse File > New > Target no Xcode e selecione Notification Service Extension.

Confira se a opção Embed In Application está configurada para incorporar a extensão ao seu aplicativo.

Etapa 2: Configurar a extensão de serviço de notificação

Uma extensão de serviço de notificação é um binário próprio, empacotado junto com o seu app. Ela precisa ser configurada no Apple Developer Portal com seu próprio ID de app e perfil de provisionamento.

O ID do bundle da extensão de serviço de notificação precisa ser diferente do ID do bundle do target principal do seu app. Por exemplo, se o ID do bundle do seu app for com.company.appname, você pode usar com.company.appname.AppNameServiceExtension para a sua extensão de serviço.

Etapa 3: Adicionar um App Group

No Xcode, adicione a capacidade App Groups pelo painel Signing & Capabilities ao target principal do seu app e também ao target da Notification Service Extension. Depois, clique no botão +. Use o ID do bundle do seu app para criar o App Group. Por exemplo, se o ID do bundle do seu app for com.company.appname, você pode nomear o App Group como group.com.company.appname.xyz.

Importante

Neste contexto, App Groups se refere ao App Groups Entitlement da Apple, e não ao ID do seu espaço de trabalho (antigo grupo de apps) da Braze.

Você precisa de um App Group compartilhado para que o app principal e a Notification Service Extension possam acessar dados compartilhados. Se você não adicionar seu app a um App Group, ele pode não conseguir preencher determinados campos da carga útil do push e não funcionará totalmente como esperado.

Etapa 4: Integrar notificações por push ricas

Para um guia passo a passo sobre como integrar notificações por push ricas com BrazeNotificationService, consulte nosso tutorial.

Para ver um exemplo, confira o uso em NotificationService no nosso app de exemplos.

Adicionar o framework de push rico ao seu app

• swift package manager
• cocoapods
• manual

Depois de seguir o guia de integração do Swift Package Manager, adicione BrazeNotificationService à sua Notification Service Extension da seguinte forma:

1. No Xcode, em frameworks and libraries, selecione o ícone de adição para adicionar um framework.
   
   
   
   

2. Selecione o framework “BrazeNotificationService”.
   
   

Adicione o seguinte ao seu Podfile:

1
2
3
4
5
6
7
8
9
10
11
12
13
14

target 'YourAppTarget' do
  pod 'BrazeKit'
  pod 'BrazeUI'
  pod 'BrazeLocation'
end

target 'YourNotificationServiceExtensionTarget' do
  pod 'BrazeNotificationService'
end

# Only include the below if you want to also integrate Push Stories
target 'YourNotificationContentExtensionTarget' do
  pod 'BrazePushStory'
end

Nota

Para saber mais sobre a implementação de Push Stories, consulte Push Stories.

Depois de atualizar o Podfile, acesse o diretório do projeto do seu app Xcode no terminal e execute pod install.

Para adicionar BrazeNotificationService.xcframework à sua Notification Service Extension, consulte Integração manual.

Solução de problemas em projetos Xcode gerados

Se você gera seu projeto Xcode com ferramentas de build como o Tuist, confirme que o projeto gerado mantém BrazeNotificationService vinculado ao target da sua Notification Service Extension e preserva os recursos dele no bundle da extensão. Algumas estruturas de projeto geradas podem colocar recursos em bundles inesperados. Nesse caso, os ativos de push rico podem não carregar em tempo de execução.

Confira os seguintes recursos para obter ajuda:

• Repositório do SDK Swift da Braze
• Exemplos do SDK Swift da Braze para Notification Service Extension
• Rastreador de issues do SDK Swift da Braze

Usar sua própria UNNotificationServiceExtension

Se você precisar usar sua própria UNNotificationServiceExtension, pode chamar brazeHandle no seu método didReceive.

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

import BrazeNotificationService
import UserNotifications

class NotificationService: UNNotificationServiceExtension {

  override func didReceive(
    _ request: UNNotificationRequest,
    withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void
  ) {
    if brazeHandle(request: request, contentHandler: contentHandler) {
      return
    }

    // Custom handling here

    contentHandler(request.content)
  }
}

Etapa 5: Configurar o App Group na Braze

Antes de inicializar a Braze, atribua o nome do seu App Group à propriedade push.appGroup da configuração da Braze.

1
2
3
4

let configuration = Braze.Configuration(apiKey: "<YOUR-BRAZE-API-KEY>",
                                        endpoint: "<YOUR-BRAZE-ENDPOINT>")
configuration.push.appGroup = "REPLACE_WITH_APPGROUP"
let braze = Braze(configuration: configuration)

Etapa 6: Criar uma notificação Rich no seu dashboard

Sua equipe de marketing também pode criar notificações Rich pelo dashboard. Crie uma notificação por push no criador de push e anexe uma imagem ou GIF, ou informe uma URL que hospede uma imagem, GIF ou vídeo. Os ativos são baixados no recebimento das notificações por push. Portanto, se você hospeda seu próprio conteúdo, planeje-se para picos grandes e simultâneos de solicitações.