Installation des SDK mobiles Adobe Experience Platform tutorial_install_mobile_sdks

Découvrez comment mettre en œuvre le SDK mobile Adobe Experience Platform dans une application mobile.

Conditions préalables

Objectifs d’apprentissage

Dans cette leçon, vous allez :

  • Ajoutez les SDK requis à votre projet.
  • Enregistrez les extensions.
NOTE
Dans une implémentation d’application mobile, les termes extensions et SDK sont presque interchangeables.
iOS

Gestionnaire de packages Swift

Au lieu d’utiliser des CocoaPods et un fichier Pod (comme indiqué dans Instructions d’installation de Generate SDK), vous pouvez ajouter des packages individuels à l’aide du gestionnaire de packages Swift natif de Xcode. Toutes les dépendances de packages ont déjà été ajoutées pour vous dans le projet Xcode. L’écran Xcode Dépendances de packages doit se présenter comme suit :

Dépendances De Packages Xcode {modal="regular"}

Dans Xcode, vous pouvez utiliser Fichier > Ajouter des packages… pour ajouter des packages. Le tableau ci-dessous fournit des liens vers les URL que vous pouvez utiliser pour ajouter des packages. Les liens vous redirigent également vers des informations supplémentaires sur chaque package spécifique.

table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2
Package Description
AEP Core

Les extensions AEPCore, AEPServices et AEPIdentity représentent la base du SDK Adobe Experience Platform. Chaque application utilisant le SDK doit les inclure. Ces modules contiennent un ensemble commun de fonctionnalités et de services dont toutes les extensions SDK ont besoin.

  • AEPCore contient l’implémentation du hub d’événements. Event Hub est le mécanisme utilisé pour diffuser des événements entre l’application et le SDK. Event Hub est également utilisé pour partager des données entre les extensions.
  • AEPServices fournit plusieurs implémentations réutilisables nécessaires à la prise en charge de Platform, notamment la mise en réseau, l’accès au disque et la gestion des bases de données.
  • AEPIdentity implémente l’intégration avec les services Adobe Experience Platform Identity.
  • AEPSignal représente l’extension Signal des SDK Adobe Experience Platform qui permet aux spécialistes marketing d’envoyer un « signal » à leurs applications pour envoyer des données à des destinations externes ou ouvrir des URL.
  • AEPLifecycle représente l’extension de cycle de vie des SDK Adobe Experience Platform qui permet de collecter des mesures de cycle de vie des applications, telles que des informations d’installation ou de mise à niveau des applications, des informations de lancement et de session des applications, des informations sur les appareils et toute donnée contextuelle supplémentaire fournie par le développeur ou la développeuse de l’application.
AEP Edge L’extension mobile Adobe Experience Platform Edge Network (AEPEdge) vous permet d’envoyer des données à Adobe Edge Network à partir d’une application mobile. Cette extension vous permet de mettre en œuvre les fonctionnalités de Adobe Experience Cloud de manière plus robuste, de diffuser plusieurs solutions Adobe par le biais d’un seul appel réseau et de transférer simultanément ces informations au Adobe Experience Platform.
L’extension mobile Edge Network est une extension de Adobe Experience Platform SDK. L’extension nécessite les extensions AEPCore et AEPServices pour la gestion des événements, ainsi que l’extension AEPEdgeIdentity pour récupérer les identités, telles que l’ECID.
Identité AEP Edge L’extension Adobe Experience Platform Edge Identity mobile extension (AEPEdgeIdentity) permet de gérer les données d’identité utilisateur d’une application mobile lors de l’utilisation de Adobe Experience Platform SDK et de l’extension Edge Network.
Consentement AEP Edge L’extension mobile de collecte de consentement Adobe Experience Platform (AEPConsent) permet la collecte de préférences de consentement à partir de l’application mobile lors de l’utilisation du SDK Adobe Experience Platform et de l’extension Edge Network.
Profil utilisateur AEP L’extension Adobe Experience Platform User Profile Mobile (AEPUserProfile) est une extension permettant de gérer les profils utilisateur pour Adobe Experience Platform SDK.
AEP Places L'extension Adobe Experience Platform Places (AEPPlaces) vous permet d'effectuer le suivi des événements de géolocalisation tels que définis dans l'interface Adobe Places et dans les règles de balise de collecte de données Adobe.
AEP Messaging L’extension Adobe Experience Platform Messaging (AEPMessaging) vous permet d’envoyer des jetons de notification push et des commentaires sur les clics publicitaires des notifications push au Adobe Experience Platform.
AEP Optimize L’extension Adobe Experience Platform Optimize (AEPOptimize) fournit des API pour activer les workflows de personnalisation en temps réel dans les SDK Adobe Experience Platform Mobile à l’aide d’Adobe Target ou de Adobe Journey Optimizer Offer Decisioning. Elle nécessite des extensions AEPCore et AEPEdge pour envoyer des événements de requête de personnalisation à Experience Edge Network.
AEP Assurance Adobe Experience Platform Assurance est un produit de Adobe Experience Cloud qui vous permet d’inspecter, de tester, de simuler et de valider la manière dont vous collectez les données ou dont les expériences sont diffusées dans votre application mobile.

Importer des extensions

Ouvrez dans Xcode le projet dans le dossier Start de l’exemple d’application.

Dans Xcode, accédez à Luma > Luma > AppDelegate et assurez-vous que les importations suivantes font partie de ce fichier source.

code language-swift
// 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

Faites de même pour Luma > Luma > Utils > MobileSDK.

Mettre à jour AppDelegate

Accédez à Luma > Luma > AppDelegate dans le navigateur de projet Xcode.

  1. Remplacez la valeur @AppStorage YOUR_ENVIRONMENT_ID_GOES_HERE pour environmentFileId par la valeur de l’identifiant du fichier d’environnement que vous avez récupérée à partir des balises dans Instructions d’installation de Generate SDK.

    code language-swift
    @AppStorage("environmentFileId") private var environmentFileId = "YOUR_ENVIRONMENT_ID_GOES_HERE"
    
  2. Ajoutez le code suivant à la fonction 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)
    })
    

Le code ci-dessus effectue les opérations suivantes :

  1. Enregistre les extensions requises.
  2. Configure MobileCore et d’autres extensions pour utiliser la configuration de propriété de balise.
  3. Active la journalisation du débogage. Vous trouverez plus d’informations et d’options dans la documentation de Adobe Experience Platform Mobile SDK 🔗.
  4. Démarre la surveillance du cycle de vie. Voir l’étape Cycle de vie du tutoriel pour plus d’informations.
  5. Définit le consentement par défaut sur inconnu. Voir l’étape Consentement du tutoriel pour plus d’informations.

Veillez à mettre à jour les MobileCore.configureWith(appId: self.environmentFileId) avec le appId en fonction des environmentFileId de l’environnement de balises pour lequel vous créez des ressources (développement, évaluation ou production).

Android

Gradle

Utilisez les dépendances des instructions d’installation Generate SDK pour ajouter des packages individuels à l’aide de l’intégration de Gradle à Android Studio. Le projet Android Studio comporte déjà toutes les dépendances de packages ajoutées pour vous.

  1. Sélectionnez FolderOutline comme outil.

  2. Sélectionnez la vue Android.

  3. Sélectionnez Scripts Gradle > build.gradle.kts (Module :app) dans le volet gauche. Ensuite, dans le volet de droite, faites défiler l’écran jusqu’à ce que dependencies s’affiche.

    Dépendances de niveau Android {modal="regular"}

Dans Android Studio, vous pouvez utiliser Fichier > Structure de projet… pour ajouter des dépendances de module. Sélectionnez Dépendances puis utilisez Modules Ajouter pour ajouter des modules. Le tableau ci-dessous fournit des liens vers les URL que vous pouvez utiliser pour ajouter des modules de dépendance. Les liens vous redirigent également vers des informations supplémentaires sur chaque module spécifique.

table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2
Package
com.adobe
marketing.mobile:
Description
core

Les extensions MobileCore et Identity représentent la base du SDK Adobe Experience Platform. Chaque application utilisant le SDK doit les inclure. Ces modules contiennent un ensemble commun de fonctionnalités et de services dont toutes les extensions SDK ont besoin.

  • MobileCore contient l’implémentation du hub d’événements. Event Hub est le mécanisme utilisé pour diffuser des événements entre l’application et le SDK. Event Hub est également utilisé pour partager des données entre les extensions et fournit plusieurs implémentations réutilisables nécessaires à la prise en charge de la plateforme, notamment la mise en réseau, l’accès au disque et la gestion des bases de données.
  • Identity implémente l’intégration avec les services Adobe Experience Platform Identity.
  • Signal représente l’extension du signal de SDK de Adobe Experience Platform qui permet aux spécialistes marketing d’envoyer un « signal » à leurs applications pour envoyer des données à des destinations externes ou ouvrir des URL.
  • Lifecycle représente l’extension de cycle de vie du SDK Adobe Experience Platform qui permet de collecter des mesures de cycle de vie des applications, telles que des informations d’installation ou de mise à niveau des applications, des informations de lancement et de session des applications, des informations sur les appareils et toute donnée contextuelle supplémentaire fournie par le développeur ou la développeuse de l’application.
edge L’extension mobile Adobe Experience Platform Edge Network (AEPEdge) vous permet d’envoyer des données à Adobe Edge Network à partir d’une application mobile. Cette extension vous permet de mettre en œuvre les fonctionnalités de Adobe Experience Cloud de manière plus robuste, de diffuser plusieurs solutions Adobe par le biais d’un seul appel réseau et de transférer simultanément ces informations au Adobe Experience Platform.
L’extension mobile Edge Network est une extension de Adobe Experience Platform SDK. L’extension nécessite les extensions Mobile Core et Services pour la gestion des événements. Et l’extension Identity for Edge Network pour récupérer les identités, telle que l’ECID.
edgeidentity L’extension Adobe Experience Platform Edge Identity Mobile permet de gérer les données d’identité utilisateur d’une application mobile lors de l’utilisation de Adobe Experience Platform SDK et de l’extension Edge Network.
edgeconsentement L’extension mobile Collection de consentement Adobe Experience Platform permet la collecte de préférences de consentement à partir de l’application mobile lors de l’utilisation de Adobe Experience Platform SDK et de l’extension Edge Network.
userprofile L’extension Adobe Experience Platform User Profile Mobile est une extension permettant de gérer les profils utilisateur pour Adobe Experience Platform SDK.
aepplaces Adobe Places Service est un service de géolocalisation qui permet aux applications mobiles de connaître l’emplacement de l’utilisateur. Et pour comprendre le contexte de l’emplacement en utilisant des interfaces SDK riches et faciles à utiliser, accompagnées d’une base de données flexible de points ciblés (POI). Pour plus d’informations, voir la documentation du service Places .
Ce service est l'extension mobile Places pour le SDK Adobe Experience Platform Android 2.x et nécessite l'extension Core pour la gestion des événements.
messagerie L’extension Adobe Experience Platform Messaging alimente les notifications push, les messages in-app et les expériences basées sur du code pour vos applications mobiles. Cette extension vous permet également de collecter des jetons push utilisateur et de gérer la mesure des interactions avec les services Adobe Experience Platform.
optimiser L’extension Adobe Experience Platform Optimize fournit des API pour activer les workflows de personnalisation en temps réel dans les SDK Adobe Experience Platform à l’aide d’Adobe Target ou de Adobe Journey Optimizer Offer Decisioning. Elle dépend de Mobile Core et nécessite l’extension Edge pour envoyer des événements de requête de personnalisation à Experience Edge Network.
assurance Assurance (également appelé projet Griffon) est une extension mobile pour Adobe Experience Platform qui permet de s’intégrer à Adobe Experience Platform Assurance. L’extension permet d’inspecter, de corriger, de simuler et de valider la manière dont vous collectez les données ou dont les expériences sont diffusées dans votre application mobile. Cette extension nécessite MobileCore.

Importer des extensions

Dans Android Studio, accédez à app > kotlin+java > com.adobe.luma.tutorial.android > LumaApplication et assurez-vous que les imports ci-dessous font partie du fichier source.

code language-kotlin
import com.adobe.marketing.mobile.Assurance
import com.adobe.marketing.mobile.Edge
import com.adobe.marketing.mobile.Lifecycle
import com.adobe.marketing.mobile.LoggingMode
import com.adobe.marketing.mobile.Messaging
import com.adobe.marketing.mobile.MobileCore
import com.adobe.marketing.mobile.MobilePrivacyStatus
import com.adobe.marketing.mobile.Places
import com.adobe.marketing.mobile.Signal
import com.adobe.marketing.mobile.UserProfile
import com.adobe.marketing.mobile.edge.consent.Consent
import com.adobe.marketing.mobile.edge.identity.Identity
import com.adobe.marketing.mobile.optimize.Optimize

Faites de même pour app > kotlin+java > com.adobe.luma.tutorial.android > models > MobileSDK.

Mettre à jour l’application Luma

Dans la vue Android, accédez à app > kotlin+java > com.adobe.luma.tutorial.android > LumaApplication dans Android Studio.

  1. Remplacez "YOUR_ENVIRONMENT_FILE_ID" dans private var environmentFileId = "YOUR_ENVIRONMENT_ID_GOES_HERE" par la valeur de l’identifiant du fichier d’environnement que vous avez récupérée à partir des balises dans Générer les instructions d’installation de SDK.

    code language-kotlin
    private var environmentFileId = "YOUR_ENVIRONMENT_ID_GOES_HERE"
    
  2. Ajoutez le code suivant à override fun onCreate() fonction dans class LumaApplication : Application().

    code language-kotlin
    // Define extensions
    val extensions = listOf(
       Identity.EXTENSION,
       Lifecycle.EXTENSION,
       Signal.EXTENSION,
       Edge.EXTENSION,
       Consent.EXTENSION,
       UserProfile.EXTENSION,
       Places.EXTENSION,
       Messaging.EXTENSION,
       Optimize.EXTENSION,
       Assurance.EXTENSION
    )
    
    // Register extensions
    MobileCore.registerExtensions(extensions) {
    // Use the environment file id assigned to this application via Adobe Experience Platform Data Collection
      Log.i("Luma", "Using mobile config: $environmentFileId")
      MobileCore.configureWithAppID(environmentFileId)
    
      // set this to true when testing on your device, default is false.
      //MobileCore.updateConfiguration(mapOf("messaging.useSandbox" to true))
    
      // assume unknown, adapt to your needs.
      MobileCore.setPrivacyStatus(MobilePrivacyStatus.UNKNOWN)
    }
    

    Le code ci-dessus effectue les opérations suivantes :

    1. Enregistre les extensions requises.
    2. Configure MobileCore et d’autres extensions pour utiliser la configuration de propriété de balise.
    3. Active la journalisation du débogage. Vous trouverez plus d’informations et d’options dans la documentation de Adobe Experience Platform Mobile SDK 🔗.
    4. Démarre la surveillance du cycle de vie. Voir l’étape Cycle de vie du tutoriel pour plus d’informations.
    5. Définit le consentement par défaut sur inconnu. Voir l’étape Consentement du tutoriel pour plus d’informations.

Veillez à mettre à jour MobileCore.configureWith(environmentFileId) avec le environmentFileId en fonction de l’identifiant de fichier d’environnement de l’environnement de balises pour lequel vous créez des balises (développement, évaluation ou production).

SUCCESS
Vous avez maintenant installé les packages nécessaires et mis à jour votre projet afin d’enregistrer les extensions Adobe Experience Platform Mobile SDK requises que vous allez utiliser pour la suite du tutoriel.
Merci d’avoir consacré votre temps à découvrir Adobe Experience Platform Mobile SDK. Si vous avez des questions, souhaitez partager des commentaires généraux ou des suggestions sur le contenu futur, partagez-les dans ce article de discussion de la communauté Experience League

Suivant : Configuration d’Assurance

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