Documentação Experience Platform Guia do Serviço de privacidade

Visão geral da biblioteca JavaScript de privacidade do Adobe

16 de julho de 2024

Tópicos:

Criado para:

Usuário
Administrador

Como processador de dados, a Adobe processa dados pessoais de acordo com a permissão e as instruções de sua empresa. Como o controlador de dados, você determinará os dados pessoais que o Adobe processa e armazena em seu nome. Dependendo das informações que você escolher enviar por meio das soluções da Adobe Experience Cloud, o Adobe pode armazenar informações privadas aplicáveis a regulamentos de privacidade, como o General Data Protection Regulation (GDPR) e o California Consumer Privacy Act (CCPA). Consulte o documento sobre privacidade no Adobe Experience Cloud para obter mais informações sobre como as soluções de Experience Cloud coletam dados privados.

A Biblioteca JavaScript de Privacidade de Adobe permite que controladores de dados automatizem a recuperação de todas as identidades de titulares de dados geradas pelas soluções Experience Cloud para um domínio específico. Usando a API fornecida pelo Adobe Experience Platform Privacy Service, essas identidades podem ser usadas para criar solicitações de acesso e exclusão para dados privados pertencentes a esses titulares.

NOTE

O Privacy JS Library geralmente só precisa ser instalado em páginas relacionadas à privacidade e não precisa ser instalado em todas as páginas de um site ou domínio.

Funções

O Privacy JS Library fornece várias funções para gerenciar identidades em Privacy Service. Essas funções só podem ser usadas para gerenciar as identidades armazenadas no navegador para um visitante específico. Eles não podem ser usados para enviar informações para o Experience Cloud Central Service diretamente.

A tabela a seguir descreve as diferentes funções fornecidas pela biblioteca:

Função

Descrição

retrieveIdentities

Retorna uma matriz de identidades correspondentes (validIds) que foram recuperadas de Privacy Service, bem como uma matriz de identidades que não foram encontradas (failedIds).

removeIdentities

Remove cada identidade correspondente (válida) do navegador. Retorna uma matriz de identidades correspondentes (validIds), com cada identidade contendo um booleano isDeletedClientSide que indica se essa ID foi excluída.

retrieveThenRemoveIdentities

Recupera uma matriz de identidades correspondentes (validIds) e remove essas identidades do navegador. Embora essa função seja semelhante a removeIdentities, ela é melhor usada quando a solução Adobe que você está usando requer uma solicitação de acesso antes que a exclusão seja possível (como quando um identificador exclusivo deve ser recuperado antes de fornecê-lo em uma solicitação de exclusão).

NOTE

removeIdentities e retrieveThenRemoveIdentities removem somente identidades do navegador para soluções de Adobe específicas que as suportem. Por exemplo, o Adobe Audience Manager não exclui as IDs demdex armazenadas em cookies de terceiros, enquanto o Adobe Target exclui todos os cookies que armazenam suas IDs.

Como todas as três funções representam processos assíncronos, qualquer identidade recuperada deve ser tratada usando retornos de chamada ou promessas.

Instalação

Para começar a usar o Privacy JS Library, você deve instalá-lo em seu computador usando um dos seguintes métodos:

Instale usando npm executando o seguinte comando: npm install @adobe/adobe-privacy
Baixar do repositório GitHub de Experience Cloud

Também é possível instalar a biblioteca por meio de uma extensão de tag. Consulte a visão geral na extensão de tag de privacidade de Adobe para obter mais informações.

Instanciar o Privacy JS Library

Todos os aplicativos que utilizam o Privacy JS Library devem instanciar um novo objeto AdobePrivacy, que deve ser configurado para uma solução de Adobe específica. Por exemplo, uma instanciação do Adobe Analytics seria semelhante ao seguinte:

var adobePrivacy = new AdobePrivacy({
    imsOrgID: "{ORG_ID}",
    reportSuite: "{REPORT_SUITE_ID}",
    trackingServer: "{SERVER_URL}",
    clientCode: "{TARGET_CLIENT_CODE}"
});

Para obter uma lista completa de parâmetros compatíveis para diferentes soluções de Adobe, consulte a seção do apêndice sobre os parâmetros de configuração de solução de Adobe compatíveis.

Amostras de código

Os exemplos de código a seguir demonstram como usar o Privacy JS Library para vários cenários comuns, desde que você não esteja usando tags.

Recuperar identidades

Este exemplo demonstra como recuperar uma lista de identidades de Experience Cloud.

JavaScript

O código a seguir define uma função, handleRetrievedIDs, a ser usada como um retorno de chamada ou promessa para manipular as identidades recuperadas por retrieveIdentities.

function handleRetrievedIDs(ids) {
    const validIDs = ids.validIDs;
    const failedIDs = ids.failedIDs;
}

// If using callbacks:
adobePrivacy.retrieveIdentities(handleRetrievedIDs);

// If using promises:
adobePrivacy.retrieveIdentities().then(handleRetrievedIDs);

Variable

Descrição

validIds

Um objeto JSON que contém todas as IDs recuperadas com sucesso.

failedIDs

Um objeto JSON contendo todas as IDs que não foram recuperadas de Privacy Service ou que não foram encontradas.

Resultado

Se o código for executado com êxito, validIDs será preenchido com uma lista de identidades recuperadas.

{
    "company": "adobe",
    "namespace": "ECID",
    "namespaceId": 4,
    "type": "standard",
    "name": "Experience Cloud ID",
    "description": "This is the ID generated by the ID Service.",
    "value": "79352169365966186342525781172209986543"
},
{
    "company": "adobe",
    "namespace": "gsurfer_id",
    "namespaceId": 411,
    "type": "standard",
    "value": "WqmIJQAAB669Ciao"
}

Remover identidades

Este exemplo demonstra como remover uma lista de identidades do navegador.

JavaScript

O código a seguir define uma função, handleRemovedIDs, a ser usada como retorno de chamada ou promessa para manipular as identidades recuperadas por removeIdentities após elas serem removidas do navegador.

function handleRemovedIDs(ids) {
    const validIDs = ids.validIDs;
    const failedIDs = ids.failedIDs;
}

// If using callbacks:
adobePrivacy.removeIdentities(handleRemovedIDs);

// If using promises:
adobePrivacy.removeIdentities().then(handleRemovedIDs)…

Variable

Descrição

validIds

Um objeto JSON que contém todas as IDs recuperadas com sucesso.

failedIDs

Um objeto JSON contendo todas as IDs que não foram recuperadas de Privacy Service ou que não foram encontradas.

Resultado

Se o código for executado com êxito, validIDs será preenchido com uma lista de identidades recuperadas.

{
    "company": "adobe",
    "namespace": "ECID",
    "namespaceId": 4,
    "type": "standard",
    "name": "Experience Cloud ID",
    "description": "This is the ID generated by the ID Service.",
    "value": "79352169365966186342525781172209986543",
    "isDeletedClientSide": false
},
{
    "company": "adobe",
    "namespace": "AMO",
    "namespaceId": 411,
    "type": "standard",
    "value": "WqmIJQAAB669Ciao",
    "isDeletedClientSide": true
}

Próximas etapas

Ao ler este documento, você foi apresentado às funcionalidades principais do Privacy JS Library. Depois de usar a biblioteca para recuperar uma lista de identidades, você pode usar essas identidades para criar acesso aos dados e excluir solicitações para a API Privacy Service. Consulte o guia da API de Privacy Service para obter mais informações.

Apêndice

Esta seção contém informações complementares para usar o Privacy JS Library.

Parâmetros de configuração da solução Adobe

Esta é uma lista dos parâmetros de configuração aceitos para soluções de Adobe compatíveis, usada ao instanciar um objeto AdobePrivacy.

Todas as soluções

Parâmetro

Descrição

key

Uma ID exclusiva que identifica o usuário ou titular dos dados. Esta propriedade deve ser usada para fins de rastreamento interno e não é usada pelo Adobe.

Adobe Analytics

Parâmetro

Descrição

cookieDomainPeriods

O número de períodos em um domínio usado para rastreamento de cookies (o padrão é 2, ex.: .domain.com). Não o defina aqui, a menos que especificado no seu Web beacon do JavaScript.

dataCenter

O data center de coleta de dados do Adobe. Isso só deve ser incluído se estiver especificado no seu web beacon do JavaScript. Os valores em potencial são:

d1: data center de San Jose
d2: data center de Dallas

reportSuite

A ID do conjunto de relatórios conforme especificada no seu Web beacon do JavaScript (por exemplo, s_code.js ou dtm).

trackingServer

Um domínio de coleção de dados não SSL. Isso só deve ser incluído se estiver especificado no seu web beacon do JavaScript.

trackingServerSecure

Um domínio de coleção de dados SSL. Isso só deve ser incluído se estiver especificado no seu web beacon do JavaScript.

visitorNamespace

O namespace usado para agrupar visitantes. Isso só deve ser incluído se estiver especificado no seu web beacon do JavaScript.

Adobe Audience Manager

Parâmetro

Descrição

aamUUIDCookieName

Nome do cookie primário que contém a ID de usuário exclusiva retornada do Adobe Audience Manager.

Adobe Experience Cloud Identity Service (ECID)

Parâmetro

Descrição

imsOrgID

Sua ID da organização.

Adobe Target

Parâmetro

Descrição

clientCode

Código do cliente que identifica um cliente no Adobe Target System.

recommendation-more-help