Kit de développement logiciel (SDK) de pixels universels pour iOS

Cet article fournit des instructions sur la façon dont les éditeurs peuvent intégrer et installer le Kit de développement logiciel (SDK) Pixel universel (SDK Pixie) pour iOS.

Instructions d’intégration

Configuration requise

Le Kit de développement logiciel (SDK) nécessite les composants suivants :

• macOS Mojave 10.14.4+
• iOS 9+
• Swift 5+
• Xcode 11+

Pour utiliser le Kit de développement logiciel (SDK) Pixie, vous devez disposer d’un ID de pixel unifié Xandr valide. Il s’agit d’un ID alphanumérique qui représente un pixel dans votre application.

Guide d’installation

Il existe deux façons d’installer le Kit de développement logiciel (SDK) :

• Utilisation de CocoaPods

  CocoaPods est un gestionnaire de dépendances pour les projets Cocoa. Si vous n’êtes pas familiarisé avec CocoaPods, passez en revue leurs guides d’installation et d’utilisation.

  1. Une fois que CocoaPods est installé, à l’aide du terminal ou de l’éditeur de ligne de commande de votre choix, accédez au répertoire racine de votre projet et créez un podfile.

     pod init
     

  2. À l’aide d’un éditeur de texte, ouvrez le fichier podfile nouvellement créé. Définissez la version de la plateforme sur 9.0 et ajoutez le pod PixieSDK à la cible.

     # iOS: Podfile config to include our SDK
     platform :ios, '9.0'
     project 'SampleApp'
     target 'SampleApp' do
       pod 'PixieSDK'
     end
     

  3. Enregistrez vos modifications et revenez au Terminal et entrez :

     pod install
     

  4. CocoaPods télécharge le Kit de développement logiciel (SDK) Pixie et crée un espace de travail dans le répertoire du projet. Si votre projet est actuellement ouvert, fermez-le et ouvrez l’espace de travail.

• Utilisation de Xandr Unified Pixel SDK XCFramework

  Remarque

  Nous distribuons PixieSDK.xcframework, que vous pouvez télécharger ici. Téléchargez le fichier et ajoutez-le au dossier Frameworks .

1. Create dossier Frameworks.

   Cliquez avec le bouton droit sur votre projet dans le navigateur de projet (entrée la plus haute), puis sélectionnez Nouveau groupe. Nommez le nouveau groupe frameworks.

   

2. Ajoutez PixieSDK.xcframework au dossier Frameworks.

   Glissez-déplacez PixieSDK.xcframework du Finder vers le dossier Frameworks . Assurez-vous que la destination du glisser se trouve juste sous les frameworks.

   

3. Vérifiez que les options Copier les éléments si nécessaire et Create groupes sont cochées et sélectionnées pour ajouter des fichiers. Cliquez sur Terminer.

   

4. Une fois cette étape terminée, le résultat s’affiche comme suit :

   

5. PixieSDK.xcframework incorporé dans la cible du projet

6. Accédez aux paramètres de votre projet en cliquant dessus dans le navigateur de projet.

7. Assurez-vous que votre cible est sélectionnée et que l’onglet Général est ouvert.

8. Sélectionnez Incorporer & signer pour le XCFramework que vous venez d’ajouter.

   

Guide d’implémentation

Initialisation du Kit de développement logiciel (SDK)

Initialisez le SDK appelant sa méthode initialize dans la méthode didFinishLaunchingWithOptions dans le fichier du délégué d’application :

Pixie.initialize(pixelId:String)`

Suivre l’événement

Une fois le SDK initialisé, les événements peuvent être suivis et envoyés à l’aide de la méthode fireEvent.

Pixie.fireEvent(eventName : String, eventParams : PixieParams?)

La méthode fireEvent prend la chaîne d’événement et PixieParams(facultatif), car il s’agit de paramètres.

eventName :String

Les chaînes d’événements standard sont définies dans la classe Event. Consultez la section Événements standard ci-dessous pour connaître les chaînes d’événements standard disponibles. Vous avez également la possibilité de définir une ou plusieurs chaînes d’événements personnalisés dans l’interface utilisateur de pixel universel et de l’utiliser dans votre application.

La ou les chaînes d’événements personnalisées doivent être préinscrites à l’aide de l’interface utilisateur de pixels universels.

eventParams :PixieParams

Les données d’événement sont représentées par la classe PixieParams. Tous les paramètres sont facultatifs.

Exemples de code

Exemple de code d’initialisation

Swift

import PixieSDK
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        Pixie.initialize("b63be84e-d95b-4c67-8242-d9c9c026ed30")
        return true
        }

Objectif C

@import PixieSDK;
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [Pixie initialize:@"b63be84e-d95b-4c67-8242-d9c9c026ed30"];
    return YES;
} 

Vue de la page de suivi

Event.PAGE_VIEW`

Page spécifique qui a été visitée.

Exemples de code

Swift

Pixie.fireEvent(Event.PAGE_VIEW)

Objectif C

[Pixie fireEvent:Event.PAGE_VIEW eventParams:nil];

Suivre les affichages de la page d’accueil

Event.LANDING_PAGE`

Suivre les vues des pages d’accueil.

Exemples de code

Swift

let landingPageParams = PixieParams(value: "5.99", currency: "USD", itemId: "product_5,product_6", itemType: "apparel,accessory", itemName: "shirt,belt")
Pixie.fireEvent(Event.LANDING_PAGE, eventParams:landingPageParams)

Objectif C

PixieParams *landingPageParams = [[PixieParams alloc] initWithValue:@"5.99" currency:@"USD" itemId:@"product_5,product_6" itemType:@"apparel,accessory" itemName:@"shirt,belt"]; [Pixie fireEvent:Event.LANDING_PAGE eventParams:landingPageParams];

Vue d’élément de suivi

Event.ITEM_VIEW`

Suivre les affichages de pages clés (par exemple : page produit, page d’accueil, article).

Exemples de code

Swift

let itemViewParams = PixieParams(value: "5.99", currency: "USD", itemId: "product_5,product_6", itemType: "apparel,accessory", itemName: "shirt,belt")
               Pixie.fireEvent(Event.ITEM_VIEW, eventParams:itemViewParams)

Objectif C

PixieParams *itemViewParams = [[PixieParams alloc] initWithValue:@"5.99" currency:@"USD" itemId:@"product_5,product_6" itemType:@"apparel,accessory" itemName:@"shirt,belt"];
[Pixie fireEvent:Event.ITEM_VIEW eventParams:itemViewParams];

Suivre l’événement d’ajout au panier

Event.ADD_TO_CART`

Suivre quand des articles sont ajoutés à un panier d’achat (par exemple , cliquez sur la page d’accueil sur le bouton Ajouter au panier ).

Exemple de code

Swift

let addToCartParams = PixieParams(value: "5.99", currency: "USD", itemId: "product_5,product_6", itemType: "apparel,accessory", itemName: "shirt,belt")
               Pixie.fireEvent(Event.ADD_TO_CART, eventParams:addToCartParams)

Objectif C

PixieParams *addToCartParams = [[PixieParams alloc] initWithValue:@"5.99" currency:@"USD" itemId:@"product_5,product_6" itemType:@"apparel,accessory" itemName:@"shirt,belt"];
[Pixie fireEvent:Event.ADD_TO_CART eventParams:addToCartParams];

Suivre l’initiation de l’extraction

Event.INITIATE_CHECKOUT

Suivre le moment où les utilisateurs entrent dans le flux de validation (par exemple : clic, page d’accueil sur le bouton de validation).

Exemple de code

Swift

let initiateCheckOutParams = PixieParams(value: "5.99", currency: "USD", itemId: "product_5,product_6", itemType: "apparel,accessory", itemName: "shirt,belt")
               Pixie.fireEvent(Event.INITIATE_CHECKOUT, eventParams: initiateCheckOutParams)

Objectif C

PixieParams *initiateCheckOutParams = [[PixieParams alloc] initWithValue:@"5.99" currency:@"USD" itemId:@"product_5,product_6" itemType:@"apparel,accessory" itemName:@"shirt,belt"];
[Pixie fireEvent:Event.INITIATE_CHECKOUT eventParams:initiateCheckOutParams];

Suivre l’événement d’ajout d’informations de paiement

Event.ADD_PAYMENT_INFO`

Suivre quand les informations de paiement sont ajoutées dans le flux de validation (par exemple : clic, page d’accueil sur les informations de facturation).

Exemple de code

Swift

let addPaymentInfoParams = PixieParams(value: "5.99", currency: "USD", itemId: "product_5,product_6", itemType: "apparel,accessory", itemName: "shirt,belt")
               Pixie.fireEvent(Event.ADD_PAYMENT_INFO, eventParams: addPaymentInfoParams)

Objectif C

PixieParams *addPaymentInfo = [[PixieParams alloc] initWithValue:@"5.99" currency:@"USD" itemId:@"product_5,product_6" itemType:@"apparel,accessory" itemName:@"shirt,belt"];
[Pixie fireEvent:Event.ADD_PAYMENT_INFO eventParams:addPaymentInfo];

Suivre l’achat

Event.PURCHASE`

Suivez les achats ou les achèvements du flux de validation (par exemple : Atterrissage sur la page de remerciement ou de confirmation).

Exemple de code

Swift

let purchaseParams = PixieParams(value: "5.99", currency: "USD", itemId: "product_5,product_6", itemType: "apparel,accessory", itemName: "shirt,belt") 
   Pixie.fireEvent(Event.PURCHASE, eventParams: purchaseParams)

Objectif C

PixieParams *purchaseParams = [[PixieParams alloc] initWithValue:@"5.99" currency:@"USD" itemId:@"product_5,product_6" itemType:@"apparel,accessory" itemName:@"shirt,belt"];
[Pixie fireEvent:Event.PURCHASE eventParams:purchaseParams]; 

Suivre les prospects

Event.LEAD

Effectuez le suivi de l’intérêt d’une personne pour votre offre (par exemple : soumission de formulaire, inscription à la version d’évaluation et inscription).

Exemple de code

Swift

let leadParams = PixieParams(value: "5.99", currency: "USD")
Pixie.fireEvent(Event.LEAD, eventParams: leadParams)

Objectif C

PixieParams *leadParams = [[PixieParams alloc] init];
leadParams.value = @"5.99";
leadParams.currency = @"USD";
[Pixie fireEvent:Event.LEAD eventParams:leadParams];

Suivre les événements personnalisés

Les événements personnalisés permettent aux éditeurs de créer leurs propres événements à suivre et à envoyer. Pour créer un événement personnalisé, lancez un objet PixelParams avec les données à soumettre et transmettez cet objet, ainsi qu’un identificateur de chaîne à la méthode fireEvent du Kit de développement logiciel (SDK) Pixie. Les données d’événement personnalisées peuvent également être envoyées dans des paires clé-valeur à l’aide de la méthode put de l’objet PixelParams.

Exemples de code

Swift

let customPixieParams = PixieParams()
customPixieParams.value = "5.99"
customPixieParams.itemName = "shirt,belt"
//passing key value pairs with the put method
customPixieParams.put("name", "Form Submission")
customPixieParams.put("email", "user@appnexus.com")
customPixieParams.put("type", "subscribe,newuser")
Pixie.fireEvent("TestCustomEvent", eventParams: customPixieParams) ```

Objectif C

PixieParams *customPixieParams = [[PixieParams alloc] init];
customPixieParams.value = @"5.99";
customPixieParams.itemName = @"shirt,belt";
//passing key value pairs with the put method
[customPixieParams put:@"name" :@"Form Submission"];
[customPixieParams put:@"email" :@"user@appnexus.com"];
[customPixieParams put:@"type" :@"subscribe,newuser"];
[Pixie fireEvent:@"TestCustomEvent" eventParams:customPixieParams];

Activer la journalisation

Le Kit de développement logiciel (SDK) Pixie est fourni avec une fonctionnalité de mode débogage qui permet la journalisation pendant le développement. Cela peut être activé en définissant la variable debugMode sur true. Toute la journalisation sera désactivée dans la build de mise en production.

Swift

Pixie.shared.debugMode = true

Objectif C

Pixie.shared.debugMode = true;