API JavaScript

La seguente sezione documenta i comandi che possono essere utilizzati con la funzione globale PrivacyID() creata dallo snippet di incorporamento.

PrivacyID(<command>, <command parameters>);

È possibile richiamare i comandi PrivacyID in qualsiasi punto della pagina, a condizione che i comandi appaiano al di sotto dello snippet di incorporamento globale.

Comandi

• endpoint
• consentCategories
• requireConsent
• userId
• getIdentity

endpoint

Specifica l'URL dell'API Endpoint che hai implementato sul tuo server web per identificare l'utente.

PrivacyID('endpoint', '<endpoint>');

Argomento	Tipo	Esempio	Descrizione
<endpoint>	string	“/api/privacyId”	Il percorso o l'URL dell'API endpoint sul tuo server web per identificare l'utente.

INFO

Il comando getIdentity ritarderà l'esecuzione fino a quando non verrà fornito un valore per questa proprietà.

Esempio

PrivacyID('endpoint', '/api/privacyId');

consentCategories

Specifica le categorie di script a cui l'utente ha consentito l'accesso al proprio ID utente.

Ogni script che definisci nel portale PrivacyID può avere una o più categorie di consenso associate. Il comando getIdentity fornirà gli ID utente solo agli script in cui tutte le categorie di script sono state consentite dall'utente.

PrivacyID('consentCategories', [<categories>]);

Argomento	Tipo	Esempio	Descrizione
[<categories>]	Array<string>	[“functional”, “analytics”]	Un array di nomi di categorie stringa che sono state consentite dall'utente. Questo valore potrebbe provenire dal tuo sistema o da un servizio di consenso sui cookie di terze parti che hai integrato nel tuo sito web.

INFO

Per impostazione predefinita, PrivacyID ritarderà l'esecuzione del comando getIdentity finché non verranno fornite le categorie di consenso. Se il tuo sito web non utilizza le categorie di consenso, puoi impostare la proprietà requireConsent su false per evitare questo ritardo.

Esempio

// Esempio di integrazione con un servizio Cookie Script di terze parti.
CookieScript.instance.onAccept = function () {
  var state = CookieScript.instance.currentState();
  PrivacyID('consentCategories', state.categories);
};

requireConsent

Specifica se PrivacyID deve attendere che le categorie di consenso siano definite prima di fornire gli ID utente agli script. Il valore predefinito è true.

PrivacyID('requireConsent', <value>);

Argomento	Tipo	Esempio	Descrizione
<value>	boolean	false	Specifica false per disabilitare le categorie di consenso e

Esempio

PrivacyID('requireConsent', false);

userId

Associa un ID persistente all'utente per aiutare PrivacyID a identificarlo nelle visite future nel caso in cui il cookie utente venga perso.

Questa proprietà dovrebbe essere specificata solo quando puoi garantire che il valore che passi sarà univocamente coerente con l'utente. Ad esempio, un buon valore da utilizzare potrebbe essere un indirizzo email o un ID cliente univoco di un utente loggato. Il valore fornito verrà hashato prima di essere utilizzato per garantire che nessuna PII (informazione di identificazione personale) venga trasmessa o memorizzata al di fuori dei tuoi server.

PrivacyID('userId', <userId>);

Argomento	Tipo	Esempio	Descrizione
<userId>	string	1234-5678-9101	Un valore persistente unico da associare all'utente. Es. un ID cliente unico di un utente loggato.

INFO

Dovresti specificare un valore per la proprietà userId solo se puoi assicurarti che sia univoco per l'utente. Se lo stesso valore viene fornito accidentalmente a utenti diversi, PrivacyID inizierà a fornire le stesse identità utente a più utenti, il che porterà a un'errata identificazione, influenzando qualsiasi script che si basa su PrivacyID.

Esempio

PrivacyID('userId', '1234-5678-9101');

getIdentity

Restituisce ID utente univoci e coerenti per ogni script integrato sul tuo sito web.

Questo comando dovrebbe essere utilizzato per ogni script integrato nel tuo sito web che necessita di identificare in modo univoco l'utente. La funzione di callback che fornisci verrà invocata una volta identificato l'utente e un ID utente sarà disponibile se lo script è attualmente abilitato all'interno del portale PrivacyID e l'utente ha acconsentito a tutte le categorie richieste dallo script.

PrivacyID('getIdentity', '<scriptKey>', <callback>);

Argomento	Tipo	Esempio	Descrizione
<scriptKey>	string	6ee2aa22-8ea8-4ad0-9353-5a714151ebf6	L'identificatore unico che rappresenta il tuo script. Questo è disponibile nel portale PrivacyID.
<callback>	Function	(userId) => console.log(userId)	Una funzione di callback da invocare con l'identità dell'utente. L'ID utente fornito sarà una stringa o undefined se lo script non è autorizzato ad accedere all'ID utente.

INFO

Le risposte a questo comando verranno messe in coda fino a quando non saranno state fornite le proprietà endpoint e consentCategories.

Esempio

PrivacyID(
  'getIdentity',
  '0318b158-5bcc-497a-a526-718b18d1600b',
  function (userId) {
    console.log(userId);
  }
);

Esempio con Google Analytics

<!-- Tag globale del sito (gtag.js) - Google Analytics -->
<script
  async
  src="https://www.googletagmanager.com/gtag/js?id=G-1234567890"
></script>
<script>
  window.dataLayer = window.dataLayer || [];
  function gtag() {
    dataLayer.push(arguments);
  }
  gtag('js', new Date());

  gtag('config', 'G-1234567890');

  PrivacyID(
    'getIdentity',
    '0318b158-5bcc-497a-a526-718b18d1600b',
    function (userId) {
      gtag('config', 'G-XXXXXXXXXX', {
        user_id: userId
      });
    }
  );
</script>