File size: 3,899 Bytes
1e92f2d
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
import { getDoNotTrack, getTrackingPrefs } from '@automattic/calypso-analytics';
import config from '@automattic/calypso-config';
import {
	isPiiUrl,
	isUrlExcludedForPerformance,
	mayWeTrackUserGpcInCcpaRegion,
	mayWeSessionTrack,
	getExceptions,
} from 'calypso/lib/analytics/utils';
import { isE2ETest } from 'calypso/lib/e2e';

const allAdTrackers = [
	'bing',
	'floodlight',
	'googleAds',
	'googleTagManager',
	'ga',
	'gaEnhancedEcommerce',
	'hotjar',
	'outbrain',
	'pinterest',
	'twitter',
	'facebook',
	'quantcast',
	'gemini',
	'experian',
	'iconMedia',
	'linkedin',
	'logrocket',
	'criteo',
	'pandora',
	'quora',
	'adroll',
	'parsely',
	'clarity',
	'reddit',
] as const;

const sessionAdTrackers = [ 'hotjar', 'logrocket' ];

export type AdTracker = ( typeof allAdTrackers )[ number ];

export enum Bucket {
	ESSENTIAL = 'essential',
	ADVERTISING = 'advertising',
	ANALYTICS = 'analytics',
}

export const AdTrackersBuckets: { [ key in AdTracker ]: Bucket | null } = {
	// Analytics trackers:
	parsely: Bucket.ANALYTICS,

	// Advertising trackers:
	ga: Bucket.ADVERTISING,
	gaEnhancedEcommerce: Bucket.ADVERTISING,
	hotjar: Bucket.ADVERTISING,
	bing: Bucket.ADVERTISING,
	floodlight: Bucket.ADVERTISING,
	googleAds: Bucket.ADVERTISING,
	googleTagManager: Bucket.ADVERTISING,
	logrocket: Bucket.ADVERTISING,
	twitter: Bucket.ADVERTISING,
	facebook: Bucket.ADVERTISING,
	reddit: Bucket.ADVERTISING,
	linkedin: Bucket.ADVERTISING,

	// Disabled trackers:
	quantcast: null,
	gemini: null,
	experian: null,
	iconMedia: null,
	criteo: null,
	pandora: null,
	quora: null,
	adroll: null,
	clarity: null,
	outbrain: null,
	pinterest: null,
};

const checkGtagInit = (): boolean => 'dataLayer' in window && 'gtag' in window;

const checkGtmInit = (): boolean => {
	return 'dataLayer' in window && 'google_tag_manager' in window;
};

export const AdTrackersInitGuards: Partial< { [ key in AdTracker ]: () => boolean } > = {
	ga: checkGtagInit,
	gaEnhancedEcommerce: checkGtagInit,
	floodlight: checkGtagInit,
	googleAds: checkGtagInit,
	googleTagManager: checkGtmInit,
	bing: () => 'uetq' in window,
	outbrain: () => 'obApi' in window,
	pinterest: () => 'pintrk' in window,
	twitter: () => 'twq' in window,
	facebook: () => 'fbq' in window,
	linkedin: () => '_linkedin_data_partner_ids' in window && 'lintrk' in window,
	criteo: () => 'criteo_q' in window,
	quora: () => 'qp' in window,
	adroll: () => 'adRoll' in window,
	clarity: () => 'clarity' in window,
	reddit: () => 'rdt' in window,
};

const isTrackerIntialized = ( tracker: AdTracker ): boolean => {
	const guardFunction = AdTrackersInitGuards[ tracker ];
	// If there is no guard function, skip the check
	return guardFunction ? guardFunction() : true;
};

export const mayWeTrackGeneral = () =>
	! isE2ETest() && ! getDoNotTrack() && ! isPiiUrl() && config.isEnabled( 'ad-tracking' );

export const mayWeTrackByBucket = ( bucket: Bucket ) => {
	if ( ! mayWeTrackGeneral() ) {
		return false;
	}

	if ( Bucket.ADVERTISING === bucket ) {
		// Disable advertising trackers on specific urls
		if ( isUrlExcludedForPerformance() ) {
			return false;
		}
		// Disable advertising trackers if GPC browser flag is set, and the user location pertains to CCPA.
		if ( ! mayWeTrackUserGpcInCcpaRegion() ) {
			return false;
		}
	}

	const prefs = getTrackingPrefs();
	return prefs.ok && prefs.buckets[ bucket ];
};

export const mayWeInitTracker = ( tracker: AdTracker ) => {
	const exceptions = getExceptions();

	if ( exceptions[ tracker ] ) {
		return false;
	}

	const bucket = AdTrackersBuckets[ tracker ];
	return null !== bucket && mayWeTrackByBucket( bucket );
};

export const mayWeTrackByTracker = ( tracker: AdTracker ) => {
	const mayTrackerInit = mayWeInitTracker( tracker ) && isTrackerIntialized( tracker );

	if ( sessionAdTrackers.includes( tracker ) ) {
		return mayWeSessionTrack() && mayTrackerInit;
	}

	return mayTrackerInit;
};