THEOplayer React Native Connectors
    Preparing search index...

    Interface AnalyticsConfig

    interface AnalyticsConfig {
        adTrackingDisabled?: boolean;
        backendUrl?: string;
        cookiesDomain?: string;
        cookiesEnabled?: boolean;
        cookiesMaxAge?: number;
        deviceClass?:
            | "Console"
            | "Desktop"
            | "Other"
            | "Phone"
            | "STB"
            | "Tablet"
            | "TV"
            | "Wearable";
        deviceType?: string;
        enabled?: boolean;
        licenseKey: string;
        logLevel?: "DEBUG"
        | "ERROR";
        origin?: string;
        player?: string;
        randomizeUserId?: boolean;
        retryPolicy?: RetryPolicy;
        sourceMetadata?: SourceMetadata;
        ssaiEngagementTrackingEnabled?: boolean;
        userId?: string;
    }
    Index

    Properties

    adTrackingDisabled? backendUrl? cookiesDomain? cookiesEnabled? cookiesMaxAge? deviceClass? deviceType? enabled? licenseKey logLevel? origin? player? randomizeUserId? retryPolicy? sourceMetadata? ssaiEngagementTrackingEnabled? userId?

    Properties

    adTrackingDisabled?: boolean

    Flag to disable ClientSide Ad tracking. It doesn't affect server side ads.

    Only available on iOS and Android.

    false

    backendUrl?: string

    Optional backend URL to send the analytics data to.

    cookiesDomain?: string

    https://developer.bitmovin.com/playback/docs/configuration-analytics#optional-configuration

    Only available on Web.

    cookiesEnabled?: boolean

    Very similar to randomizeUserId if this is true we save a random UUID in a cookie for cross-referencing sessions. https://developer.bitmovin.com/playback/docs/configuration-analytics#optional-configuration

    Only available on Web.

    true

    cookiesMaxAge?: number

    Set cookies max-age attribute.

    https://developer.bitmovin.com/playback/docs/configuration-analytics#optional-configuration

    Only available on Web.

    1 year

    deviceClass?:
        | "Console"
        | "Desktop"
        | "Other"
        | "Phone"
        | "STB"
        | "Tablet"
        | "TV"
        | "Wearable"

    The device class. https://developer.bitmovin.com/playback/docs/analytics-api-fields

    Only available on Web.

    deviceType?: string

    The device type. https://developer.bitmovin.com/playback/docs/analytics-api-fields

    Only available on Web.

    enabled?: boolean

    Enable or disable the analytics collector.

    Only available on Web.

    licenseKey: string

    Your Bitmovin Analytics license key.

    logLevel?: "DEBUG" | "ERROR"

    Log level for the analytics SDK.

    'ERROR'
    origin?: string

    https://developer.bitmovin.com/playback/docs/configuration-analytics#optional-configuration

    Only available on Web.

    player?: string

    Player name. https://developer.bitmovin.com/playback/docs/analytics-api-fields

    Only available on Web.

    randomizeUserId?: boolean

    If false we use a device specific value in our data. This value is either retrieved from the system itself and is the same all the time or saved as a random UUID on the system. This allows you to connect sessions happening on the same device. If true we use a randomly generated UUID on every session. If users of your platform don't want to be tracked we recommend to set this to true.

    Only available on iOS and Android.

    false

    retryPolicy?: RetryPolicy

    Configuration to specify retry behaviour when samples cannot be sent to the backend. This also allows to enable offline tracking of analytics events.

    NO_RETRY

    sourceMetadata?: SourceMetadata

    Initial source metadata to be associated with the playback session.

    ssaiEngagementTrackingEnabled?: boolean

    Flag to enable ServerSide Ad Engagement tracking (quartile info). This is a premium feature and also needs to be requested through the account. SSAI Audience Info is not affected by this.

    Only available on iOS and Android.

    false

    userId?: string

    UUID that is persisted across play sessions https://developer.bitmovin.com/playback/docs/analytics-api-fields

    Only available on Web.

    Settings

    Member Visibility

    On This Page

    Properties