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

Ce document 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 Android.

Instructions d’intégration

Conditions requises

Ce Kit de développement logiciel (SDK) nécessite

• Android 4.0 ou version ultérieure
• Android SDK version 14 ou ultérieure

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

Installez via Maven à partir de votre build.gradle fichier, comme indiqué ci-dessous. Notez que la [1,2) notation signifie que lorsque votre application est compilée, la dernière version du Kit de développement logiciel (SDK) de la série de versions 1.x est incluse. Lorsque nous publions une nouvelle version du Kit de développement logiciel (SDK), il vous suffit de recompiler votre application pour obtenir la nouvelle version. Notez qu’il s’agit de blocs de niveau supérieur, qui ne font pas partie du bloc buildscript.

// Android: Gradle config to install the SDK
apply plugin: 'kotlin-android'
apply plugin: 'kotlin-android-extensions'
repositories {
    maven{
        url "https://acdn.adnxs.com/mobile/pixiesdk/android/maven/"
    }
}
dependencies {
    implementation 'com.xandr.pixie:pixie-sdk:[1,2)'
    implementation("com.google.android.gms:play-services-ads-identifier:17.0.0")
}

Guide d’implémentation

Initialisation

Initialisez le sdk le plus tôt possible dans le cycle de vie de l’application à l’aide de la méthode initialize(), en passant l’ID de pixel et le contexte en tant que paramètres.

Pixie.initialize(pixel_id: String, context: Context); 

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(event: String, params: PixieParams, context: Context);

La méthode fireEvent() prend la chaîne d’événement, PixieParams(facultatif) et le contexte d’application en tant que paramètres.

event : String

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

Les chaînes d’événements personnalisées doivent être préinscriées à l’aide de l’interface utilisateur de pixels universels.

params : PixieParams

Lors du suivi d’un événement (événement standard et événement personnalisé), vous pouvez également transmettre les données associées à cet événement. Les données d’événement sont représentées par la classe PixieParams. Tous les paramètres sont facultatifs.

context : Context

Contexte d’application

Exemple de code d’initialisation :

Kotlin

Pixie.initialize("2dad9dcd-de80-4dd1-b900-f4349082ab57",context)

Java

Pixie.initialize("2dad9dcd-de80-4dd1-b900-f4349082ab57",context);

Suivre l’événement standard - affichage page

Event.PAGE_VIEW

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

Exemple de code : 

Kotlin

Pixie.fireEvent(Event.PAGE_VIEW,context)

Java

Pixie.fireEvent(Event.PAGE_VIEW,context);

Suivre les affichages de la page d’accueil

Event.LANDING_PAGE

Suivre les vues des pages d’accueil.

Exemple de code :

Kotlin

val landingPageParams = PixieParams(Value = "5.99", Currency = "USD", ItemId = "product_5,product_6", ItemName = "apparel,accessory", ItemType = "shirt,belt")
Pixie.fireEvent(Event.LANDING_PAGE,landingPageParams,context)

Java

PixieParams landingPageParams = new PixieParams("5.99","USD","product_5,product_6", "apparel,accessory","shirt,belt");
Pixie.fireEvent(Event.LANDING_PAGE,landingPageParams,context);

Suivre les affichages de pages clés

Event.ITEM_VIEW

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

Exemple de code :

Kotlin

val itemViewParams = PixieParams(Value = "5.99", Currency = "USD", ItemId = "product_5,product_6", ItemName = "apparel,accessory", ItemType = "shirt,belt")
Pixie.fireEvent(Event.ITEM_VIEW,itemViewParams,context)

Java

PixieParams itemViewParams = new PixieParams("5.99","USD","product_5,product_6", "apparel,accessory","shirt,belt");
Pixie.fireEvent(Event.ITEM_VIEW,itemViewParams,context);

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

Event.ADD_TO_CART

Suivez 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 :

Kotlin

val addToCartParams = PixieParams(Value = "5.99", Currency = "USD", ItemId = "product_5,product_6", ItemName = "apparel,accessory", ItemType = "shirt,belt")
Pixie.fireEvent(Event.ADD_TO_CART,addToCartParams,context)

Java

PixieParams addToCartParams = new PixieParams("5.99","USD","product_5,product_6", "apparel,accessory","shirt,belt");
Pixie.fireEvent(Event.ADD_TO_CART,addToCartParams,context); 

Suivre l’événement de validation

Event.INITIATE_CHECKOUT

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

Exemple de code :

Kotlin

val initiateCheckOutParams = PixieParams(Value = "5.99", Currency = "USD", ItemId = "product_5,product_6", ItemName = "apparel,accessory", ItemType = "shirt,belt")
Pixie.fireEvent(Event.INITIATE_CHECKOUT,initiateCheckOutParams,context)

Java

PixieParams initiateCheckOutParams = new PixieParams("5.99","USD","product_5,product_6", "apparel,accessory","shirt,belt");
Pixie.fireEvent(Event.INITIATE_CHECKOUT,initiateCheckOutParams,context);

Suivre l’ajout d’informations de paiement

Event.ADD_PAYMENT_INFO

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

Exemple de code :

Kotlin

val addPaymentInfo = PixieParams(Value = "5.99", Currency = "USD", ItemId = "product_5,product_6", ItemName = "apparel,accessory", ItemType = "shirt,belt")
Pixie.fireEvent(Event.ADD_PAYMENT_INFO,addPaymentInfoParams,context)

Java

PixieParams addPaymentInfoParams = new PixieParams("5.99","USD","product_5,product_6", "apparel,accessory","shirt,belt");
Pixie.fireEvent(Event.ADD_PAYMENT_INFO,addPaymentInfoParams,context);

Suivre l’événement d’achat

Event.PURCHASE

Suivez les achats ou les achèvements de flux de validation (par exemple : atterrissage sur « Merci » ou page de confirmation).

Exemple de code :

Kotlin

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

Java

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, inscription).

Exemple de code :

Kotlin

val leadParams = PixieParams(Value = "5.99", Currency = "USD")
Pixie.fireEvent(Event.LEAD,leadParams,context)

Java

PixieParams leadParams =  new PixieParams();
leadParams.setValue("5.99");
leadParams.setCurrency("USD");
Pixie.fireEvent(Event.LEAD,leadParams,context);

Suivre l’événement personnalisé

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 :

Kotlin

val customPixieParams = PixieParams(Value = "5.99", Currency = "USD")
customPixieParams.put("name", "Form Submission")
customPixieParams.put("email", "user1@appnexus.com")
customPixieParams.put("type", "subscribe,newuser")
Pixie.fireEvent("TestCustomEvent", customPixieParams, context)

Java

PixieParams customPixieParams=new PixieParams();
leadParams.setValue("5.99");
leadParams.setCurrency("USD");
customPixieParams.put("name","Form Submission");
customPixieParams.put("email","user1@appnexus.com");
customPixieParams.put("type","subscribe,newuser");
Pixie.fireEvent("TestCustomEvent",customPixieParams,context)

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.

$ adb shell setprop log.tag.PIXIE VERBOSE