[Alpha]{class="badge informative"}

Configurar o SDK do servidor

Esta página descreve como configurar o SDK do Servidor. Para o Web SDK, consulte Configurar o Web SDK.

Você configura o Server SDK com o método configure. Chame-o uma vez em cada instância, quando o servidor for iniciado e antes de chamar forRequest ou qualquer outro método. Cada identificador forRequest usa a configuração da instância que o criou.

As propriedades datastreamId, orgId e edgeCredentials são obrigatórias. Todas as outras propriedades são opcionais. O exemplo a seguir mostra um objeto de configuração que usa cada propriedade disponível:

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
});

Propriedades de configuração properties

A propriedade defaultConsent está disponível somente quando a instância inclui o componente Consentimento, que createInstance inclui por padrão. Consulte Criar uma instância personalizada.

Opções não suportadas pelo SDK do servidor unsupported

O Web SDK tem opções de configuração para recursos que dependem de um navegador, como coleção de cliques em links, renderização de conteúdo personalizado e notificações por push. O SDK do servidor não aceita essas opções. Se você incluir uma, configure será rejeitado com um erro Unknown field que nomeia a opção.

As seguintes opções do Web SDK não estão disponíveis: autoCollectPropositionInteractions, clickCollection, clickCollectionEnabled, context, conversation, downloadLinkQualifier, onBeforeLinkClickSend, personalizationStorageEnabled, prehidingStyle, pushNotifications, streamingMedia e targetMigrationEnabled.

Resultado e erros result

O método configure retorna uma promessa que resolve com um objeto vazio quando a configuração é bem-sucedida. É rejeitada nos seguintes casos:

Se configure for rejeitado, a instância permanecerá não configurada e forRequest emitirá um erro até que uma chamada para configure seja bem-sucedida.