DocumentationJourney OptimizerGuide de Journey Optimizer

Live activity integration with Adobe Experience Platform Mobile SDK mobile-live-config-sdk

Dernière mise à jour : 28 avril 2026

Créé pour :

  • Intermediate
  • Admin

Le SDK mobile d’Adobe Experience Platform offre une prise en charge intégrée des activités en direct d’Apple. Cela permet à votre application d’afficher des mises à jour dynamiques en temps réel directement sur l’écran de verrouillage et Dynamic Island sans ouvrir l’application.

  1. Importer les modules requis

    Importez les modules suivants : AEPMessaging, AEPMessagingLiveActivity, ActivityKit

  2. Définir les attributs

    Respectez les LiveActivityAttributes, incluez des LiveActivityData et des attributs ContentState.

  3. Register Live activity

    Utilisez Messaging.registerLiveActivity() après l’initialisation du SDK.

  4. Créer une configuration de widget

    Implémentez ActivityConfiguration pour l’écran de verrouillage et l’interface de Dynamic Island.

  5. Démarrer une activité en direct localement (facultatif)

    Live activity can be initiated either remotely through Journey Optimizer or locally within the application code.

  6. Ajouter la prise en charge du débogage (facultatif)

    Implémentez LiveActivityAssuranceDebuggable pour Assurance.

Vérifiez que les versions minimales suivantes sont installées pour garantir une configuration et une compatibilité correctes.

Conditions préalables requises :

  • iOS :

    • iOS 16.1 ou version ultérieure : fonctionnalité de base d’activité en direct
    • iOS 17.2+ : prise en charge du démarrage par notification push
    • iOS 18+ : prise en charge des canaux de diffusion

  • Xcode : 14.0 ou version ultérieure

  • Swift : 5.7 une version ultérieure

  • Dépendances : AEPCore, AEPMessaging, AEPMessagingLiveActivity, ActivityKit

  • AEP Mobile SDK version: iOS Messaging 5.11.0 or later

style
shade-box

Étape 1 : importer les modules requis import

Pour commencer, vous devez d’abord importer les modules suivants : AEPMessaging, AEPMessagingLiveActivity, ActivityKit.

import AEPMessaging
import AEPMessagingLiveActivity
import ActivityKit

Step 2: define your live activity attributes attributes

Créez une structure conforme au protocole LiveActivityAttributes. Cela définit à la fois les données statiques et l’état du contenu dynamique pour votre activité en direct.

Les principaux composants sont les suivants :

  • liveActivityData (obligatoire) contenant des données spécifiques à Adobe Experience Platform.

    • Pour les utilisateurs et utilisatrices individuels : utiliser LiveActivityData(liveActivityID: "unique-id")
    • Pour la diffusion : utiliser LiveActivityData(channelID: "channel-id")

  • Attributs statiques, propriétés personnalisées spécifiques à votre cas d’utilisation, par exemple restaurantName.

  • ContentState qui définit les données dynamiques qui peuvent être mises à jour pendant le cycle de vie de l’activité en direct. Il doit être conforme à Codable et Hashable.

  • L’énumération LiveActivityOrigin spécifie si une activité a été lancée localement dans l’application ou à distance par le biais d’un démarrage par notification push, pris en charge dans iOS 17.2 et les versions ultérieures. This value allows the SDK to differentiate between locally initiated and remotely triggered Live activity during data collection.

Exemples

@available(iOS 16.1, *)
struct FoodDeliveryLiveActivityAttributes: LiveActivityAttributes {
    // Mandatory: AEP Integration Data
    var liveActivityData: LiveActivityData

    // Static Attributes: Custom properties that do not change
    var restaurantName: String

    // Dynamic Content State: Data that can be updated
    struct ContentState: Codable, Hashable {
        var orderStatus: String
    }
}

@available(iOS 16.1, *)
public struct LiveActivityData: Codable {
    /// Unique identifier for broadcast Live activity channels
    public let channelID: String?

    /// Unique identifier for individual Live activity
    public let liveActivityID: String?

    /// Indicates local vs remote creation
    public let origin: LiveActivityOrigin?

    // Initializers
    public init(channelID: String)        // For broadcast Live activity
    public init(liveActivityID: String)   // For individual Live activity
}

Vous pouvez également enregistrer plusieurs types d’activités en direct pour votre application :

if #available(iOS 16.1, *) {
    Messaging.registerLiveActivity(AirplaneTrackingAttributes.self)
    Messaging.registerLiveActivity(FoodDeliveryLiveActivityAttributes.self)
    Messaging.registerLiveActivity(GameScoreLiveActivityAttributes.self)
}

Step 3: register live activity register

Enregistrez vos types d’activités en direct dans votre AppDelegate après l’initialisation du SDK. Vous pouvez ainsi :

  • Active la collecte automatique des jetons push-to-start (iOS 17.2+)
  • Collecte automatiquement les jetons de mise à jour des activités en direct.
  • Permet la gestion du cycle de vie et le suivi des événements.

Exemple pour une activité en direct de livraison de repas :

if #available(iOS 16.1, *) {
    Messaging.registerLiveActivity(FoodDeliveryLiveActivityAttributes.self)
}

Step 4: create live activity widgets widgets

A Live activity is displayed through widgets. You need to create a widget bundle and configuration:

Exemple pour une activité en direct de livraison de repas :

@main
struct FoodDeliveryWidgetBundle: WidgetBundle {
    var body: some Widget {
        FoodDeliveryLiveActivityWidget()
    }
}

@available(iOS 16.1, *)
struct FoodDeliveryLiveActivityWidget: Widget {
    var body: some WidgetConfiguration {
        ActivityConfiguration(for: FoodDeliveryLiveActivityAttributes.self) { context in
            // Lock Screen UI
            VStack {
                Text("Order from \(context.attributes.restaurantName)")
                Text("Status: \(context.state.orderStatus)") // possible status may include "Ordered", "Order accepted", "Preparing", "On the Way","Delivered"
            }
        } dynamicIsland: { context in
            // Dynamic Island UI
            DynamicIsland {
                // Expanded UI
            } compactLeading: {
                // Compact leading UI
            } compactTrailing: {
                // Compact trailing UI
            } minimal: {
                // Minimal UI
            }
        }
    }
}

Step 5: start a live activity locally (optional) local

Bien que Journey Optimizer puisse démarrer des activités en direct à distance, vous pouvez également les démarrer localement :

Exemple pour une activité en direct de livraison de repas :

let attributes = FoodDeliveryLiveActivityAttributes(
    liveActivityData: LiveActivityData(liveActivityID: "order123"),
    restaurantName: "Pizza Palace"
)

let contentState = FoodDeliveryLiveActivityAttributes.ContentState(
    orderStatus: "Ordered"
)

let activity = try Activity<FoodDeliveryLiveActivityAttributes>.request(
    attributes: attributes,
    contentState: contentState,
    pushType: .token
)

Étape 6 : ajouter la prise en charge du débogage (facultatif) debug

Si nécessaire, vous pouvez déboguer les schémas d’activité en direct dans Adobe Assurance :

Exemple pour une activité en direct de livraison de repas :

@available(iOS 16.1, *)
extension FoodDeliveryLiveActivityAttributes: LiveActivityAssuranceDebuggable {
    static func getDebugInfo() -> (attributes: FoodDeliveryLiveActivityAttributes, state: ContentState) {
        return (
            FoodDeliveryLiveActivityAttributes(
                liveActivityData: LiveActivityData(liveActivityID: "debug-order-123"),
                restaurantName: "Debug Restaurant"
            ),
            ContentState(orderStatus: "Ordered")
        )
    }
}

Ressources supplémentaires

For comprehensive SDK documentation and implementation details:

TIP
If you are experiencing issues with token registration, payload alignment, or Live activity delivery, see Troubleshoot Live activities for detailed debugging guidance.
recommendation-more-help
journey-optimizer-help