Notificaciones push enriquecidas

Requisitos previos

Antes de poder utilizar esta característica, tendrás que integrar el SDK Swift de Braze. También tendrás que configurar las notificaciones push.

Configuración de notificaciones push enriquecidas

Paso 1: Crear una extensión de servicio

Para crear una extensión del servicio de notificación, ve a File > New > Target en Xcode y selecciona Notification Service Extension.

Asegúrate de que Embed In Application esté configurado para insertar la extensión en tu aplicación.

Paso 2: Configurar la extensión del servicio de notificación

Una extensión del servicio de notificación es un binario independiente que se incluye en el paquete de tu aplicación. Debe configurarse en el Apple Developer Portal con su propio ID de aplicación y perfil de aprovisionamiento.

El ID de paquete de la extensión del servicio de notificación debe ser distinto del ID de paquete del destino principal de tu aplicación. Por ejemplo, si el ID de paquete de tu aplicación es com.company.appname, puedes usar com.company.appname.AppNameServiceExtension para tu extensión de servicio.

Paso 3: Añadir un grupo de aplicaciones

En Xcode, añade la capacidad App Groups desde el panel Signing & Capabilities tanto al destino principal de tu aplicación como al destino de la Notification Service Extension. Luego, haz clic en el botón +. Usa el ID de paquete de tu aplicación para crear el grupo de aplicaciones. Por ejemplo, si el ID de paquete de tu aplicación es com.company.appname, puedes llamar a tu grupo de aplicaciones group.com.company.appname.xyz.

Importante

En este contexto, App Groups hace referencia al App Groups Entitlement de Apple y no al ID de tu espacio de trabajo de Braze (antes grupo de aplicaciones).

Necesitas un grupo de aplicaciones compartido para que tu aplicación principal y la Notification Service Extension puedan acceder a datos compartidos. Si no añades tu aplicación a un grupo de aplicaciones, es posible que tu aplicación no pueda rellenar ciertos campos de la carga útil push y no funcione completamente como se espera.

Paso 4: Integrar las notificaciones push enriquecidas

Para ver una guía paso a paso sobre cómo integrar las notificaciones push enriquecidas con BrazeNotificationService, consulta nuestro tutorial.

Para ver un ejemplo, consulta el uso en NotificationService de nuestra aplicación Examples.

Añadir el framework de notificaciones push enriquecidas a tu aplicación

• swift package manager
• cocoapods
• manual

Después de seguir la guía de integración de Swift Package Manager, añade BrazeNotificationService a tu Notification Service Extension haciendo lo siguiente:

1. En Xcode, en frameworks y bibliotecas, selecciona el icono de añadir para añadir un framework.
   
   
   
   

2. Selecciona el framework “BrazeNotificationService”.
   
   

Añade lo siguiente a tu archivo de bibliotecas:

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 más información sobre cómo implementar Push Stories, consulta Push Stories.

Después de actualizar el archivo de bibliotecas, ve al directorio del proyecto de tu aplicación de Xcode en tu terminal y ejecuta pod install.

Para añadir BrazeNotificationService.xcframework a tu Notification Service Extension, consulta Integración manual.

Solución de problemas en proyectos de Xcode generados

Si generas tu proyecto de Xcode con herramientas de compilación como Tuist, confirma que tu proyecto generado mantiene BrazeNotificationService vinculado al destino de tu Notification Service Extension y conserva sus recursos en el paquete de la extensión. Algunas estructuras de proyectos generados pueden colocar los recursos en paquetes inesperados, lo que puede hacer que los activos de las notificaciones push enriquecidas no se carguen en tiempo de ejecución.

Consulta los siguientes recursos para obtener ayuda:

• Repositorio del SDK de Braze para Swift
• Ejemplos del SDK de Braze para Swift para Notification Service Extension
• Seguimiento de incidencias del SDK de Braze para Swift

Usar tu propia UNNotificationServiceExtension

Si necesitas usar tu propia UNNotificationServiceExtension, puedes llamar a brazeHandle en tu 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)
  }
}

Paso 5: Configurar el grupo de aplicaciones en Braze

Antes de inicializar Braze, asigna el nombre de tu grupo de aplicaciones a la propiedad push.appGroup de tu configuración de 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)

Paso 6: Crear una notificación enriquecida en tu panel

Tu equipo de marketing también puede crear notificaciones enriquecidas desde el panel. Crea una notificación push con el creador de push y adjunta una imagen o un GIF, o proporciona una URL que aloje una imagen, un GIF o un video. Ten en cuenta que los activos se descargan al recibir las notificaciones push, así que debes prever picos grandes y sincrónicos de solicitudes si alojas tu propio contenido.