@wscsports/blaze-rtn-sdk/lib/typescript/interfaces/blaze-analytics.interface.d.ts

WSC Sports Blaze SDK component for React Native

export declare enum EventCategory {
    Story = "Story",
    Widget = "Widget",
    Moment = "Moment",
    Video = "Video",
    Ad = "Ad",
    Interaction = "Interaction"
}
export declare enum EventActionName {
    SdkInit = "sdk_init",
    AppPause = "app_pause",
    AppContinue = "app_continue",
    CtaClick = "cta_click",
    Audio = "audio",
    ShareClick = "share_click",
    PlaybackPause = "playback_pause",
    PlaybackPlay = "playback_play",
    ForcedPlaybackPause = "forced_playback_pause",
    ForcedPlaybackPlay = "forced_playback_play",
    CCOff = "cc_off",
    CCOn = "cc_on",
    CustomActionButtonClick = "custom_action_button_click",
    PlaybackInitialStart = "playback_initial_start",
    StoryStart = "story_start",
    StoryExit = "story_exit",
    StoryPageStart = "story_page_start",
    StoryPageExit = "story_page_exit",
    WidgetLoad = "widget_load",
    WidgetClick = "widget_click",
    MomentsPlaylistStart = "moments_playlist_start",
    MomentsPlaylistExit = "moments_playlist_exit",
    MomentStart = "moment_start",
    MomentExit = "moment_exit",
    Like = "like",
    Unlike = "unlike",
    VideoStart = "video_start",
    VideoEnd = "video_end",
    BufferStart = "buffer_start",
    BufferEnd = "buffer_end",
    Seek = "seek",
    CTAVisible = "cta_visible",
    CTADismissed = "cta_dismissed",
    BannerAdLoad = "banner_ad_load",
    BannerAdView = "banner_ad_view",
    BannerAdClick = "banner_ad_click",
    BannerAdRequested = "banner_ad_requested",
    AdView = "ad_view",
    AdClick = "ad_click",
    AdExit = "ad_exit",
    AdPause = "ad_playback_pause",
    AdResume = "ad_playback_play",
    AdForcedPlaybackPause = "ad_forced_playback_pause",
    AdForcedPlaybackPlay = "ad_forced_playback_play",
    AdRequested = "ad_requested",
    ImaAllAdsCompleted = "ima_all_ads_completed",
    ImaAdClicked = "ima_ad_clicked",
    ImaAdCompleted = "ima_ad_completed",
    ImaAdLoaded = "ima_ad_loaded",
    ImaAdPaused = "ima_ad_paused",
    ImaAdResumed = "ima_ad_resumed",
    ImaAdSkipped = "ima_ad_skipped",
    ImaAdStarted = "ima_ad_started",
    ImaAdTapped = "ima_ad_tapped",
    ImaAdFirstQuartile = "ima_ad_first_quartile",
    ImaAdMidpoint = "ima_ad_midpoint",
    ImaAdThirdQuartile = "ima_ad_third_quartile",
    ImaAdRequested = "ima_ad_requested",
    InteractionView = "interaction_view",
    InteractionAnswer = "interaction_answer"
}
export declare enum ContentType {
    Story = "Story",
    Moment = "Moment",
    Video = "Video"
}
export declare enum ThumbnailType {
    Circle = "Circle",
    Rectangle = "Rectangle",
    Main = "Main"
}
export declare enum ThumbnailFormat {
    Animated = "Animated",
    Static = "Static"
}
export declare enum WidgetType {
    Row = "Row",
    Grid = "Grid"
}
export declare enum PlayableNavigationType {
    Automatic = "Automatic",
    Manual = "Manual"
}
export declare enum PlayableNavigationDirection {
    Forward = "Forward",
    Backward = "Backward",
    Close = "Close"
}
export declare enum PlayerStartTriggers {
    Widget = "Widget",
    Deeplink = "Deeplink",
    EntryPoint = "Entry Point",
    WidgetAutoPlay = "Auto Play From Widget",
    Notification = "Notification",
    AppForground = "App Foreground",
    Skip = "Skip"
}
export declare enum PlayerExitTriggers {
    Swipe = "Swipe",
    SwipeDown = "Swipe Down",
    Skip = "Skip",
    VideoFinished = "Video Finished",
    UserSkipNext = "User Skip Next",
    UserSkipPrevious = "User Skip Previous",
    CloseButton = "Close Button",
    AppClose = "App Close",
    AssetsExpiry = "URL Expiration",
    StoriesCompleted = "Stories completed",
    AppBackground = "App Background",
    BackButton = "Back Button",
    UserSwipeToDismiss = "User Swipe To Dismiss"
}
export declare enum PlaybackActionMethod {
    Press = "Press",
    Release = "Release"
}
export declare enum AudioState {
    Mute = "Mute",
    Unmute = "Unmute"
}
export declare enum VideoSeekType {
    Seekbar = "Seek Bar",
    DoubleTap = "Double Tap"
}
export declare enum VideoSeekDirection {
    Forward = "Forward",
    Backward = "Backward"
}
export declare enum BlazeAnalyticsOrientation {
    Portrait = "Portrait",
    Landscape = "Landscape"
}
export declare enum AnalyticsVideosCtaConfigType {
    AlwaysVisible = "Always Visible",
    VisibleAfterOverlayHidden = "Visible After Overlay Hidden"
}
export declare enum BlazeAnalyticsAdGestureType {
    SwipeUp = "Swipe-Up",
    Click = "Click"
}
export interface AnalyticsVideosCtaConfig {
    type?: AnalyticsVideosCtaConfigType;
    visible_duration?: number;
}
export interface UserProps {
    generated_user_id: string;
    external_user_id?: string;
    locale: string;
}
export interface ReferringPropsAnalytics {
    origin_widget_id?: string;
    origin_widget_type?: string;
    labels_expression?: string;
}
export interface WidgetProps {
    widget_id?: string;
    widget_type?: WidgetType;
    widget_size?: string;
    widget_content_count?: number;
    content_id?: string;
    content_type?: ContentType;
    content_index?: number;
    thumbnail_size?: string;
    thumbnail_aspect_ratio?: string;
    thumbnail_type?: ThumbnailType;
    widget_content_list?: [string];
    content_extra_info?: {
        [key: string]: string;
    };
    animated_thumbnail_enabled?: boolean;
    thumbnail_format?: ThumbnailFormat;
}
export interface StoryProps {
    story_session_id?: string;
    story_id?: string;
    story_title?: string;
    story_page_id?: string;
    story_page_parent_id?: string;
    story_composition_type?: string;
    story_page_index?: number;
    story_page_count?: number;
    story_page_navigation_type?: PlayableNavigationType;
    story_page_navigation_direction?: PlayableNavigationDirection;
    story_start_trigger?: PlayerStartTriggers;
    story_exit_trigger?: PlayerExitTriggers;
    story_page_duration?: number;
    story_page_duration_viewed_percent?: number;
    playback_action_method?: PlaybackActionMethod;
    audio_state?: AudioState;
    content_extra_info?: {
        [key: string]: string;
    };
    story_page_content_extra_info?: {
        [key: string]: string;
    };
    gesture_type?: string;
    cc_state?: string;
    custom_button_name?: string;
}
export interface MomentsProps {
    moments_session_id?: string;
    moment_id?: string;
    moment_title?: string;
    moment_index?: string;
    moment_navigation_type?: PlayableNavigationType;
    moment_navigation_direction?: PlayableNavigationDirection;
    moment_start_trigger?: PlayerStartTriggers;
    moment_exit_trigger?: PlayerExitTriggers;
    moment_duration?: number;
    moment_duration_viewed_percent?: number;
    playback_action_method?: PlaybackActionMethod;
    audio_state?: AudioState;
    loop_number?: number;
    content_extra_info?: {
        [key: string]: string;
    };
    cc_state?: string;
    custom_button_name?: string;
}
export interface VideoProps {
    video_session_id?: string;
    video_id?: string;
    video_title?: string;
    audio_state?: AudioState;
    video_start_trigger?: PlayerStartTriggers;
    video_end_trigger?: PlayerExitTriggers;
    video_duration?: number;
    seek_type?: VideoSeekType;
    seek_total_time?: number;
    seek_direction?: VideoSeekDirection;
    video_time_start?: number;
    video_time_end?: number;
    player_orientation?: BlazeAnalyticsOrientation;
    device_orientation?: BlazeAnalyticsOrientation;
    content_extra_info?: {
        [key: string]: string;
    };
    cta_config?: AnalyticsVideosCtaConfig;
}
export interface AdEventProps {
    session_id?: string;
    story_id?: string;
    story_title?: string;
    moment_id?: string;
    moment_title?: string;
    ad_duration?: number;
    advertiser_name?: string;
    content_type?: ContentType;
    content_extra_info?: {
        [key: string]: string;
    };
    story_page_content_extra_info?: {
        [key: string]: string;
    };
    ad_exit_trigger?: PlayerExitTriggers;
    ad_duration_viewed_percent?: number;
    playback_action_method?: PlaybackActionMethod;
    audio_state?: AudioState;
    advertiser_id?: string;
    campaign_id?: string;
    campaign_name?: string;
    ad_server?: string;
    ad_insertion_logic?: string;
    ad_index?: number;
    gesture_type?: BlazeAnalyticsAdGestureType;
    ad_id?: string;
    ad_title?: string;
    ad_description?: string;
    ad_system?: string;
    skippable?: boolean;
    skip_time_offset?: number;
    ima_url?: string;
    video_id?: string;
    video_title?: string;
    ad_unit_id?: string;
}
export interface InteractionProps {
    content_session_id?: string;
    content_type?: ContentType;
    content_id?: string;
    content_page_id?: string;
    content_title?: string;
    interaction_id?: string;
    interaction_type?: string;
    interaction_text?: string;
    interaction_selected_answer?: string;
    playback_action_method?: PlaybackActionMethod;
    audio_state?: AudioState;
    content_extra_info?: {
        [key: string]: string;
    };
    story_page_content_extra_info?: {
        [key: string]: string;
    };
    client_enrichment_url?: string;
}
export interface IBlazeAnalytics {
    timestamp_utc: string;
    timestamp_user_tz: string;
    sdk_version: string;
    sdk_type: string;
    event_category: EventCategory;
    event_action: EventActionName;
    user: UserProps;
    referring: ReferringPropsAnalytics;
    widget?: WidgetProps;
    story?: StoryProps;
    moment?: MomentsProps;
    video?: VideoProps;
    ad?: AdEventProps;
    interaction?: InteractionProps;
}
//# sourceMappingURL=blaze-analytics.interface.d.ts.map