API de JavaScript

La siguiente sección documenta los comandos que pueden usarse con la función global PrivacyID() creada por el fragmento de código de incrustación.

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

Puedes invocar los comandos de PrivacyID en cualquier parte de tu página, siempre y cuando tus comandos aparezcan debajo del fragmento de código de incrustación global.

Comandos

• endpoint
• consentCategories
• requireConsent
• userId
• getIdentity

endpoint

Especifica la URL al API Endpoint que implementaste en tu servidor web para identificar al usuario.

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

Argumento	Tipo	Ejemplo	Descripción
<endpoint>	cadena	“/api/privacyId”	La ruta o URL al API endpoint en tu servidor web para identificar al usuario.

INFO

El comando getIdentity retrasará la ejecución hasta que se proporcione un valor para esta propiedad.

Ejemplo

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

consentCategories

Especifica las categorías de scripts a las que el usuario ha permitido acceder a su ID de usuario.

Cada script que definas en el portal de PrivacyID puede tener una o más categorías de consentimiento asociadas. El comando getIdentity solo proporcionará IDs de usuario a los scripts si el usuario ha permitido todas las categorías de script.

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

Argumento	Tipo	Ejemplo	Descripción
[<categories>]	Matriz<cadena>	[“functional”, “analytics”]	Una matriz de nombres de categorías de cadena que han sido permitidas por el usuario. Este valor podría provenir de tu sistema o de un servicio de consentimiento de cookies de terceros que hayas integrado en tu sitio web.

INFO

Por defecto, PrivacyID retrasará la ejecución del comando getIdentity hasta que se proporcionen las categorías de consentimiento. Si tu sitio web no utiliza categorías de consentimiento, puedes establecer la propiedad requireConsent en false para evitar este retraso.

Ejemplo

// Ejemplo de integración con un servicio de terceros Cookie Script.
CookieScript.instance.onAccept = function () {
  var state = CookieScript.instance.currentState();
  PrivacyID('consentCategories', state.categories);
};

requireConsent

Especifica si PrivacyID debe esperar a que se definan las categorías de consentimiento antes de proporcionar IDs de usuario a los scripts. Por defecto es true.

PrivacyID('requireConsent', <value>);

Argumento	Tipo	Ejemplo	Descripción
<value>	booleano	false	Especifica false para deshabilitar las categorías de consentimiento y

Ejemplo

PrivacyID('requireConsent', false);

userId

Asocia un ID persistente con el usuario para ayudar a PrivacyID a identificarlo en futuras visitas en caso de que se pierda la cookie del usuario.

Esta propiedad solo debe especificarse cuando puedas garantizar que el valor que proporciones será consistente de forma única para el usuario. Por ejemplo, un buen valor a usar podría ser una dirección de correo electrónico o un ID de cliente único de un usuario que ha iniciado sesión. El valor proporcionado se codificará con hash antes de usarse para asegurar que no se transmita o almacene PII (información de identificación personal) fuera de tus servidores.

PrivacyID('userId', <userId>);

Argumento	Tipo	Ejemplo	Descripción
<userId>	cadena	1234-5678-9101	Un valor persistente único para asociar con el usuario. Por ejemplo, un ID de cliente único de un usuario que ha iniciado sesión.

INFO

Solo debes especificar un valor para la propiedad userId si puedes asegurar que es único para el usuario. Si se proporciona el mismo valor a diferentes usuarios por error, PrivacyID comenzará a proporcionar las mismas identidades de usuario a múltiples usuarios, lo que llevará a una identificación errónea, afectando a cualquier script que dependa de PrivacyID.

Ejemplo

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

getIdentity

Devuelve IDs de usuario únicos y consistentes para cada script integrado en tu sitio web.

Este comando debe usarse para cada script integrado en tu sitio web que necesite identificar al usuario de forma única. La función de callback que proporciones se invocará una vez que el usuario sea identificado y un ID de usuario estará disponible si el script está actualmente habilitado dentro del portal de PrivacyID y el usuario ha dado su consentimiento a todas las categorías requeridas por el script.

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

Argumento	Tipo	Ejemplo	Descripción
<scriptKey>	cadena	6ee2aa22-8ea8-4ad0-9353-5a714151ebf6	El identificador único que representa tu script. Esto está disponible en el portal de PrivacyID.
<callback>	Función	(userId) => console.log(userId)	Una función de callback que se invocará con la identidad del usuario. El ID de usuario proporcionado será una cadena o undefined si el script no está autorizado a acceder al ID de usuario.

INFO

Las respuestas a este comando se pondrán en cola hasta que se hayan proporcionado las propiedades endpoint y consentCategories.

Ejemplo

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

Ejemplo con Google Analytics

<!-- Etiqueta global del sitio (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>