Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Supporting custom parameters #6

Merged
merged 2 commits into from
Jul 14, 2024
Merged

Supporting custom parameters #6

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
09c7bb6
Supporting custom parameters
q3blend Jul 10, 2024
1c3c4e1
Fixing typo
q3blend Jul 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 119 additions & 1 deletion template.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,109 @@ ___TEMPLATE_PARAMETERS___
"errorMessage": "Incorrect project Id. You can find it in the project Url from the browser. Example: https://clarity.microsoft.com/projects/view/\"projectId\"/"
}
]
},
{
"type": "GROUP",
"name": "advanced",
"displayName": "Custom Options",
"groupStyle": "ZIPPY_CLOSED",
"subParams": [
{
"type": "GROUP",
"name": "custom_id",
"displayName": "Custom Identifiers",
"groupStyle": "NO_ZIPPY",
"subParams": [
{
"type": "TEXT",
"name": "userId",
"displayName": "Custom Id",
"simpleValueType": true,
"help": "Custom id such as an email, can help you view the user journey across browsers and devices",
"valueHint": "user@domain.com"
},
{
"type": "TEXT",
"name": "sessionId",
"displayName": "Session Id",
"simpleValueType": true,
"help": "Custom session id to help you filter for this session later",
"enablingConditions": [
{
"paramName": "userId",
"paramValue": "",
"type": "PRESENT"
}
],
"valueHint": "custom-session-id"
},
{
"type": "TEXT",
"name": "pageId",
"displayName": "Page Id",
"simpleValueType": true,
"help": "Custom page id to help you filter for this page later",
"enablingConditions": [
{
"paramName": "userId",
"paramValue": "",
"type": "PRESENT"
}
],
"valueHint": "custom-page-id"
},
{
"type": "TEXT",
"name": "friendlyName",
"displayName": "Friendly Name",
"simpleValueType": true,
"help": "Friendly name for the user",
"enablingConditions": [
{
"paramName": "userId",
"paramValue": "",
"type": "PRESENT"
}
],
"valueHint": "Mona"
}
],
"help": "Custom Identifiers are informational data values about site visitors",
"enablingConditions": []
},
{
"type": "SIMPLE_TABLE",
"name": "custom_tag",
"displayName": "Custom Tag",
"simpleTableColumns": [
{
"defaultValue": "",
"displayName": "Key",
"name": "key",
"type": "TEXT",
"valueHint": ""
},
{
"defaultValue": "",
"displayName": "Value",
"name": "value",
"type": "TEXT",
"valueValidators": [
{
"type": "STRING_LENGTH",
"args": [
1,
255
]
}
],
"valueHint": ""
}
],
"help": "Custom tags are customizable filters that allow you to analyze recordings and heatmaps in different directions",
"valueValidators": []
}
]
}
]

Expand All @@ -60,10 +163,16 @@ const injectScript = require('injectScript');
const queryPermission = require('queryPermission');
const createArgumentsQueue = require('createArgumentsQueue');
const encodeUri = require('encodeUri');
//const log = require('logToConsole');

//Create clarity const
// Create clarity const
const clarity = createArgumentsQueue('clarity', 'clarity.q');

const customTags = data.custom_tag || [];
const friendlyName = data.friendlyName || '';
const sessionId = data.sessionId || '';
const pageId = data.pageId || '';

// Reconstruct customer clarity script URL
const url = "https://www.clarity.ms/tag/"+encodeUri(data.projectId)+"?ref=gtm";

Expand All @@ -81,7 +190,16 @@ const onCustomerFailure = () => {
// If the URL input by the user matches the permissions set for the template,
// inject the script with the onSuccess and onFailure methods as callbacks.
if (queryPermission('inject_script', "https://www.clarity.ms")) {
for(var i=0; i < customTags.length; i++){
clarity('set', customTags[i].key, customTags[i].value);
}

if(data.userId){
clarity("identify", data.userId, sessionId, pageId, friendlyName);
}

injectScript(url, onCustomerSuccess, onCustomerFailure);

} else {
data.gtmOnFailure();
}
Expand Down