Integrar o SDK da Web da Platform para processar dados de consentimento do cliente

O SDK da Web da Adobe Experience Platform permite recuperar os sinais de consentimento do cliente gerados pelas Plataformas de gerenciamento de consentimento (CMPs) e enviá-los à Adobe Experience Platform sempre que ocorrer um evento de alteração de consentimento.

O SDK não faz interface com nenhum CMP pronto para uso. Cabe a você determinar como integrar o SDK ao seu site, acompanhar as alterações de consentimento no CMP e chamar o comando apropriado. Este documento fornece orientação geral sobre como integrar sua CMP ao SDK da Web da plataforma.

Pré-requisitos prerequisites

Este tutorial presume que você já determinou como gerar dados de consentimento no CMP e criou um conjunto de dados contendo campos de consentimento que estão em conformidade com o padrão Adobe ou com o padrão TCF (Estrutura de transparência e consentimento) 2.0 do IAB. Se você ainda não criou esse conjunto de dados, consulte os seguintes tutoriais antes de retornar a este guia:

Este guia segue o fluxo de trabalho para configurar o SDK usando a extensão de tag na interface do usuário. Se você não quiser usar a extensão e preferir incorporar diretamente a versão independente do SDK ao seu site, consulte os seguintes documentos em vez deste guia:

As etapas de instalação neste guia exigem um entendimento prático das extensões de tag e como elas são instaladas em aplicativos web. Consulte a seguinte documentação para obter mais informações:

Configurar um fluxo de dados

Para que o SDK envie dados para o Experience Platform, primeiro você deve configurar um fluxo de dados. Na interface da Coleção de dados ou na interface do Experience Platform, selecione Datastreams na navegação à esquerda.

Depois de criar uma nova sequência de dados ou selecionar uma existente para editar, selecione o botão de alternância ao lado de Adobe Experience Platform. Em seguida, use os valores listados abaixo para preencher o formulário.

Quando terminar, selecione Salvar na parte inferior da tela e continue seguindo os avisos adicionais para concluir a configuração.

Instalar e configurar o SDK da Web da plataforma

Depois de criar um fluxo de dados conforme descrito na seção anterior, você deve configurar a extensão SDK da Web da plataforma que será implantada no site. Se você não tiver a extensão SDK instalada na propriedade da marca, selecione Extensões na navegação à esquerda, seguido da guia Catálogo. Em seguida, selecione Instalar na extensão SDK da plataforma, na lista de extensões disponíveis.

Ao configurar o SDK, em Configurações do Edge, selecione a sequência de dados criada na etapa anterior.

Selecione Salvar para instalar a extensão.

Criar um elemento de dados para definir o consentimento padrão

Com a extensão SDK instalada, você tem a opção de criar um elemento de dados para representar o valor de consentimento da coleta de dados padrão (collect.val) para seus usuários. Isso pode ser útil se você quiser ter valores padrão diferentes dependendo do usuário, como pending para usuários da União Europeia e in para usuários da América do Norte.

Nesse caso de uso, você pode implementar o seguinte para definir o consentimento padrão com base na região do usuário:

Se a região do usuário for determinada por um CMP, você poderá usar as seguintes etapas:

Para criar um elemento de dados na interface, selecione Elementos de Dados na navegação à esquerda e Adicionar Elemento de Dados para navegar até a caixa de diálogo de criação do elemento de dados.

Aqui, você deve criar um elemento de dados Variável JavaScript com base em adobeDefaultConsent. Selecione Salvar ao concluir.

Depois que o elemento de dados é criado, navegue de volta para a página de configuração da extensão SDK da Web. Na seção Privacidade, selecione Fornecido pelo elemento de dados e use a caixa de diálogo fornecida para selecionar o elemento de dados de consentimento padrão criado anteriormente.

Implantar a extensão no site

Após concluir a configuração da extensão, ela poderá ser integrada ao seu site. Consulte o guia de publicação na documentação de tags para obter informações detalhadas sobre como implantar sua build de biblioteca atualizada.

Execução de comandos de alteração de consentimento commands

Depois de integrar a extensão SDK ao seu site, você pode começar a usar o comando setConsent do SDK da Web da plataforma para enviar dados de consentimento à plataforma.

O comando setConsent executa duas ações:

Quando ligar para setConsent

Há dois cenários em que setConsent deve ser chamado no site:

Sintaxe de setConsent

O comando setConsent espera um objeto de carga que contenha uma única propriedade de tipo de matriz: consent. A matriz consent deve conter pelo menos um objeto que forneça os campos de consentimento necessários para o padrão Adobe.

Os campos de consentimento obrigatórios para o padrão Adobe são mostrados na seguinte chamada de exemplo setConsent:

alloy("setConsent", {
  consent: [{
    standard: "Adobe",
    version: "2.0",
    value: {
      collect: {
        val: "y"
      },
      share: {
        val: "y"
      },
      personalize: {
        content: {
          val: "y"
        }
      },
      metadata: {
        time: "YYYY-10-12T15:52:25+00:00"
      }
    }
  }]
});

O JavaScript a seguir fornece um exemplo de uma função que lida com alterações de preferência de consentimento em um site, que pode ser usada como um retorno de chamada em um ouvinte de eventos ou um gancho CMP:

var setConsent = function () {

  // Retrieve the current consent data.
  var categories = getConsentData();

  // If the script is running on a consent change, generate a new timestamp.
  // If the script is running on page load, set the timestamp to when the consent values last changed.
  var now = new Date();
  var collectedAt = consentChanged ? now.toISOString() : categories.collectedAt;

  //  Map the consent values and timestamp to XDM
  var consentXDM = {
    collect: {
      val: categories.collect !== -1 ? "y" : "n"
    },
    personalize: {
      content: {
        val: categories.personalizeContent !== -1 ? "y" : "n"
      }
    },
    share: {
      val: categories.share !== -1 ? "y" : "n"
    },
    metadata: {
      time: collectedAt
    }
  };

  // Pass the XDM object to the Platform Web SDK
  alloy("setConsent", {
    consent: [{
      standard: "Adobe",
      version: "2.0",
      value: consentXDM
    }]
  });
});

Tratamento de respostas do SDK

Todos os comandos Platform SDK retornam promessas que indicam se a chamada teve êxito ou falhou. Em seguida, você pode usar essas respostas para obter lógica adicional, como exibir mensagens de confirmação ao cliente. Consulte Respostas de comando para obter mais informações.

Depois de fazer setConsent chamadas com o SDK com êxito, você pode usar o visualizador de perfil na interface do usuário da plataforma para verificar se os dados estão chegando ao repositório de perfis. Consulte a seção sobre procura de perfis por identidade para obter mais informações.

Próximas etapas

Ao seguir este guia, você configurou a extensão SDK da Web da plataforma para enviar dados de consentimento para o Experience Platform. Para obter orientação sobre como testar a implementação, consulte a documentação do padrão de consentimento que você está implementando: