Tipos de condición para extensiones web

NOTA

Adobe Experience Platform Launch se ha convertido en un conjunto de tecnologías de recopilación de datos en Adobe Experience Platform. Como resultado, se han implementado varios cambios terminológicos en la documentación del producto. Consulte el siguiente documento para obtener una referencia consolidada de los cambios terminológicos.

En el contexto de una regla, se evalúa una condición después de que se haya producido un evento. Todas las condiciones deben devolver el valor verdadero para que la regla pueda continuar el procesamiento. La excepción es cuando los usuarios colocan explícitamente condiciones en un bloque de "excepción", en cuyo caso todas las condiciones dentro del bloque deben devolver false para que la regla siga procesándose.

Por ejemplo, una extensión podría proporcionar un tipo de condición "la ventanilla contiene" en la que el usuario de podría especificar un selector CSS. Cuando la condición se evalúa en el sitio web del cliente, la extensión puede encontrar elementos que coincidan con el selector de CSS y devolver si alguno de ellos se incluye en la ventanilla del usuario.

Este documento explica cómo definir tipos de condiciones para una extensión web en Adobe Experience Platform.

NOTA

Si va a desarrollar una extensión de Edge, consulte la guía sobre tipos de condición para extensiones de Edge en su lugar.

Este documento supone que está familiarizado con los módulos de biblioteca y cómo se integran en las extensiones web. Si necesita una introducción, consulte la información general sobre el formato del módulo de biblioteca antes de volver a esta guía.

Los tipos de condición suelen consistir en lo siguiente:

  1. Se muestra una vista en la interfaz de usuario de la recopilación de datos que permite a los usuarios modificar la configuración de la condición.
  2. Módulo de biblioteca emitido en la biblioteca de tiempo de ejecución de etiquetas para interpretar la configuración y evaluar una condición.

Un módulo de biblioteca de tipo de condición tiene un objetivo: evalúe si algo es verdadero o falso. Lo que evalúan depende de usted.

Por ejemplo, si desea evaluar si el usuario está en el host example.com, el módulo puede tener un aspecto similar al siguiente:

module.exports = function(settings) {
  return document.location.hostname === 'example.com';
};

Piense ahora en una situación en la que desee que el usuario de Adobe Experience Platform pueda configurar el nombre del host. Puede permitir que el usuario introduzca un nombre de host y, a continuación, guardar el nombre de host en el objeto de configuración. El objeto podría tener este aspecto:

{
  "hostname": "example.com"
}

Para poder modificar el nombre de host definido por el usuario, el módulo deberá cambiar a lo siguiente:

module.exports = function(settings) {
  return document.location.hostname === settings.hostname;
};

Datos de evento contextual

Se pasa un segundo argumento al módulo que contiene información contextual sobre el evento que activó la regla. Esto puede ser beneficioso en algunos casos y se puede acceder a estos datos de la siguiente manera:

module.exports = function(settings, event) {
  // event contains information regarding the event that fired the rule
};

El objeto event debe contener las propiedades siguientes:

Propiedad Descripción
$type Cadena que describe el nombre de la extensión y el nombre del evento, unidos mediante un punto. Por ejemplo, youtube.play.
$rule Objeto que contiene información sobre la regla que se está ejecutando. El objeto debe contener las siguientes propiedades secundarias:
  • id: ID de la regla que se está ejecutando.
  • name: nombre de la regla que se está ejecutando.

La extensión que proporciona el tipo de evento que activó la regla puede, de manera opcional, añadir cualquier otra información de utilidad a este objeto event.

En esta página