Cordova API

Listado de métodos disponibles en la API

Nombre del método Parámetros Descripción 
startSession  (Object configuration) Inicio de sesión en EMMA
startPush  (Object pushOptions) Registro de la app para recibir notificaciones push.
trackLocation  - Inicio del seguimiento para la ubicación 
trackEvent  (Object eventRequest) Envío de evento
trackUserExtraInfo
 (Object extras) Envío de tags (key-value) asociados al usuario
loginUser (Object loginRequest)  Envío de evento login
registerUser  (Object registerRequest) Envío de evento register
startOrder  (Object order) Inicio de una compra.
addProduct  (Object product)  Añade productos a la compra
trackOrder  Envío de la compra añadida en startOrder con los productos añadidos con addProduct
cancelOrder   (String orderId) Cancela la compra añadida en startOrder con orderId específico
 inAppMessage  (Object messageRequest) Comprueba si hay disponible comunicaciones in-app 
enableUserTracking
Activa el registro de datos referente al usuario 
disableUserTracking
 (Boolean deleteUser) Desactiva el registro de datos referente al usuario
isUserTrackingEnabled
Devuelve si el registro de datos del usuarios esta activo o no

 

startSession(configuration): void

Inicio de sesión en EMMA.

Parámetro Tipo Descripción 
 configuration  Object  Configuración del SDK

configuration

Nombre Tipo Por defecto  Descripción 
 sessionkey string  No hay por defecto, es obligatorio Session Key de la app en EMMA
 debug boolean  false Debug activo o inactivo
 queueTime int  10 Intervalo entre envios de la cola de request (No es recomendable tocar este valor)
 trackScreenEvents
boolean true Envío de eventos de pantalla
 powlinkDomains Array<string> ["powlink.io"] Añadir dominios custom de powlink (Solo aplica a apps con EMMA en on-premise)
customShortPowlinkDomains
Array<string> ["pwlnk.io"] Añadir dominios STU para short powlink (Solo aplica a apps con EMMA en on-premise)
 apiUrl

string

"https://api.emma.io" Añadir url para API (Solo aplica para clientes que tenga proxy configurado)

 

startPush(options): void

Registro de push para la app. Cuando se invoca este método se obtiene un token de push y se envía a EMMA.

Parámetro Tipo Descripción 
 options  Object Este parámetro solo se usa para la configuración del push en Android. En iOS la configuración va por defecto, esta se ignorará.

options

Nombre Tipo Por defecto  Descripción 
classToOpen
string No hay por defecto, es obligatorio.  Este es un parámetro heredado del SDK nativo, aunque cuando se usa Cordova solo hay una activity (MainActivity) es necesario pasarle el path absoluto de esta ${config_id}.MainActivity, donde config_id es el id de config.xml.
iconResource
string No hay por defecto, es obligatorio.  Nombre del png añadido a la app como icono de notificación
notificationColor
string - Color para el background de la notificación. Tienes que ser un string con un valor hexadecimal, por ejemplo "#ffff"
 trackScreenEvents
boolean true Envío de eventos de pantalla
notificationChannelName
string Nombre de la app

Nombre visible en settings para desactivar notificaciones.

Solo aplica a Android O.

notificationChannelId
string -

En el caso de usar ya un channelId para otra notificación se puede pasar a EMMA para usar el mismo.

Solo aplica a Android O.

 

trackLocation(): void

Seguimiento de la localización del usuario. Solo se recoge cuando arranca la app o recorre una larga distancia. No se hace de forma intrusiva.

 

trackEvent(eventRequest): void

Envío de un evento específico.

Parámetro Tipo Descripción 
 eventRequest Object Parámetros de la request referente al evento

eventRequest

Nombre Tipo Por defecto  Descripción 
token
string No hay por defecto, es obligatorio.  El token que referencia al evento enviado. Los tokens se obtiene en el dashboard de EMMA. Se pueden añadir alias.
attributes object - Propiedades key-value para añadir al evento (Parcialmente soportado).

 

trackUserExtraInfo(extras): void

Envia tags asociados al usuario/device que ha iniciado sesión. Estos tags se guardan como propiedades para realizar por ejemplo filtros.

Parámetro Tipo Descripción 
 extras Object Propiedades Key-value (string - string)

 

loginUser(loginRequest): void

Envío de un evento login. Asocia un usuario a la sesión.

Parámetro Tipo Descripción 
 loginRequest Object Parametros de la request referente al login

loginRequest

Nombre Tipo Por defecto  Descripción 
userId
string No hay por defecto, es obligatorio.  Id del usuario en la BBDD del cliente para asociarlo a EMMA.
email string - Email de usuario para asociarlo a EMMA.
extras object (key-value) - Asocia tags al evento login

 

registerUser(registerRequest): void

Envío de un evento register. Asocia un usuario a la sesión.

Parámetro Tipo Descripción 
 registerRequest  Object Parametros de la request referente al registro

registerRequest

Nombre Tipo Por defecto  Descripción 
userId
string No hay por defecto, es obligatorio.  Id del usuario en la BBDD del cliente para asociarlo a EMMA.
email string - Email de usuario para asociarlo a EMMA.
extras object (key-value) - Asocia tags al evento register

 

startOrder(order): void

Inicio de una compra

Parámetro Tipo Descripción 
 order Object Parámetros asociados a la compra

order

Nombre Tipo Por defecto  Descripción 
 orderId string  No hay por defecto, es obligatorio  orderId establecido por el cliente para la compra
 totalPrice double  No hay por defecto, es obligatorio Precio total asociado a la compra
 customerId string  No hay por defecto, es obligatorio en algunos casos User Id de la BBDD del cliente. Este parámetro no es necesario si previamente se ha identificado la sessión con un usuario haciendo un evento register o login.
currencyCode string EUR Moneda usada en la compra (ISO 4217 - code alpha)
 coupon string - Cupón de descuento usado en la compra
 extras object (key-value) - Tags asociados a la compra para usar en filtros.

 

addProduct(product): void

Añade un producto a la compra iniciada. Pueden añadirse varios productos a una compra.

Parámetro Tipo Descripción 
 product Object Producto asociado a la compra iniciada

product

Nombre Tipo Por defecto  Descripción 
 productId string No hay por defecto, es obligatorio Product Id establecido por el cliente para el producto
 productName string No hay por defecto, es obligatorio Nombre del producto establecido por el cliente
 quantity int No hay por defecto, es obligatorio Cantidad de productos de este tipo comprados
price double No hay por defecto, es obligatorio Precio de cada producto de este tipo
 extras object (key-value) - Tags asociados al producto para usar en filtros.

 

trackOrder(): void

Envía a EMMA la compra y los productos previamente añadidos.

 

cancelOrder(orderId): void

Cancela una compra previamente realizada asociada al orderId

Parámetro Tipo Descripción 
 orderId String Id asociado a la compra que se quieren cancelar

 

inAppMessage(messageRequest): void

Comprueba si hay comunicaciones activas y en caso de que si haya la muestra.

Parámetro Tipo Descripción 
 messageRequest Object Parámetros asociados a la request

messageRequest

Nombre Tipo Por defecto  Descripción 
type string No hay por defecto, es obligatorio

Tipo de comunicación a comprobar. Este parámetro puede tener varios tipos definidos en el JS del plugin, para usarlos por ejemplo:

EMMA.inAppType.STARTVIEW

Tipos definidos:

STARTVIEW:'startview'
ADBALL:'adball'
STRIP:'strip'
BANNER:'banner' //only Android
NATIVEAD:'nativeAd'
templateId string - Template Id a consultar para el tipo Native Ad. Solo aplica a este tipo.
batch boolean false Devuelve varios elementos in-app disponibles. De momento solo aplica al tipo Native Ad.
inAppResponse
(inAppResponse) => void - Callback que devuelve las respuestas inApp en raw JSON. De momento solo aplica al tipo Native Ad

 

enableUserTracking(): void

Activa el envío de datos referentes al usuario. Por defecto esta activo.

 

disableUserTracking(deleteUser): void

Desactiva el envío de datos referentes al usuario con la posibilidad de borrarlo definitivamente.

Parámetro Tipo Descripción 
 deleteUser  Boolean Borrar el usuario asociado a la sesión

 

isUserTrackingEnabled(callback): void

Permite saber el estado del envío de datos del usuario.

Parámetro Tipo Descripción 
 callback  (active) => void true o false
¿Tiene más preguntas? Enviar una solicitud

0 Comentarios

Inicie sesión para dejar un comentario.