Skip to content

Latest commit

 

History

History
161 lines (129 loc) · 3.89 KB

configuration.md

File metadata and controls

161 lines (129 loc) · 3.89 KB
Raw

Configuration

Configuration Structure

The configuration uses the following structure:

{
  trackingId: string,
  trackingGA4Id: string,
  tracking: {
    category: string | function,
    label: string | function,
    value: number | function,
    events: {
      <EVENT_NAME1>: {
        action: string | function,
        category: string | function,
        label: string | function,
        value: number | function,
      },
      <EVENT_NAME2>: {
        action: string | function,
        category: string | function,
        label: string | function,
        value: number | function,
      }
    }
  }
}

trackingId

Type: string
required: false
Description: The Universal Analytics Account ID (Can be configured in addition to the trackingGA4Id, one of them is mandatory).

trackingGA4Id

Type: string
required: false
Description: The Google Analytics 4 data stream ID (Can be configured in addition to the trackingId, one of them is mandatory).

tracking

Type: Object
required: false
Description: The tracking options.

tracking.category

Type: string | function
required: false
Description: The default category for the events.
Can be a string or a function1 that returns a string.

tracking.label

Type: string | function
required: false
Description: The default label for the events.
Can be a string or a function1 that returns a string.

tracking.value

Type: number | function
required: false
Description: The default value for the events.
Can be a number or a function1 that returns a number.

tracking.events

Type: Object
required: false
Description: A map of key-value pairs which key is an event to listen, and value is an object of the parameters to send once the event triggered.
The full events can be found here.

tracking.events[<event_name>].action

Type: string | function
required: true>
Description: The action to send once the <event_name> triggered.
Can be a string or a function1 that returns a string.

tracking.events[<event_name>].category

Type: string | function
required: false
Description: The category to send once the <event_name> triggered. if no given uses the default category.
Can be a string or a function1 that returns a string.

tracking.events[<event_name>].label

Type: string | function
required: false
Description: The label to send once the <event_name> triggered. if no given uses the default label.
Can be a string or a function1 that returns a string.

tracking.events[<event_name>].value

Type: number | function
required: false
Description: The value to send once the <event_name> triggered. if no given uses the default value.
Can be a number or a function1 that returns a number.

tracking.events[<event_name>].condition

Type: function
required: false
Description: A callback1. if given, the <event_name> will reported only if the condition is true.

Default Configuration Values

The default config can be found here.

1. bound to the plugin instance and gets the event as a parameter