Skip to main content

YouboraAnalyticsOptions

YouboraAnalyticsOptions = object

Properties​

adBlockerDetected?​

optional adBlockerDetected: boolean

Ad blocker detected flag

appName?​

optional appName: string

Name of the App

appReleaseVersion?​

optional appReleaseVersion: string

Version of the app

authToken?​

optional authToken: string

Auth token for all requests

authType?​

optional authType: string

Auth type for API calls (default "Bearer")

autoDetectBackground?​

optional autoDetectBackground: boolean

Automatically stop plugin when backgrounded

deviceBrand?​

optional deviceBrand: string

What will be displayed as the device brand on NPAW

deviceBrowserEngine?​

optional deviceBrowserEngine: string

Browser engine

Platform​

ios

deviceBrowserName?​

optional deviceBrowserName: string

Browser name

Platform​

ios

deviceBrowserType?​

optional deviceBrowserType: string

Browser type

Platform​

ios

deviceBrowserVersion?​

optional deviceBrowserVersion: string

Browser version

Platform​

ios

deviceCode?​

optional deviceCode: string

NPAW device code

deviceEDID?​

optional deviceEDID: any

EDID metadata

deviceIsAnonymous?​

optional deviceIsAnonymous: boolean

If true, UUID will not be reported

deviceModel?​

optional deviceModel: string

Device model name

deviceOsName?​

optional deviceOsName: string

OS name

deviceOsVersion?​

optional deviceOsVersion: string

OS version

deviceType?​

optional deviceType: string

Device type (pc, smartphone, stb, tv, etc.)

deviceUUID?​

optional deviceUUID: string

Device UUID (if not anonymous)

Platform​

ios

enabled?​

optional enabled: boolean

Enable/disable plugin

host?​

optional host: string

FastData host

httpSecure?​

optional httpSecure: boolean

If true, NQS calls use https://

Platform​

ios

method?​

optional method: "GET" | "POST"

Request method (GET or POST)

networkIP?​

optional networkIP: string

Network IP

networkIsp?​

optional networkIsp: string

Network ISP

offline?​

optional offline: boolean

If true, plugin stores events offline

sessionMetrics?​

optional sessionMetrics: Record<string, any>

Session-level custom metrics

userAnonymousId?​

optional userAnonymousId: string

userEmail?​

optional userEmail: string

userName?​

optional userName: string

User attributes

userObfuscateIp?​

optional userObfuscateIp: boolean

Option to obfuscate the IP

userPrivacyProtocol?​

optional userPrivacyProtocol: string

Privacy protocol ("optin" | "optout")

userType?​

optional userType: string