User Storage per Tool-Instance

This storage is the most commonly used one for persisting identifiers such as Client-IDs or Click-Identifiers like gclid, fbclid, etc., per tool instance for a specific user. To interact with the storage, we provide the following functions within the Server-Side variable runtime environment under the this scope:

Write information to the Storage

CODE

this.userStorage.write("<NAME>", <VALUE>, <EXPIRATION TIMESTAMP IN MILLISECONDS>);

Placeholder

Description

Type

Mandatory

Example

<NAME>

This defines the key under which the information should be stored and accessed in the storage.

String

“client_id”

<VALUE>

This defines the value that should be stored in the storage under the given key. There are no limitations on the type.

Any

“123abcd123.11111111”

<EXPIRATION TIMESTAMP>

This defines the expiration timestamp in milliseconds, determining when the information in the storage should be automatically deleted/removed by our clean-up process.

String

Number

JSON

Array

1740555149453

Full Example (Server-Side Variable):

CODE

async function() {
    const href = this.getFrontendVariable('window_location_href');
    const url = new URL(href);
    const gclid = url.searchParams.get("gclid");
    if (gclid) {
        const expirationTime = Date.now() + 7890000000;
        this.storage.write("gclid", gclid, expirationTime);
        return gclid;
    }
    return null;
}

Read information from the Storage

CODE

this.userStorage.read("<NAME>");

Placeholder	Description	Type	Mandatory	Example
`<NAME>`	This defines the key under which the information should be stored and accessed in the storage.	String		“client_id”

Full Example (Server-Side Variable):

CODE

async function() {
    const gclid = this.userStorage.read("gclid");
    return gclid || "";
}

Delete information from the Storage

CODE

this.userStorage.delete("<NAME>");

Placeholder	Description	Type	Mandatory	Example
`<NAME>`	This defines the key under which the information should be stored and accessed in the storage.	String		“client_id”

Full Example (Server-Side Variable):

CODE

async function() {
    this.userStorage.delete("gclid");
    return "";
}