Guide d'Intégration SDK iOS
Cette page explique comment implémenter le SDK iOS pour Rokt Ecommerce afin de fournir des expériences client plus pertinentes lors du passage en caisse. Le SDK vous permet de déclencher et de suivre ces expériences (comme l'affichage d'offres sur les pages de confirmation) en s'activant sur des pages configurées et en transmettant les données utilisateur et de transaction à Rokt pour la personnalisation et la mesure.
Votre représentant de compte dédié vous aidera à configurer votre compte pour le SDK iOS. Ils vous fourniront à la fois la clé et le secret nécessaires pour initialiser le SDK ainsi que des ressources supplémentaires nécessaires pour rendre les expériences les plus pertinentes pour vos clients.
Ces instructions nécessitent des ressources de développement pour être complétées. Si vous avez besoin d'une assistance supplémentaire, veuillez contacter votre gestionnaire de compte Rokt. Les boutiques Shopify peuvent configurer un emplacement Rokt en quelques secondes à l'aide de l'application Rokt Ecommerce — aucun codage nécessaire !
1. Ajouter le SDK Rokt à votre application iOSLien direct vers 1. Ajouter le SDK Rokt à votre application iOS
En utilisant soit SPM (Swift Package Manager) soit CocoaPods, incluez le SDK Rokt dans votre application :
CocoaPodsLien direct vers CocoaPods
Pour intégrer le SDK en utilisant CocoaPods, spécifiez-le dans votre Podfile avec :
pod 'mParticle-Apple-SDK', '~> 8.0'
pod 'mParticle-Rokt','~> 8.0'
SPMLien direct vers SPM
Pour intégrer le SDK en utilisant Swift Package Manager :
- Ouvrez votre projet dans Xcode et allez à l'onglet "Package Dependencies".
- Cliquez sur le bouton + sous la liste des Packages.
- Entrez l'URL du dépôt
https://github.com/mParticle/mparticle-apple-sdkdans la boîte de recherche en haut à droite, choisissezmparticle-apple-sdkdans la liste des packages, et changez "Dependency Rule" en "Up to Next Major Version". - Cliquez sur le bouton "Add Package" en bas à droite, et choisissez le "Package Product" appelé
mParticle-Apple-SDK. Si vous souhaitez utiliser une version du SDK qui n'inclut pas le support de suivi de localisation, choisissezmParticle-Apple-SDK-NoLocation. - Répétez les étapes 3 et 4 pour l'URL du dépôt Rokt Kit
https://github.com/mparticle-integrations/mparticle-apple-integration-rokt.git.- Si vous choisissez le package product
mParticle-Apple-SDK-NoLocation, vous devrez importer le SDK en utilisantimport mParticle_Apple_SDK_NoLocationau lieu deimport mParticle_Apple_SDK.
- Si vous choisissez le package product
2. Initialiser le SDK RoktLien direct vers 2. Initialiser le SDK Rokt
Pour initialiser le SDK, insérez l'extrait d'initialisation suivant dans votre fichier AppDelegate :
- Assurez-vous de remplacer
your-keyetyour-secretpar la clé et le secret fournis par votre équipe dédiée Rokt.
- Swift
- Objective-C
import mParticle_Apple_SDK
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
// Initialiser le SDK
let options = MParticleOptions(key: "your-key",
secret: "your-secret")
// Spécifiez l'environnement de données avec environment:
// Réglez-le sur .development si vous testez encore votre intégration.
// Réglez-le sur .production si votre intégration est prête pour les données de production.
// La valeur par défaut est .autoDetect qui tente de détecter l'environnement automatiquement
options.environment = .development
// Identifier l'utilisateur actuel :
let identifyRequest = MPIdentityApiRequest.withEmptyUser()
// Si vous utilisez une adresse e-mail non hachée, définissez-la dans 'email'.
identifyRequest.email = "j.smith@example.com"
// Si l'utilisateur est identifié avec son adresse e-mail, définissez des attributs utilisateur supplémentaires.
options.identifyRequest = identifyRequest
options.onIdentifyComplete = {(result: MPIdentityApiResult?, error: Error?) in
if let user = result?.user {
user.setUserAttribute("example attribute key", value: "example attribute value")
} else {
//gérer l'échec - voir la section "Gestion des erreurs" ci-dessous
}
}
MParticle.sharedInstance().start(with: options)
return true
}
#```objective-c
import <mParticle_Apple_SDK/mParticle.h>
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
// Initialiser le SDK
MParticleOptions *options = [MParticleOptions optionsWithKey:@"your-key"
secret:@"your-secret"];
// Spécifier l'environnement de données avec environment:
// Définissez-le sur MPEnvironmentDevelopment si vous testez encore votre intégration.
// Définissez-le sur MPEnvironmentProduction si votre intégration est prête pour les données de production.
// La valeur par défaut est MPEnvironmentAutoDetect qui tente de détecter l'environnement automatiquement
options.environment = MPEnvironmentDevelopment;
// Identifier l'utilisateur actuel:
// Si vous n'avez pas l'adresse e-mail de l'utilisateur, vous pouvez passer une valeur nulle
MPIdentityApiRequest *identifyRequest = [MPIdentityApiRequest requestWithEmptyUser];
// Si vous utilisez une adresse e-mail non hachée, définissez-la dans 'email'.
identifyRequest.email = @"j.smith@example.com";
options.identifyRequest = identifyRequest;
// Si l'utilisateur est identifié avec son adresse e-mail, définissez des attributs utilisateur supplémentaires.
options.onIdentifyComplete = ^(MPIdentityApiResult *_Nullable apiResult, NSError *_Nullable error) {
if (apiResult) {
[apiResult.user setUserAttribute:@"example attribute key"
value:@"example attribute value"];
} else {
//gérer l'échec - voir https://docs.mparticle.com/developers/sdk/ios/idsync/#error-handling
}
};
[[MParticle sharedInstance] startWithOptions:options];
return YES;
}
2.1 Identifier l'utilisateur lors de l'initialisationLien direct vers 2.1 Identifier l'utilisateur lors de l'initialisation
Lorsque le SDK est initialisé, il peut identifier l'utilisateur actuel afin que toutes les données collectées lui soient correctement attribuées et pour s'assurer qu'il voit les publicités les plus pertinentes en fonction de son comportement.
Le script d'initialisation du SDK inclut un objet appelé identifyRequest :
- Swift
- Objective-C
let identifyRequest = MPIdentityApiRequest.withEmptyUser()
identifyRequest.email = "j.smith@example.com"
options.identifyRequest = identifyRequest
MPIdentityApiRequest *identifyRequest = [MPIdentityApiRequest requestWithEmptyUser];
identifyRequest.email = @"j.smith@example.com";
options.identifyRequest = identifyRequest;
2.2 Définir des attributs utilisateur supplémentairesLien direct vers 2.2 Définir des attributs utilisateur supplémentaires
Le script d'initialisation inclut une fonction de rappel (callback) qui vous permet de définir des attributs utilisateur supplémentaires si l'utilisateur est correctement identifié avec son adresse e-mail :
- Swift
- Objective-C
options.onIdentifyComplete = {(result: MPIdentityApiResult?, error: Error?) in
if let user = result?.user {
user.setUserAttribute("example attribute key", value: "example attribute value")
} else {
//gérer l'échec - voir la section "Gestion des erreurs" ci-dessous
}
}
options.onIdentifyComplete = ^(MPIdentityApiResult *_Nullable apiResult, NSError *_Nullable error) {
if (apiResult) {
[apiResult.user setUserAttribute:@"example attribute key"
value:@"example attribute value"];
} else {
//gérer l'échec - voir https://docs.mparticle.com/developers/sdk/ios/idsync/#error-handling
}
};
3. Identifier l'utilisateur lorsque les données deviennent disponiblesLien direct vers 3. Identifier l'utilisateur lorsque les données deviennent disponibles
Dès que l'utilisateur fournit son adresse e-mail après l'initialisation du SDK (par exemple, lorsqu'il se connecte ou effectue un achat), vous devez appeler la méthode identify pour transmettre son e-mail à Rokt. Cela garantit que les données sont correctement attribuées à l'utilisateur actuel.