SDK API Guide

Configurar la identificación del usuario

Definición de la interfaz

• identifyAccount(user);
  • Descripción de la interfaz:
    • Configurar la identificación del usuario, como un número de tarjeta de socio.
  • Descripción de parámetros
    • identity: El ID de identificación del usuario.
    • completion: El callback.

Ejemplo de llamada

              
                  let user = {completion: (code, message) => {}, identity: {"id": "value"}}
    window.MAInterface.identifyAccount(user)

            

Obtener EUID

Definición de la interfaz

• • EUID()
  • Descripción de la interfaz:
    • Obtener el EUID de EngageLab MA.

Ejemplo de llamada

              
                  window.MAInterface.EUID((code, euid) => {
        console.log(code, euid)
    })

            

Configurar la información de contacto del usuario

Definición de la interfaz

• setUserContact(user)
  • Descripción de la interfaz:
    • Permite configurar simultáneamente varios métodos de contacto. La clave representa el nombre del método de contacto y el valor representa su valor correspondiente. Actualmente, se admiten 4 tipos de métodos de contacto: email, mobile_phone, landline_phone y whatsapp_phone.
  • Descripción de parámetros
    • contacts: La información de contacto del usuario.
    • completion: El callback.

Ejemplo de llamada

              
                    let user = {
          completion: (code, message) => { },
          contacts: {}
       }
      user.contacts["Name of Contact Method"] = "Value of Contact Method"   // For example: mobile_phone = 18800000000
      window.MAInterface.setUserContact(user)

            

Configurar propiedades UTM

Definición de la interfaz

• setUtmProperties(attrs:any)
  • Descripción de la interfaz:
    • Las propiedades UTM son propiedades estándar de eventos. Si los desarrolladores pueden identificar qué anuncio dirigió al usuario a la App, se recomienda configurar la información UTM. Este parámetro se incluirá al reportar eventos. Actualmente, las propiedades UTM que se pueden configurar son:
      • utm_source: La fuente de la campaña publicitaria.
      • utm_medium: El medio de la campaña publicitaria.
      • utm_term: El término de la campaña publicitaria.
      • utm_content: El contenido de la campaña publicitaria.
      • utm_campaign: El nombre de la campaña publicitaria.
      • utm_id: El ID de la campaña publicitaria.

Ejemplo de llamada

              
                 window.MAInterface.setUtmProperties({"utm_source": "value1"})

            

Configurar propiedades del usuario

Configurar los valores de las propiedades del usuario. Si una propiedad del usuario no existe, se creará automáticamente en el backend.

Sobrescribir y actualizar propiedades del usuario

• setProperty(user, completion)
  • Descripción de la interfaz:
    • Sobrescribir y actualizar los valores de las propiedades del usuario.
    • Solo se guarda el último dato reportado, sustituyendo los datos históricos, como el nivel de socio del usuario.
    • El contenido de estas propiedades del usuario se almacena en un objeto. La clave es el nombre de la propiedad del usuario y debe ser un string. El valor es el contenido de la propiedad del usuario y solo admite tipos como string, number y Array.
    • Actualmente, los elementos en el valor de tipo Array solo admiten ser strings.
    • Si una determinada propiedad del usuario ya existía previamente, en esta ocasión se sobrescribirá; si no existe, se creará.
  • Ejemplo de llamada:

              
                 window.MAInterface.setProperty({key: "value"}, (code, message) => {})

            

Incrementar y actualizar propiedades del usuario

• increaseProperty(user, completion)
  • Descripción de la interfaz:
    • Configurar un incremento para los valores de las propiedades del usuario.
    • Añadir valores a varias propiedades numéricas del usuario. Acumular todos los datos reportados, como el importe de consumo acumulado.
    • Esta interfaz solo se puede usar para propiedades del usuario de tipo number; de lo contrario, se ignorará. Si esta propiedad del usuario no existía previamente, el valor inicial se considera 0.
  • Ejemplo de llamada:

              
               window.MAInterface.increaseProperty({key: 1}, (code, message) => {})

            

Añadir propiedades del usuario

• addProperty(key, content, completion)
  • Descripción de la interfaz:
    • Añadir valores a los valores de las propiedades del usuario.
    • Añadir elementos continuamente a este conjunto. Los elementos duplicados se eliminan al almacenarse en la base de datos. Si ya existe ABC y se añade CD, el resultado final será ABCD, como las noticias que le gustan al usuario.
    • Añadir valores a una propiedad de tipo Array. Los elementos del Array deben ser strings; de lo contrario, se ignorarán. Al mismo tiempo, si la propiedad del usuario a la que se va a añadir no existía previamente, se inicializará un Array vacío.
  • Ejemplo de llamada:

              
               window.MAInterface.addProperty("key", ["value1", "value2"], (code, message) => {})

            

Eliminar propiedades del usuario

• removeProperty(key, content, completion)
  • Descripción de la interfaz:
    • Eliminar uno o más valores de una propiedad de tipo Array.
    • Eliminar algunos valores de una propiedad de tipo Array. Los elementos de este Array deben ser strings; de lo contrario, se ignorará. Al mismo tiempo, si la propiedad del usuario de la que se va a eliminar no existía previamente, no tendrá efecto.
  • Ejemplo de llamada:

              
               window.MAInterface.removeProperty("key", ["value1", "value2"], (code, message) => {})

            

Eliminar propiedades del usuario

Definición de la interfaz

• deleteProperty(key, completion)
  • Descripción de la interfaz:
    • Eliminar todo el contenido de valores de una determinada propiedad del usuario.
    • Si esta propiedad del usuario no existía previamente, se ignorará directamente.

Ejemplo de llamada

              
               window.MAInterface.deleteProperty("key", (code, message) => {})

            

Configurar el tiempo de espera de la sesión

Definición de la interfaz

• setSessionTimeout(time)
  • Descripción de la interfaz:
    • Configurar el tiempo de espera de la sesión. Cuando la página pasa a segundo plano, se inicia el tiempo de espera de la sesión. Si se supera el tiempo configurado (predeterminado: 30 minutos), la sesión finalizará.

Ejemplo de llamada

              
               window.MAInterface.setSessionTimeout(60)

            

Configurar el tiempo de permanencia en la página

Definición de la interfaz

• setPageStayTime(time)
  • Descripción de la interfaz:
    • Configurar la duración del tiempo de permanencia en la página.
    • Iniciar el conteo tras acceder a la página. Si el usuario permanece en la página durante time segundos sin salir, se reportará este evento.
    • De forma predeterminada, se reporta en 6 puntos de tiempo: 5 segundos, 30 segundos, 60 segundos, 2 minutos, 5 minutos y 10 minutos. Los desarrolladores pueden llamar a esta interfaz para añadir más puntos de tiempo.

Ejemplo de llamada

              
               window.MAInterface.setPageStayTime(60)

            

Reportar eventos

Si un evento no existe, se reporta directamente y el backend creará automáticamente el evento.

Definición de la interfaz

• onEvent(event)
  • Descripción de la interfaz:
    • Reportar un evento.
  • Descripción de parámetros
    • event: El evento que se va a reportar. name es el nombre del evento y properties es la información de propiedades del evento. La clave es el nombre de la propiedad y el valor es el valor de la propiedad.

Ejemplo de llamada

              
                 let event = {name: "name", properties: {key: "value"}}
    window.MAInterface.onEvent(event)