@fingerprintjs/fingerprintjs-pro-gtm

Repository content

1. FingerprintJS Pro Google Tag Manager template
2. FingerprintJS Pro adapter for Google Tag Manager

:warning: Work in progress: This is a beta version of the library

FingerprintJS Pro Google Tag Manager template

You can find an example of using this integration on our website

Usage

1. You should have FingerprintJS account
2. Add FingerprintJS Pro Tag in your GTM admin panel (you can import it from github repo)
3. Set up the public API key and choose the region
4. Use FingerprintJSPro.loaded event to get data from dataLayer. You can create trigger for this event.
5. Use Result custom name field to change the variable name for the result.

Template Fields

You can find more info on the FingerprintJS Pro agent documentation page https://dev.fingerprint.com/docs/js-agent

Public API key - Your public API key that authenticates the agent with the API.

Region - The region of your subscription.

Endpoint - This parameter should only be used with the Custom subdomain. Specify your custom endpoint here.

tag - a customer-provided value or an object that will be saved together with the identification event and will be returned back to you in a webhook message or when you search for the visit in the server API.

linkedId - is a way of linking current identification event with a custom identifier. This will allow you to filter visit information when using the Server API

Extended result - The response object includes a confidence score field representing the probability of accurate identification. The extended response object also includes several fields with useful timestamps related to a visitor. See more information on firstSeenAt/lastSeenAt timestamps here.

Result custom name - you can specify the result field name in dataLayer

FingerprintJS Pro adapter for Google Tag Manager

Since GTM (Google Tag Manager) uses a subset of JavaScript API that doesn't support Promises, we created this adapter for the FingerprintJS Pro JS agent that can be used in a GTM template.

Adapter code hosted on CDN and accessible via the next URL https://opencdn.fpjs.sh/fingerprintjs-pro-gtm/v0/iife.min.js

More information about CDN you can get in CDN repository

Example of usage

In GTM template we can load FingerprintJS Pro this way:

const injectScript = require('injectScript');
const callInWindow = require('callInWindow');
const url = 'https://opencdn.fpjs.sh/fingerprintjs-pro-gtm/v0/iife.min.js';

const onSuccess = () => {
  const onFpJsLoad = (result) => {
    const dataLayerPush = createQueue('dataLayer');
    dataLayerPush({
      event: 'FingerprintJS.loaded',
      visitorId: result.visitorId
    });
    data.gtmOnSuccess();
  };

  callInWindow('FingerprintjsProGTM.load', {apiKey: data.apiKey}, onFpJsLoad);
};

// If the script fails to load, log a message and signal failure
const onFailure = () => {
  data.gtmOnFailure();
};

injectScript(url, onSuccess, onFailure);

Limitations

Some advanced JavaScript agent properties (tlsEndpoint, disableTls, storageKey, and scriptUrlPattern) are not currently supported. If you require to use these features in the GTM, please contact support.

Ad-blocking browser extensions such as AdBlock, uBlock Origin, etc., can block all scripts served by Google Tag Manager, including Fingerprint. If this is a problem for your use case, see Google Tag Manager documentation for Server-side tagging and Custom domain configuration.

Changelog

1.0.0 (2023-04-07)

Chores

• deps:
  • bump json5 from 2.2.0 to 2.2.3 (67fc05a9)
  • bump rollup-plugin-license (27dae632)
  • bump minimist from 1.2.5 to 1.2.6 (7472efba)
• add production environment for publish task (09a15c0a)
• update documentation link (58cfb7ee)

Documentation Changes

• rename the custom subdomain feature name (89038318)
• update Fingerprint logo (d0fa722c)
• replace fingerprintjs.com to fingerprint.com (a7850334)
• remove whitespace (ada10547)
• Split contributing file into 2 products (e5c21832)
• Add CODEOWNERS (d5a05a0b)
• Add contributing rules (e2516fbb)
• fix markdown for headers in readme (9de5a154)
• update readme (35382e8d)
• change license to Apache 2.0 (e8bdac2d)
• update description (44cf8079)
• README: remove GTM Gallery mention (cc08755f)

New Features

• separate load and get logic (188d2e89)