Global User Storage

This storage method allows you to store information for a specific user globally. This means the information is not restricted to any tool instance and can be shared across multiple tools. 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>, <GLOBAL FLAG>);

Placeholder	Description	Type	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
`<GLOBAL FLAG>`	When this flag is set to `true`, the user information from the storage is switched to the global storage instead of the tool-instance storage.	Boolean	true

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, true);
        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”
`<GLOBAL FLAG>`	When this flag is set to `true`, the user information from the storage is switched to the global storage instead of the tool-instance storage.	Boolean		true

Full Example (Server-Side Variable):

CODE

async function() {
    const gclid = this.userStorage.read("gclid", true);
    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”
`<GLOBAL FLAG>`	When this flag is set to `true`, the user information from the storage is switched to the global storage instead of the tool-instance storage.	Boolean		true

Full Example (Server-Side Variable):

CODE

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