​
Control Ads Visibility

You can control the visibility of ads by calling the setAdsEnabled method.

import overlayedAds from "@overlayed/ads";

overlayedAds.setAdsEnabled(false);

This can be useful for paid users, though it is recommended to omit the RevIQ ads script entirely on pages where ads are not desired.

​
Tracking Key Values

You can track key values by calling the setKv method. You’ll later be able to filter ad metrics based on these values.

import overlayedAds from "@overlayed/ads";

overlayedAds.setKv("page_id", "HomePage");

You may not pass any user-identifiable data (including names, addresses, or user IDs) in targeting.

Alternatively, there’s a convenience method for setting multiple key values at once:

import overlayedAds from "@overlayed/ads";

overlayedAds.setKvs({
	page_id: "HomePage",
	foo: "bar",
});

​
Providing User Identifiers

Providing a UID significantly improves ad performance. As such, it is optional, but highly recommended.

We comply with all privacy regulations and do not store any user-identifiable data. Once passed to RevIQ, the UID is normalized and then hashed; we never store the original value.

import overlayedAds from "@overlayed/ads";

overlayedAds.setUid({ e: "bestgamerx@gmail.com" });

If the user has opted out of tracking, the UID will not be stored or transmitted. Thus it is safe to call this function regardless of the user’s tracking preferences.

​
Tracking Key Values

You can track key values by calling the setKv method. You’ll later be able to filter ad metrics based on these values.

import overlayedAds from "@overlayed/ads";

overlayedAds.setKv("page_id", "HomePage");

You may not pass any user-identifiable data (including names, addresses, or user IDs) in targeting.

Alternatively, there’s a convenience method for setting multiple key values at once:

import overlayedAds from "@overlayed/ads";

overlayedAds.setKvs({
	page_id: "HomePage",
	foo: "bar",
});

You can show a consent dialog by calling the showConsent method.

This is typically automatically to users as-needed.