Notifications push riches

Conditions préalables

Avant de pouvoir utiliser cette fonctionnalité, vous devrez intégrer le SDK Swift Braze. Il vous sera également nécessaire de configurer les notifications push.

Mise en place de notifications push riches

Étape 1 : Créer une extension de service de notification

Pour créer une extension de service de notification, accédez à File > New > Target dans Xcode et sélectionnez Notification Service Extension.

Vérifiez que l’option Embed In Application est configurée de manière à intégrer l’extension dans votre application.

Étape 2 : Configurer l’extension de service de notification

Une extension de service de notification est un binaire distinct qui est fourni avec votre application. Elle doit être configurée dans le portail développeur Apple avec son propre identifiant d’application et son propre profil de provisionnement.

L’identifiant de bundle de l’extension de service de notification doit être distinct de celui de la cible principale de votre application. Par exemple, si l’identifiant de bundle de votre application est com.company.appname, vous pouvez utiliser com.company.appname.AppNameServiceExtension pour votre extension de service.

Étape 3 : Ajouter un groupe d’applications

Dans Xcode, ajoutez la fonctionnalité App Groups depuis le panneau Signing & Capabilities à la fois à la cible principale de votre application et à celle de l’extension de service de notification. Cliquez ensuite sur le bouton +. Utilisez l’identifiant de bundle de votre application pour créer le groupe d’applications. Par exemple, si l’identifiant de bundle de votre application est com.company.appname, vous pouvez nommer votre groupe d’applications group.com.company.appname.xyz.

Important

Dans ce contexte, les groupes d’applications font référence à l’App Groups Entitlement d’Apple et non à l’identifiant de votre espace de travail Braze (anciennement groupe d’applications).

Un groupe d’applications partagé est nécessaire pour que votre application principale et l’extension de service de notification puissent accéder aux données partagées. Si vous n’ajoutez pas votre application à un groupe d’applications, votre application pourrait ne pas renseigner certains champs du payload de la notification push et ne fonctionnera pas entièrement comme prévu.

Étape 4 : Intégrer les notifications push riches

Pour un guide pas à pas sur l’intégration des notifications push riches avec BrazeNotificationService, consultez notre tutoriel.

Pour voir un exemple, consultez l’utilisation dans NotificationService de notre application d’exemples.

Ajouter le framework de notification push riche à votre application

• gestionnaire de paquets swift
• cocoapods
• manuel

Après avoir suivi le guide d’intégration du gestionnaire de paquets Swift, ajoutez BrazeNotificationService à votre Notification Service Extension en procédant comme suit :

1. Dans Xcode, sous frameworks et bibliothèques, sélectionnez l’icône d’ajout pour ajouter un framework.
   
   
   
   

2. Sélectionnez le framework « BrazeNotificationService ».
   
   

Ajoutez ce qui suit à votre 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

Remarque

Pour obtenir les instructions relatives à l’implémentation de Push Stories, consultez la documentation.

Après avoir mis à jour le Podfile, accédez au répertoire de votre projet d’application Xcode dans votre terminal et exécutez pod install.

Pour ajouter BrazeNotificationService.xcframework à votre Notification Service Extension, consultez la section Intégration manuelle.

Utiliser votre propre UNNotificationServiceExtension

Si vous devez utiliser votre propre UNNotificationServiceExtension, vous pouvez appeler brazeHandle dans votre méthode 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)
  }
}

Étape 5 : Configurer le groupe d’applications dans Braze

Avant d’initialiser Braze, attribuez le nom de votre groupe d’applications à la propriété push.appGroup de votre configuration 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)

Étape 6 : Créer une notification riche dans votre tableau de bord

Votre équipe marketing peut également créer des notifications riches depuis le tableau de bord. Créez une notification push via le compositeur de notifications push et joignez une image ou un GIF, ou fournissez une URL hébergeant une image, un GIF ou une vidéo. Notez que les ressources sont téléchargées à la réception des notifications push, vous devez donc anticiper des pics importants et synchrones de requêtes si vous hébergez votre contenu.