El SDK de Javascript Appcues admite oficialmente los siguientes métodos como parte de su API:

Identificar

identify (userId, [properties])

Identifica al usuario actual con un ID y un conjunto opcional de propiedades. En segundo plano, esta llamada también invoca la función `.page()` Appcues . Esta es la única llamada necesaria para que Appcues se cargue y funcione en tu sitio. Los valores de las propiedades pueden ser cadenas, números o booleanos. ¡Atención! Cualquier llamada de identificación con un array u objeto anidado como valor de propiedad no aparecerá en tu cuenta Appcues .

Ejemplo:

Appcues.identify("1234", {
    name: "Jonathan",
    createdAt: 578721600000,
    company: "Appcues"
})

grupo (groupId, [propiedades])

Identifica el grupo actual (cuenta, empresa, etc.) del usuario con un ID y un conjunto opcional de propiedades. Los valores de las propiedades pueden ser cadenas, números o booleanos. Un usuario puede pertenecer a varios grupos, pero solo puede estar asociado a uno a la vez. Solo se considerará para la segmentación el grupo asociado más recientemente con el usuario.

Appcues.group("6789", {
    company_name: "Lendi Global",
    plan_level: "enterprise",
    employee_count: 12000,
    in_trial: false
})

anónimo

Genera un ID único basado en la sesión para el usuario actual. El uso de esta llamada probablemente aumentará sus MAU, así que asegúrese de leer esta descripción general antes de implementarla.

Ejemplo:

Appcues.anonymous();

página

Notifica al SDK que el estado de la aplicación ha cambiado. Puedes usar esto para avisarnos cuando la URL haya cambiado.

Ejemplo:

Appcues.page();

pista (nombreEvento, [PropiedadesEvento])

Rastrea un evento personalizado (por nombre) realizado por el usuario actual, junto con sus propiedades. Actualmente, no se permite la segmentación de audiencia basada en propiedades de evento. Sin embargo, se pueden usar para filtrar eventos en nuestra función de Activación de Eventos (disponible solo en planes Enterprise).

Como el nombre del evento se utiliza como identificador del evento, cambiar el formato o la convención de un nombre de evento hará que se ingiera como un evento diferente.

Ejemplo:

Appcues.track("Clicked button", {
    color: "red",
    buttonText: "Get started"
});

mostrar (contentId)

Obliga a que se muestre contenido específico Appcues (flujos, checklists o encuestas NPS ) al usuario actual, pasando el ID de contenido. Este método ignora cualquier segmentación establecida en el flujo o checklist . Una checklist que se haya mostrado forzosamente tendrá prioridad sobre cualquier otra checklists . La checklist se mostrará incluso si se descartó previamente. Si se usa para una checklist que ya se ha mostrado al usuario, el mensaje "Felicitaciones" no aparecerá al completarse.

Ejemplo:

Appcues.show("-ABCD123");

clearShow()

Detiene la fuerza para mostrar cualquier checklists que se muestre usando Appcues .show .

Ejemplo:

Appcues.clearShow();

en (nombreEvento, funciónDevoluciónDeCall, [contexto])

Ejecute la función de devolución de llamada cuando el SDK active el evento dado. Algunos ejemplos de eventos activados por el SDK incluyen:

• flow_started — un flujo se inicia por primera vez
• flow_completed — un flujo se ha completado
• flow_skipped — se omite un flujo
• step_interacted : un usuario interactúa con un paso del flujo, como hacer clic en el botón "Siguiente"
• form_submitted — se envía un formulario
• form_field_submitted — se activa para cada campo individual en el formulario enviado
• all — escucha todos los eventos emitidos por el SDK

Si eventName es all , callbackFn debe ser una función(eventName, event). Para todos los demás valores de eventName, callbackFn debe ser una función(event). El evento será un objeto con un aspecto similar a:

{"id":"step_attempted","name":"Paso intentado","flowId":"-L75x7dkvlvGcgIbMPSI","flowName":"Prueba desplegable","flowType":"recorrido","flowVersion":1522433413154,"timestamp":1555451877992,"sessionId":1555451877688,"stepId":"-L75xBtqpP8W4QUualko","stepType":" modal "}

Ejemplo de uso:

Appcues.on("flow_started", function(event) {
    console.log("Appcues started a flow with ID " + event.flowId);
});

Para obtener una visión más detallada de Appcues .on, consulte nuestra documentación aquí.

Para obtener una lista completa de los eventos activados por el SDK, consulte nuestra documentación aquí.

off (nombreEvento, funciónDevoluciónDeCall, [contexto])

Deshace una llamada correspondiente.

Ejemplo:

Appcues.off("flow_started");

una vez (nombreEvento, funciónDevoluciónDeCallo, [contexto])

Active la función de devolución de llamada la próxima vez que el SDK active el evento dado.

Ejemplo:

Appcues.once("flow_started", function() {
    console.log("Appcues started a flow.");
});

reiniciar

Borra toda la información conocida del usuario actual en esta sesión. Esta llamada borrará el flujo en curso y eliminará cualquier dato generado para un usuario. Esto es útil cuando el usuario cierra sesión en la aplicación.

Nota : Cuando se usa junto con la llamada anónima, esto puede provocar que los flujos se muestren dos veces, ya que el restablecimiento borrará la ID generada para ese invitado anónimo y luego la llamada anónima generará una nueva ID anónima.

Ejemplo:

Appcues.reset();

depurar (habilitar = verdadero)

Pone el SDK en modo de depuración, mostrando más información sobre el funcionamiento interno del SDK.

Ejemplo:

Appcues.debug();