@fingerprint/gtm-adapter
v2.0.0-test.1
Published
Fingerprint JS agent adapter for Google Tag Manager
Downloads
51
Readme
Fingerprint Google Tag Manager template
This repository contains a Google Tag Manager template you can use to add Fingerprint to your website.
For step-by-step instructions on using this integration, see the full Google Tag Manager guide in the Fingerprint documentation.
Usage
- Sign up for a Fingerprint account if you haven't already.
- Import this
template.tplfrom latest release into your Google Tag Manager workspace. - Add a Fingerprint tag to your website. You will need your public API key and workspace region.
- Use the
FingerprintResultor your own Custom result name to access the Fingerprint result in GTM'sdataLayer. - Use the
Fingerprint.startedandFingerprint.identifiedevent names to create custom events and trigger actions after the JS agent is loaded or the visitor is identified.
Template Fields
For more information and the full API reference, see Fingerprint JS Agent in our documentation.
Tag type – The way you want to use the tag. There are 3 options:
Start and identify– the default behavior. Start the JS agent and identify the browser immediately. If you want to start the JS agent first and identify the browser later based on some event, use two separateStartandIdentifyFingerprint tags.Start– only load the JS Agent.Identify– identify the browser. The JS Agent must be started before. You can collect additional metadata data first and then trigger this tag with the metadata insidelinkedIdortag.
Public API key - Your public API key that authenticates the agent with the Fingerprint API.
Region - The region of your subscription.
endpoints - This parameter should only be used with the custom subdomain or proxy integrations. Specify the API endpoint URL for those integrations in this field.
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
Result custom name - you can specify the result field name in dataLayer.
Limitations
Some advanced JavaScript agent properties (storageKeyPrefix and cache) 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.
Support and Feedback
To report problems, ask questions, or provide feedback, please use Issues. If you need private support, you can email us at [email protected].
License
This project is licensed under the Apache 2.0 license.
