Notificações de Rich push

Pré-requisitos

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

Configurando notificações por push ricas

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

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

Certifique-se de que Embed In Application esteja definido para incorporar a extensão em seu aplicativo.

Etapa 2: Configuração da extensão do serviço de notificação

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

O ID do pacote da extensão do serviço de notificação deve ser diferente do ID do pacote do alvo principal do seu app. Por exemplo, se o ID do pacote do seu app for com.company.appname, você poderá usar com.company.appname.AppNameServiceExtension para a extensão do serviço.

Etapa 3: Adicionando um grupo de apps

No Xcode, adicione a capacidade de Grupos de Apps no painel Signing & Capabilities ao seu alvo principal do app, bem como ao alvo da Extensão de Serviço de Notificação. Em seguida, clique no botão +. Use o ID do pacote do seu app para criar o grupo de apps. Por exemplo, se o ID do pacote do seu app for com.company.appname, você pode nomear seu grupo de apps group.com.company.appname.xyz.

Importante

Grupos de apps neste contexto referem-se à App Groups Entitlement da Apple e não ao seu ID de espaço de trabalho da Braze (anteriormente grupo de apps).

Você precisa de um grupo de apps compartilhado para que seu app principal e a Extensão de Serviço de Notificação possam acessar dados compartilhados. Se você não adicionar seu app a um grupo de apps, seu app pode falhar ao preencher certos campos da carga útil do push e não funcionará totalmente como esperado.

Etapa 4: Integração de notificações por push ricas

Para obter um guia passo a passo sobre a integração de notificações por push ricas com BrazeNotificationService, consulte nosso tutorial.

Para ver um exemplo, consulte o uso em NotificationService do nosso app Examples.

Adição do framework de rich push 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 fazendo o seguinte:

1. No Xcode, em frameworks e bibliotecas, selecione o ícone 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 obter instruções sobre como implementar Push Stories, consulte a documentação.

Após atualizar o Podfile, navegue até o diretório do seu projeto de app Xcode no seu terminal e execute pod install.

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

Uso da sua própria UNNotificationServiceExtension

Se você precisar usar sua própria UNNotificationServiceExtension, poderá 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: Configurando o grupo de apps na Braze

Antes de inicializar a Braze, atribua o nome do seu grupo de apps à 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: Criação de uma notificação Rich no seu dashboard

Sua equipe de marketing também pode criar notificações ricas a partir do dashboard. Crie uma notificação por push pelo criador de push e anexe uma imagem ou GIF, ou forneça uma URL que hospede uma imagem, GIF ou vídeo. Os ativos são baixados no recebimento das notificações por push, portanto, planeje-se para grandes picos síncronos de solicitações se estiver hospedando seu conteúdo.