extractPasword — GTM Variable Template for URL

VARIABLES › URL

extractPasword EXTENDED URL

Direct (.tpl) Apply (.tpl)

Extracts the password from a URL with authentication credentials.

---

---

Examples

Extract password

INPUT

URL: https://user:[email protected]/path

OUTPUT

pass123

No password returns undefined

INPUT

URL: https://example.com/path

OUTPUT

undefined

---

GTM Configuration

This is what you'll see when you open this variable in Google Tag Manager. Hover the icons for details.

Read-only Preview

extractPasword

URL

💾 The URL to extract the password from.

Supported formats:
  ✓ String

Input Setup

Input Function (optional)

⚙️ Optional pre-processing function applied to the input before internal logic (e.g., convert object to string, normalize case). Internal transformations such as case handling will still apply afterward.

Result Handling

Output Function (optional)

⚙️ Optional function to apply to the result before returning it (e.g., str => str + ' €', val => val !== undefined for boolean conversion). Useful for chaining transformations on the output.

---

Related Variables

Same category: URL

→ buildUrlFromParts → completeUrl → decodeUri → decodeUriComponent → encodeURIComponent → encodeUri → extractHash → extractHashParams → extractHost → extractHostname → extractOrigin → extractPathname → extractPort → extractProtocol → extractSearch → extractSearchParams → extractSegmentByIndex → extractUserName → hasFragment → hasParameterWithValue → hasQueryString → parseUrlComponents → stringToPath

---

Under the Hood

📜 View Implementation Code

/**
 * Extracts the password from a given URL.
 *
 * @param {string} data.src - The URL to extract the password from.
 * @param {Function|string} [data.out] - Optional output handler: function to transform result or string with format.
 *
 * Direct-mode specific parameters:
 * @param {Function} [data.pre] - Optional pre-processor function to transform src before extracting.
 * 
 * @returns {string|undefined} The password from the URL, or undefined if the input is invalid.
 *
 * @framework ggLowCodeGTMKit
 */

const parseUrl = require('parseUrl');

const extractPassword = function(url) {
    const parsed = parseUrl(url);
    return parsed && parsed.password || undefined;
};

const safeFunction = fn => typeof fn === 'function' ? fn : x => x;
const out = safeFunction(data.out);

// ===============================================================================
// extractPassword - Direct mode
// ===============================================================================
const applyCast = (castFn, value) => safeFunction(castFn)(value);
const value = applyCast(data.pre, data.src);
return out(extractPassword(value));

// ===============================================================================
// extractPassword() – Apply Mode
// ===============================================================================
/*
return function(value) {
   return out(extractPassword(value));
};
*/

🧪 View Test Scenarios (5 tests)

✅ '[example] Extract password'
✅ URL with complex password - should extract URL-encoded password
✅ '[example] No password returns undefined'
✅ URL with username only (no password) - should return undefined
✅ Invalid URL - should return undefined