SDK de píxeles universal para Android

Artículo
05/18/2024

En este documento se proporcionan instrucciones sobre cómo los publicadores pueden integrar e instalar el SDK universal de píxeles (Pixie SDK) para Android.

Instrucciones de integración

Requisitos

Este SDK requiere

Android 4.0 o posterior
Android SDK versión 14 o posterior

Para usar el SDK de Pixie, debe tener un identificador de píxel unificado Xandr válido. Se trata de un identificador alfanumérico que representa un píxel en la aplicación.

Nota:

Google Play

Para habilitar el id. de publicidad de Android (AAID), debes incluir Google Play Services como una dependencia de la aplicación. El SDK de Xandr seguirá funcionando sin Google Play Services, pero no generará los resultados deseados.

Android Studio y Gradle

En estas instrucciones se supone que usa Android Studio y Gradle. Todas las entradas de AndroidManifest.xml necesarias y los cambios de ProGuard se agregan automáticamente a la aplicación. Si usa otros sistemas de compilación, los pasos pueden variar.

Guía de instalación

Instale a través de Maven desde el build.gradle archivo como se muestra a continuación. Tenga en cuenta que la [1,2) notación significa que, cuando se compile la aplicación, se incluirá la versión más reciente del SDK de la serie de versiones 1.x. Cuando publicamos una nueva versión del SDK, todo lo que tiene que hacer para obtener la nueva versión es volver a compilar la aplicación. Tenga en cuenta que se trata de bloques de nivel superior, no parte del bloque 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")
}

Guía de implementación

Inicialización

Inicialice el sdk lo antes posible en el ciclo de vida de la aplicación mediante el método initialize(), pasando el identificador de píxel y el contexto como parámetros.

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

Seguimiento del evento

Una vez inicializado el SDK, los eventos se pueden realizar un seguimiento y enviar mediante el método fireEvent().

Nota:

Se rechazarán los eventos de los que se realice el seguimiento antes de la inicialización.

Pixie.fireEvent(event: String, params: PixieParams, context: Context);

El método fireEvent() toma cadena de evento, PixieParams(opcional) y contexto de aplicación como parámetros.

event: String

Las cadenas de eventos estándar se definen dentro de la clase Event. Consulte a continuación las cadenas de eventos estándar disponibles. También tienes la opción de definir cadenas de eventos personalizados en la interfaz de usuario de píxeles universales y usarlas en la aplicación.

Las cadenas de eventos personalizadas deben registrarse previamente mediante la interfaz de usuario de píxeles universal.

params: PixieParams

Al realizar el seguimiento de un evento (evento estándar y evento personalizado), opcionalmente también puede pasar datos asociados a ese evento. Los datos del evento se representan mediante la clase PixieParams. Todos los parámetros son opcionales.

Nombre	Descripción
Propiedades
currency: String	Moneda del valor especificado.
itemId : String	Identificador genérico del elemento representado. Los identificadores también se pueden pasar como una matriz de elementos separados por comas. Ejemplo "itemId1, itemId2"
itemName : String	Nombre del elemento representado. Los nombres también se pueden pasar como una matriz de elementos separados por comas. Ejemplo "itemName1, itemName2"
itemType : String	Tipo genérico del elemento representado. Los tipos también se pueden pasar como una matriz de elementos separados por comas. Ejemplo "itemType1, itemType2"
value : String	Valor de un usuario que realiza este evento en la empresa.
Función
put(key: String, value: String)	Datos arbitrarios definidos por el publicador. Habilita el paso de datos de eventos personalizados a través de pares clave-valor. Las claves deben registrarse previamente mediante la interfaz de usuario de píxeles universales. Los valores pueden ser una matriz separada por una coma.

context: Context

Un contexto de aplicación

Ejemplo de código de inicialización:

Kotlin

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

Java

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

Seguimiento del evento estándar: vista de página

Event.PAGE_VIEW

Página específica que se visitó.

Ejemplo de código:

Kotlin

Pixie.fireEvent(Event.PAGE_VIEW,context)

Java

Pixie.fireEvent(Event.PAGE_VIEW,context);

Seguimiento de las vistas de página de aterrizaje

Event.LANDING_PAGE

Realizar un seguimiento de las vistas de las páginas de aterrizaje.

Ejemplo de código:

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);

Seguimiento de las vistas de página clave

Event.ITEM_VIEW

Realizar un seguimiento de las vistas de página clave (por ejemplo, página de producto, página de aterrizaje, artículo).

Ejemplo de código:

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);

Seguimiento del evento de adición al carro

Event.ADD_TO_CART

Realice un seguimiento de cuándo se agregan artículos a un carro de la compra (por ejemplo, haga clic en la página de aterrizaje en el botón Agregar al carro).

Ejemplo de código:

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);

Seguimiento del evento de desprotección

Event.INITIATE_CHECKOUT

Realice un seguimiento de cuándo los usuarios entran en el flujo de pago (por ejemplo, haga clic en la página de aterrizaje en el botón de desprotección).

Ejemplo de código:

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);

Seguimiento de la información de adición de pago

Event.ADD_PAYMENT_INFO

Realizar un seguimiento de cuándo se agrega la información de pago en el flujo de pago (por ejemplo, haga clic en la página de aterrizaje de la información de facturación)

Ejemplo de código:

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);

Seguimiento del evento de compra

Event.PURCHASE

Realice un seguimiento de las compras o las finalizaciones del flujo de pago (por ejemplo: Aterrizaje en "Gracias" o página de confirmación).

Ejemplo de código:

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];

Seguimiento de clientes potenciales

Event.LEAD

Realice un seguimiento cuando alguien exprese interés en su oferta (por ejemplo: envío de formularios, registro para la prueba, registro).

Ejemplo de código:

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);

Seguimiento de eventos personalizados

Los eventos personalizados permiten a los publicadores crear sus propios eventos para realizar un seguimiento y enviarlos. Para crear un evento personalizado, inicie un objeto PixelParams con los datos que se van a enviar y pase ese objeto, junto con un identificador de cadena al método fireEvent del SDK de Pixie. Los datos de eventos personalizados también se pueden enviar en pares clave-valor mediante el método put del objeto PixelParams.

Ejemplos de código:

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)

Habilitación del registro

El SDK de Pixie incluye una característica de modo de depuración que permite el registro durante el desarrollo. Esto se puede activar estableciendo la variable debugMode en true. Todo el registro se deshabilitará en la compilación de versión.

$ adb shell setprop log.tag.PIXIE VERBOSE

Compartir a través de

SDK de píxeles universal para Android

Instrucciones de integración

Guía de instalación

Guía de implementación

Inicialización

Seguimiento del evento

Seguimiento del evento estándar: vista de página

Seguimiento de las vistas de página de aterrizaje

Seguimiento de las vistas de página clave

Seguimiento del evento de adición al carro

Seguimiento del evento de desprotección

Seguimiento de la información de adición de pago

Seguimiento del evento de compra

Seguimiento de clientes potenciales

Seguimiento de eventos personalizados

Habilitación del registro

Recursos adicionales