[Alpha]{class="badge informative"}

Información general sobre métodos

Server SDK proporciona sus características como métodos en el objeto que devuelve createInstance. Si ha utilizado Web SDK, estos métodos corresponden a comandos de Web SDK, pero los llama de forma diferente:

Web SDK (explorador)
SDK de servidor
alloy("sendEvent", { xdm })
alloy.sendEvent({ xdm })
alloy("getIdentity")
alloy.getIdentity()

Web SDK utiliza una única función que toma el nombre del comando como una cadena, de modo que una página puede poner en cola comandos antes de que la biblioteca termine de cargarse. Un servidor carga la biblioteca antes de administrar cualquier solicitud, por lo que SDK del servidor utiliza métodos regulares en su lugar, que el editor puede sugerir y comprobar a medida que escribe.

Métodos disponibles methods

Método
Descripción
Instancia de nivel superior
forRequest identificador
configure
Establece la secuencia de datos, la organización, las credenciales y otras opciones. Llámelo una vez cuando se inicie el servidor.
Sí
No
forRequest
Devuelve un identificador con ámbito para la solicitud de un visitante.
Sí
No
sendEvent
Envía un evento a Edge Network y devuelve los resultados, como propuestas de personalización.
Sí
Sí
getIdentity
Devuelve el ECID del visitante sin enviar un evento.
Sí
Sí
appendIdentityToUrl
Agrega la identidad del visitante a una dirección URL para que otro dominio pueda reconocerlo.
Sí
Sí
setConsent
Registra las preferencias de consentimiento del visitante.
Sí
Sí
applyResponse
Procesa una respuesta de Edge Network que ha obtenido de otra manera.
Sí
Sí
getLibraryInfo
Devuelve la versión de la biblioteca y su configuración actual.
Sí
Sí
setDebug
Activa o desactiva el registro de depuración.
Sí
Sí

Para el tráfico de visitantes, llame a los métodos en un identificador forRequest en lugar de en la instancia de nivel superior. Ver Instancias y solicitudes.

Gestión de resultados results

Todos los métodos excepto forRequest devuelven una promesa. La promesa se resuelve con un objeto result cuando el método tiene éxito y se rechaza con un Error cuando falla. Use await con try...catch o use then y catch:

try {
  const result = await visitor.sendEvent({
    xdm: {
      eventType: "web.webpagedetails.pageViews",
      identityMap: {
        Email: [{ id: "visitor@example.com", primary: true }]
      }
    }
  });
  console.log("Propositions", result.propositions);
} catch (error) {
  console.error("sendEvent failed", error.message);
}

El contenido del objeto result depende del método. La página de cada método describe su objeto de resultado. Algunos métodos, como setConsent, se resuelven con un objeto vacío.

El resultado también depende del consentimiento del visitante. Si el visitante se ha excluido, los métodos como sendEvent se resuelven con un objeto vacío sin enviar nada a Adobe.

Errores errors

Un método rechaza en los siguientes casos, entre otros:

  • Opciones no válidas: SDK valida todas las opciones antes de enviar nada. Una opción desconocida o mal escrita, o un valor de tipo incorrecto, rechaza con un mensaje que indica el nombre del problema, como 'bogus': Unknown field.
  • Errores de autenticación: Si SDK no puede obtener un token de acceso, el método lo rechaza con un mensaje que incluye Failed to acquire an IMS access token. Ver Autenticación.
  • Errores de Edge Network: si Edge Network rechaza la solicitud (por ejemplo, porque el evento no tiene identidad principal), el método la rechazará y devolverá el error Edge Network.
  • Errores de red: Si el servidor no puede conectar con Adobe, el método rechazará con el error de red subyacente.

forRequest no arroja ninguna promesa. Devuelve un identificador de inmediato o genera un error si configure aún no se ha resuelto.

Según el tiempo de ejecución y la configuración, un rechazo de promesa no controlado puede detener el proceso del servidor o dar error a la solicitud. Gestione siempre los rechazos de los métodos de SDK para que un problema al enviar datos a Adobe no interrumpa la respuesta que el servidor envía al visitante.

recommendation-more-help
experience-platform-help-collection