[Alpha]{class="badge informative"}

Configuración de SDK del servidor

En esta página se describe cómo configurar Server SDK. Para Web SDK, consulte Configuración de Web SDK.

Configura Server SDK con el método configure. Llámelo una vez en cada instancia, cuando se inicie el servidor y antes de llamar a forRequest o a cualquier otro método. Cada identificador de forRequest utiliza la configuración de la instancia que lo creó.

Se requieren las propiedades datastreamId, orgId y edgeCredentials. Todas las demás propiedades son opcionales. El ejemplo siguiente muestra un objeto de configuración que utiliza todas las propiedades disponibles:

import { createInstance } from "@adobe/alloy-node";

const alloy = createInstance();

await alloy.configure({
  datastreamId: "ebebf826-a01f-4458-8cec-ef61de241c93",
  orgId: "ADB3LETTERSANDNUMBERS@AdobeOrg",
  edgeCredentials: {
    clientId: process.env.ADOBE_CLIENT_ID,
    clientSecret: process.env.ADOBE_CLIENT_SECRET,
    scopes: process.env.ADOBE_SCOPES.split(",")
  },
  debugEnabled: false,
  defaultConsent: "in",
  edgeBasePath: "ee",
  edgeConfigOverrides: {
    com_adobe_target: {
      propertyToken: "01dbc634-07c1-d8f9-ca69-b489a5ac5e94"
    }
  },
  edgeDomain: "data.example.com",
  idMigrationEnabled: false,
  onBeforeEventSend: (content) => {
    content.xdm.application ??= {};
    content.xdm.application.name = "Example storefront";
  },
  thirdPartyCookiesEnabled: false
});

Propiedades de configuración properties

Propiedad
Tipo
Requerido
Predeterminado
datastreamId
Cadena
Sí
Ninguna
orgId
Cadena
Sí
Ninguna
edgeCredentials
Objeto
Sí
Ninguna
debugEnabled
Booleano
No
false
defaultConsent
Cadena
No
"in"
edgeBasePath
Cadena
No
"ee"
edgeConfigOverrides
Objeto
No
Ninguna
edgeDomain
Cadena
No
"edge.adobedc.net"
idMigrationEnabled
Booleano
No
true
onBeforeEventSend
Función
No
Ninguna
thirdPartyCookiesEnabled
Booleano
No
true

La propiedad defaultConsent solo está disponible cuando la instancia incluye el componente Consentimiento, que createInstance incluye de forma predeterminada. Ver Crear una instancia personalizada.

Opciones no compatibles con Server SDK unsupported

Web SDK tiene opciones de configuración para funciones que dependen de un explorador, como la recopilación de clics en vínculos, el procesamiento de contenido personalizado y las notificaciones push. Server SDK no acepta estas opciones. Si incluye una, configure rechazará con un error Unknown field que asigna un nombre a la opción.

Las siguientes opciones de Web SDK no están disponibles: autoCollectPropositionInteractions, clickCollection, clickCollectionEnabled, context, conversation, downloadLinkQualifier, onBeforeLinkClickSend, personalizationStorageEnabled, prehidingStyle, pushNotifications, streamingMedia y targetMigrationEnabled.

Resultado y errores result

El método configure devuelve una promesa que se resuelve con un objeto vacío cuando la configuración se realiza correctamente. Rechaza en los siguientes casos:

  • edgeCredentials falta o falta una de sus propiedades requeridas.
  • defaultConsent se ha establecido en "pending". Ver defaultConsent.
  • Una propiedad tiene un valor no válido o no se reconoce.
  • configure ya se llamó correctamente en la misma instancia. Cada instancia se puede configurar solo una vez.

Si configure rechaza, la instancia permanece sin configurar y forRequest genera un error hasta que se realice correctamente una llamada a configure.

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