1 Functionality
2 Syntax
- 2.1 EventData
  - 2.1.1 EventData.action
  - 2.1.2 EventData.label
  - 2.1.3 EventData.value
3 Description
- 3.1 Scope
- 3.2 GDRP analytic event flow
- 3.3 CCPA analytic event flow
- 3.4 No privacy region analytic event flow
4 Examples

Functionality

The enableGoogleAnalytics function enables analytic events to track user behavior with AdConsent.

Syntax

function adconsent()

argument name	type	optional	value	description

argument name	type	optional	value	description
command	string		`'enableGoogleAnalytics'`
parameter	boolean	✔️	`true` \| `false`	Enables or disables Google Analytics. Defaults to `true`
callback	function	✔️	`function(data: EventData)`	The callback receives the Google Analytics event data. Default detects ga or gtag objects and uses them automatically.

`EventData`

EventData = {
  category: 'AdConsent',
  action: '',
  label: '',
  value: '',
  nonInteraction: true
}

`EventData.action`

The consent region of this event:

'NONE'
'GDPR'
'CCPA'

`EventData.label`

The AdConsent event type:

User interface events
- 'GuiShow' - User interface is open. This does not include the USP notice link.
- ‘GuiSubmit' - User submits its settings, the following consent event will show the user’s choice.
Consent events
- 'FullConsent' - Vendors have full consent
- 'PublisherFullConsent' - Publisher has full consent
- 'PartialConsent' - Vendors have partial consent
- 'PublisherPartialConsent' - Publisher has partial consent
- 'NoConsent' - Vendors have no consent
- 'PublisherNoConsent' - Publisher has no consent
Others
- 'GooglePurposeOneMissing' - Google does not have purpose 1 or vendor consent and will not deliver ads
- 'Reconsider' - The reconsider timeout triggered, see reconsiderConsent
- 'Error...' - Error events starting with Error and showing specific errors

`EventData.value`

The time in milliseconds since the page was loaded.

Description

The analytics functionality is used to observe and track users' behavior with the AdConsent consent management.
It supports Google Analytics analytics.js and gtag.js by default. If you choose to use Google Analytics with custom names or an entirely different analytic system, you can pass a custom callback to convert analytic events to the format of your choice. See the examples section for use cases.

Scope

The function must be called before AdConsent start, i.e. in the stub. Calls after AdConsent is started will be ignored.

GDRP analytic event flow

CCPA analytic event flow

Note that GuiShow can happen multiple times before a user decides to submit consent settings triggering GuiSubmit. This means that GuiShow in the CCPA region should not be used to measure the acceptance rate.

No privacy region analytic event flow

Examples

Google Analytics with automatic API detection

Requires analytics.js or gtag.js to be loaded and either the tag ga or gtag must be defined.

adconsent('enableGoogleAnalytics');

Google Analytics with custom ga API name

adconsent('enableGoogleAnalytics', true, function(data) {
  gaCustomName('send', {
    hitType: 'event',
    eventCategory: event.category,
    eventAction: event.action,
    eventLabel: event.label,
    eventValue: event.value,
    nonInteraction: event.nonInteraction
  });
});

Google Analytics with custom gtag API name

Google Analytics with Google Tag Manager

This requires further configuration in GTM in order to provide the needed variables and linking to the correct Google Analytics account.

Documentation

enableGoogleAnalytics