Adobe Experience Platform Mobile SDK のインストール

モバイルアプリでAdobe Experience Platform Mobile SDK を実装する方法を説明します。

前提条件

学習目標

このレッスンでは、次の操作を行います。

  • Swift パッケージマネージャーを使用して、必要な SDK をプロジェクトに追加します。
  • 拡張機能を登録します
NOTE
モバイルアプリの実装では、「拡張機能」と「SDK」という用語はほとんど互換性がありません。

Swift パッケージマネージャー

SDK のインストール手順の生成で説明しているように) CocoaPods とポッドファイルを使用する代わりに、Xcode のネイティブの Swift パッケージマネージャーを使用して個々のパッケージを追加します。 Xcode プロジェクトには、すべてのパッケージ依存関係が既に追加されています。 Xcode パッケージの依存関係 画面は次のようになります。

Xcode パッケージの依存関係 {modal="regular"}

Xcode では、File > Add Packages… を使用してパッケージを追加できます。 次の表は、パッケージの追加に使用する URL へのリンクを示しています。 また、リンクでは、それぞれの特定のパッケージに関する詳細も示されます。

パッケージ
説明
AEP コア

AEPCoreAEPServicesAEPIdentity の各拡張機能は、Adobe Experience Platform SDK の基盤を表します。SDK を使用するすべてのアプリに、拡張機能を含める必要があります。 これらのモジュールには、すべての SDK 拡張機能で必要な機能とサービスの共通のセットが含まれています。

  • AEPCore には、イベントハブの実装が含まれています。 イベントハブは、アプリと SDK の間でイベントを配信するために使用されるメカニズムです。 イベントハブは、拡張機能間でのデータの共有にも使用されます。
  • AEPServices は、ネットワーク、ディスクアクセス、データベース管理など、プラットフォームのサポートに必要な、再利用可能な実装をいくつか提供しています。
  • AEPIdentity は、Adobe Experience Platform ID サービスとの統合を実装します。
  • AEPSignal は、マーケターがアプリに「シグナル」を送信し、データを外部の宛先に送信したり、URL を開いたりできる、Adobe Experience Platform SDK シグナル拡張機能を表します。
  • AEPLifecycle は、Adobe Experience Platform SDK ライフサイクル拡張機能を表し、アプリケーションのインストールまたはアップグレードの情報、アプリケーションの起動およびセッションの情報、デバイス情報、アプリケーション開発者から提供されるその他のコンテキストデータなど、アプリケーションのライフサイクル指標を収集するのに役立ちます。
AEP Edge
Adobe Experience PlatformEdge Networkモバイル拡張機能(AEPEdge)を使用すると、モバイルアプリケーションからAdobe Edge Network にデータを送信できます。 この拡張機能を使用すると、Adobe Experience Cloud機能をより堅牢な方法で実装し、1 回のネットワーク呼び出しで複数のAdobeソリューションを提供した後、この情報を同時にAdobe Experience Platformに転送できます。
Edge Networkモバイル拡張機能はAdobe Experience Platform SDK の拡張機能で、イベント処理のための AEPCore および AEPServices 拡張機能と、ECID などの ID を取得するための AEPEdgeIdentity 拡張機能が必要です。
AEP Edge ID
AEP Edge ID モバイル拡張機能(AEPEdgeIdentity)を使用すると、Adobe Experience Platform SDK およびEdge Network拡張機能を使用する際に、モバイルアプリケーションからユーザーの ID データを処理できます。
AEP Edge同意
AEP Consent Collection モバイル拡張機能(AEPConsent)は、Adobe Experience Platform SDK とEdge Network拡張機能を使用する際に、モバイルアプリケーションからの同意環境設定の収集を有効にします。
AEP ユーザープロファイル
Adobe Experience Platform User Profile Mobile Extension (AEPUserProfile)は、Adobe Experience Platform SDK のユーザープロファイルを管理するための拡張機能です。
AEP Places
AEP Places 拡張機能(AEPPlaces)を使用すると、Adobe場所インターフェイスやAdobeの Data Collection タグルールで定義された位置情報イベントを追跡できます。
AEP メッセージ
AEP Messaging 拡張機能(AEPMessaging)を使用すると、プッシュ通知トークンとプッシュ通知のクリックスルーフィードバックをAdobe Experience Platformに送信できます。
AEP の最適化
AEP Optimize 拡張機能(AEPOptimize)は、Adobe TargetまたはAdobe Journey Optimizer Offer decisioningを使用して、Adobe Experience Platform Mobile SDK でリアルタイムパーソナライゼーションワークフローを有効にするための API を提供します。 パーソナライゼーションクエリイベントを Experience Edge Network に送信するには、AEPCoreAEPEdge の拡張機能が必要です。
AEP Assurance
Assurance (Griffon プロジェクトとも呼ばれる)は、モバイルアプリでデータを収集したりエクスペリエンスを提供したりする方法を検査、配達確認、シミュレートおよび検証するのに役立つ、新しい革新的な拡張機能(AEPAssurance)です。 この拡張機能により、アプリで Assurance が有効になります。

拡張機能の読み込み

Xcode で、Luma / Luma / AppDelegate に移動し、次の読み込みがこのソースファイルの一部であることを確認します。

// import AEP MobileSDK libraries
import AEPCore
import AEPServices
import AEPIdentity
import AEPSignal
import AEPLifecycle
import AEPEdge
import AEPEdgeIdentity
import AEPEdgeConsent
import AEPUserProfile
import AEPPlaces
import AEPMessaging
import AEPOptimize
import AEPAssurance

Luma/Luma/Utils/MobileSDK に対して、同じ操作を行います。

AppDelegate の更新

Xcode プロジェクトナビゲーターで Luma/Luma/AppDelegate に移動します。

  1. environmentFileId@AppStorageYOUR_ENVIRONMENT_ID_GOES_HERE を、SDK インストール手順の生成のタグから取得した開発環境ファイル ID 値に置き換えます。

    code language-swift
    @AppStorage("environmentFileId") private var environmentFileId = "YOUR_ENVIRONMENT_ID_GOES_HERE"
    
  2. application(_, didFinishLaunchingWithOptions) 関数に次のコードを追加します。

    code language-swift
    // Define extensions
    let extensions = [
        AEPIdentity.Identity.self,
        Lifecycle.self,
        Signal.self,
        Edge.self,
        AEPEdgeIdentity.Identity.self,
        Consent.self,
        UserProfile.self,
        Places.self,
        Messaging.self,
        Optimize.self,
        Assurance.self
    ]
    
    // Register extensions
    MobileCore.registerExtensions(extensions, {
        // Use the environment file id assigned to this application via Adobe Experience Platform Data Collection
        Logger.aepMobileSDK.info("Luma - using mobile config: \(self.environmentFileId)")
        MobileCore.configureWith(appId: self.environmentFileId)
    
        // set this to false or comment it when deploying to TestFlight (default is false),
        // set this to true when testing on your device.
        MobileCore.updateConfigurationWith(configDict: ["messaging.useSandbox": true])
        if appState != .background {
            // only start lifecycle if the application is not in the background
            MobileCore.lifecycleStart(additionalContextData: nil)
        }
    
        // assume unknown, adapt to your needs.
        MobileCore.setPrivacyStatus(.unknown)
    })
    

上記のコードの動作は次のとおりです。

  1. 必要な拡張機能を登録します。
  2. タグプロパティ設定を使用するように MobileCore およびその他の拡張機能を設定します。
  3. デバッグログを有効にします。 詳細およびオプションについては、Adobe Experience Platform Mobile SDK ドキュメントを参照してください。
  4. ライフサイクルの監視を開始します。 詳しくは、チュートリアルの ライフサイクルステップを参照してください。
  5. デフォルトの同意を不明に設定します。 詳しくは、チュートリアルの 同意手順を参照してください。
IMPORTANT
作成するタグ環境(開発、ステージングまたは実稼動)の environmentFileId に基づいて、appId を使用して MobileCore.configureWith(appId: self.environmentFileId) を更新してください。
SUCCESS
これで、必要なパッケージをインストールし、チュートリアルの残りの部分で使用する必要なAdobe Experience Platform Mobile SDK 拡張機能を適切に登録するために、プロジェクトを更新しました。
Adobe Experience Platform Mobile SDK の学習に時間を費やしていただき、ありがとうございます。 ご不明な点がある場合や、一般的なフィードバックをお寄せになる場合、または今後のコンテンツに関するご提案がある場合は、この Experience League コミュニティ ディスカッションの投稿でお知らせください

次のトピック:Assurance の設定

recommendation-more-help
9fed61f5-c338-47ad-8005-0b89a5f4af8b