ドキュメント Journey Optimizer Journey Optimizer ガイド

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

最終更新日： 2026年4月29日

トピック：
Channel Configuration

作成対象：

Intermediate
Admin

Adobe Experience Platform Mobile SDK は、Apple のライブアクティビティのビルトインのサポートを提供します。これにより、アプリを開かなくても、ロック画面と Dynamic Island でリアルタイムの動的な更新を直接表示できます。

必要なモジュールをインポート

AEPMessaging、AEPMessagingLiveActivity、ActivityKit のモジュールを読み込みます。
属性の定義

LiveActivityAttributes に準拠し、LiveActivityData 属性と ContentState 属性を含めます。
Register Live activity

SDK の初期化後に Messaging.registerLiveActivity() を使用します。
ウィジェット設定を作成

ロック画面と Dynamic Island インターフェイスの両方に ActivityConfiguration を実装します。
ローカルでライブアクティビティを開始（オプション）

Live activity can be initiated either remotely through Journey Optimizer or locally within the application code.
デバッグサポートを追加（オプション）

Assuranceに LiveActivityAssuranceDebuggable を実装します。

正しい設定と互換性を確保するために、次の最小バージョンがインストールされていることを確認します。

前提条件：

iOS：
- iOS 16.1 以降：基本的なライブアクティビティ機能
- iOS 17.2 以降：プッシュトゥスタートのサポート
- iOS 18 以降：ブロードキャストチャネルのサポート
Xcode： 14.0 以降
Swift： 5.7 以降
依存関係： AEPCore、AEPMessaging、AEPMessagingLiveActivity、ActivityKit
AEP Mobile SDK version: iOS Messaging 5.11.0 or later

style

shade-box

手順 1：必要なモジュールをインポート import

開始するには、まず AEPMessaging、AEPMessagingLiveActivity、ActivityKit モジュールを読み込む必要があります。

import AEPMessaging
import AEPMessagingLiveActivity
import ActivityKit

Step 2: define your live activity attributes attributes

LiveActivityAttributes プロトコルに準拠する構造体を作成します。これにより、ライブアクティビティの静的データと動的コンテンツの状態の両方が定義されます。

主なコンポーネントは次のとおりです。

Adobe Experience Platform 固有のデータを含む liveActivityData（必須）。
- 個々のユーザーの場合：LiveActivityData(liveActivityID: "unique-id") を使用します
- ブロードキャストの場合：LiveActivityData(channelID: "channel-id") を使用します
静的属性、ユースケースに固有のカスタムプロパティ（例：restaurantName）。
ライブアクティビティライフサイクル中に更新できる動的データを定義する ContentState。これは、Codable と Hashable に準拠する必要があります。
LiveActivityOrigin 定義済みリストは、アクティビティがアプリ内でローカルで開始されたか、iOS 17.2 以降でサポートされているプッシュトゥスタート通知を通じてリモートで開始されたかを指定します。 This value allows the SDK to differentiate between locally initiated and remotely triggered Live activity during data collection.

例

@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
}

また、アプリに複数のライブアクティビティタイプを登録することもできます。

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

Step 3: register live activity register

SDK の初期化後に AppDelegate にライブアクティビティタイプを登録すると、次の操作を実行できます。

自動プッシュトゥスタートトークン収集を有効にする（iOS 17.2 以降）
ライブアクティビティ更新トークンを自動的に収集
ライフサイクル管理とイベントトラッキングを有効にする

食品配送ライブアクティビティの例：

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:

食品配送ライブアクティビティの例：

@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

Journey Optimizer ではライブアクティビティをリモートで開始できますが、ローカルで開始することもできます。

食品配送ライブアクティビティの例：

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
)

手順 6：デバッグサポートを追加（オプション） debug

必要に応じて、Adobe Assurance でライブアクティビティスキーマをデバッグできます。

食品配送ライブアクティビティの例：

@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")
        )
    }
}

その他のリソース

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