Skip to navigation
VoxEngineRuntime and modules

MeasurementProtocol

Implementation of the Measurement Protocol v1.
View as Markdown

Functions

endSession

Forces the current session to end with this hit. All other values are ignored.

endSession(): typeof MeasurementProtocol

sendEvent

Sends an event to Universal Analytics.

sendEvent(options: SendEventOptions): typeof MeasurementProtocol

Parameters

options
SendEventOptionsRequired

sendException

Sends a record about an exception.

sendException(options: SendExceptionOptions): typeof MeasurementProtocol

Parameters

options
SendExceptionOptionsRequired

sendItem

Sends an item to E-commerce.

sendItem(options: SendItemOptions): typeof MeasurementProtocol

Parameters

options
SendItemOptionsRequired

sendSocial

Sends a social interaction.

sendSocial(options: SendSocialOptions): typeof MeasurementProtocol

Parameters

options
SendSocialOptionsRequired

sendTiming

Measures the user’s timings.

sendTiming(options: SendTimingOptions): typeof MeasurementProtocol

Parameters

options
SendTimingOptionsRequired

sendTransaction

Sends a transaction to E-commerce.

sendTransaction(options: SendTransactionOptions): typeof MeasurementProtocol

Parameters

options
SendTransactionOptionsRequired

setApplicationInfo

Sets the application name and version.

setApplicationInfo(options: SetApplicationInfoOptions): typeof MeasurementProtocol

Parameters

options
SetApplicationInfoOptionsRequired

setSessionByCallerId

setSessionByCallerId(options: SetSessionByCallerIdOptions): Promise<typeof MeasurementProtocol>

Parameters

options
SetSessionByCallerIdOptionsRequired

setTrafficSource

Sets traffic source values.

setTrafficSource(options: SetTrafficSourceOptions): typeof MeasurementProtocol

Parameters

options
SetTrafficSourceOptionsRequired

setup

Sets up the required tracking parameters.

setup(trackingId: string, debug: boolean, dataSource: string): typeof MeasurementProtocol

Parameters

trackingId
stringRequired
debug
booleanRequired
dataSource
stringRequired

startSession

Forces a new session to start with this hit. All other values are ignored.

startSession(options: StartSessionOptions): typeof MeasurementProtocol

Parameters

options
StartSessionOptionsRequired

Types

SendEventOptions

action
string
category
string
label
string

optional

nonInteractionHit
string

optional

value
string

optional

SendExceptionOptions

description
string

optional

isFatal
boolean

optional

nonInteractionHit
string

optional

SendItemOptions

category
string

optional

code
string

optional

name
string
nonInteractionHit
string

optional

price
number
quantity
number
transactionId
number

SendSocialOptions

action
string

optional

network
string

optional

nonInteractionHit
string

optional

trigger
string

optional

SendTimingOptions

category
string

optional

label
string

optional

name
string

optional

nonInteractionHit
string

optional

time
number

optional

SendTransactionOptions

affiliation
string

optional

id
number
nonInteractionHit
string

optional

revenue
number
shipping
number

optional

tax
number

optional

SetApplicationInfoOptions

id
string

optional

installerID
string

optional

name
string
version
string

optional

SetSessionByCallerIdOptions

anonymizeIP
string

optional

callerId
string

optional

IPOverride
string

optional

userID
string

optional

SetTrafficSourceOptions

campaignContent
string

optional

campaignID
string

optional

campaignKeyword
string

optional

campaignMedium
string

optional

campaignName
string

optional

campaignSource
string

optional

documentReferrer
string

optional

googleAdsID
string

optional

googleDisplayAdsID
string

optional

StartSessionOptions

anonymizeIP
boolean

optional

clientID
string
geographicalOverride
string

optional

IPOverride
string

optional

userID
string

optional