Show Menu
TÓPICOS×

(Beta) Configurando o SDK

O SDK da Web da plataforma Adobe Experience está atualmente em beta e não está disponível para todos os usuários. A documentação e a funcionalidade estão sujeitas a alterações.
A configuração do SDK é feita com o configure comando.
alloy("configure", {
  "configId": "ebebf826-a01f-4458-8cec-ef61de241c93",
  "orgId":"ADB3LETTERSANDNUMBERS@AdobeOrg"
});

Há muitas opções que podem ser definidas durante a configuração. Todas as opções podem ser encontradas abaixo, agrupadas por categoria.

Opções gerais

configId

Tipo
Obrigatório
Valor padrão
String
Sim
none
Sua ID de configuração atribuída, que vincula o SDK às contas e configuração apropriadas. Ao configurar várias instâncias em uma única página, você deve configurar uma diferente configId para cada instância.

context

Tipo
Obrigatório
Valor padrão
Matriz de sequências de caracteres
Não
["web", "device", "environment", "placeContext"]
Indica quais categorias de contexto devem ser coletadas automaticamente, conforme descrito em Informações (Beta) Informações coletadas automaticamente Automáticas. Se essa configuração não for especificada, todas as categorias serão usadas por padrão.

debugEnabled

Tipo
Obrigatório
Valor padrão
Booleano
Não
false
Indica se a depuração deve ser ativada. Configurar essa configuração para true ativar os seguintes recursos:
| Recurso | | | | ---------------------- | ------------------ | | Validação síncrona | Valida os dados que estão sendo coletados em relação ao esquema e retorna um erro na resposta sob o seguinte rótulo: collect:error OR success | | Registro do console | Permite que mensagens de depuração sejam exibidas no console JavaScript do navegador |

edgeDomain

Tipo
Obrigatório
Valor padrão
String
Não
beta.adobedc.net
O domínio usado para interagir com os serviços da Adobe. Isso só será usado se você tiver um domínio próprio (CNAME) que faça proxy das solicitações para a infraestrutura de borda da Adobe.

errorsEnabled

Tipo
Obrigatório
Valor padrão
Booleano
Não
true
Indica se os erros devem ser suprimidos. Conforme descrito em Executando comandos , erros não capturados são registrados no console do desenvolvedor, independentemente de a depuração estar ativada no SDK da Web da Adobe Experience Platform. Ao configurar errorsEnabled como false , as promessas retornadas pelo SDK da Web da plataforma Adobe Experience nunca serão rejeitadas, embora erros ainda sejam registrados no console se o registro estiver ativado no SDK da Web da plataforma Adobe Experience.

orgId

Tipo
Obrigatório
Valor padrão
String
Sim
none
Sua ID de empresa atribuída à Experience Cloud. Ao configurar várias instâncias em uma página, você deve configurar uma diferente orgId para cada instância.

Coleta de dados

clickCollectionEnabled

Tipo
Obrigatório
Valor padrão
Booleano
Não
true
Indica se os dados associados aos cliques em links devem ser coletados automaticamente. Para cliques que se qualificam como cliques em links, os seguintes dados de interação da Web são coletados:
Propriedade
Nome do link
Nome determinado pelo contexto do link
URL de link
URL normalizado
Tipo de link
Definir para baixar, sair ou outras

onBeforeEventSend

Tipo
Obrigatório
Valor padrão
Função
Não
() => não definido
Configure isso para configurar um retorno de chamada chamado para cada evento antes de ele ser enviado. Um objeto com o campo xdm é enviado para o retorno de chamada. Modifique o objeto xdm para alterar o que é enviado. Dentro do retorno de chamada, os dados do xdm objeto já serão transmitidos no comando event e as informações coletadas automaticamente. Para obter mais informações sobre o tempo desse retorno de chamada e um exemplo, consulte Modificando eventos globalmente .

Opções de privacidade

defaultConsent

Tipo
Obrigatório
Valor padrão
Objeto
Não
{"general": "in"}
Define o consentimento padrão do usuário. Isso é usado quando não há preferência de consentimento já salva para o usuário. O outro valor válido é {"general": "pending"} . Quando definido, o trabalho será enfileirado até que o usuário forneça as preferências de consentimento. Depois que as preferências do usuário forem fornecidas, o trabalho continuará ou será abortado com base nas preferências do usuário. Consulte Suporte ao consentimento para obter mais informações.

Opções de personalização

prehidingStyle

Tipo
Obrigatório
Valor padrão
String
Não
none
Usado para criar uma definição de estilo CSS que oculta áreas de conteúdo da sua página da Web enquanto o conteúdo personalizado é carregado do servidor. Se essa opção não for fornecida, o SDK não tentará ocultar nenhuma área de conteúdo enquanto o conteúdo personalizado for carregado, resultando em "oscilação".
Por exemplo, se você tivesse um elemento em sua página da Web com uma ID cujo conteúdo padrão você gostaria de ocultar enquanto o conteúdo personalizado estiver sendo carregado do servidor, um exemplo de estilo de pré-ocultação seria o seguinte: container
  prehidingStyle: "#container { opacity: 0 !important }"

Opções de público-alvo

cookieDestinationsEnabled

Tipo
Obrigatório
Valor padrão
Booleano
Não
true
Permite destinos de cookies, o que permite a configuração de cookies com base na qualificação de segmentos.

urlDestinationsEnabled

Tipo
Obrigatório
Valor padrão
Booleano
Não
true
Permite destinos de URL, o que permite acionar URLs com base na qualificação de segmentos.

Opções de identidade

idSyncContainerId

Tipo
Obrigatório
Valor padrão
Número
Não
none
A ID do contêiner que especifica quais sincronizações de ID são acionadas. Este é um número inteiro não negativo que pode ser obtido do seu consultor.

idSyncEnabled

Tipo
Obrigatório
Valor padrão
Booleano
Não
true
Habilita o recurso de sincronização de ID, que permite acionar URLs para sincronizar a ID de usuário exclusiva da Adobe com a ID de usuário exclusiva de uma fonte de dados de terceiros.

thirdPartyCookiesEnabled

Tipo
Obrigatório
Valor padrão
Booleano
Não
true
Ativa a configuração de cookies de terceiros da Adobe. O SDK tem a capacidade de persistir a ID de visitante em um contexto de terceiros para permitir que a mesma ID de visitante seja usada em todo o site. Isso é útil se você tem vários sites ou deseja compartilhar dados com parceiros; no entanto, às vezes isso não é desejado por motivos de privacidade.