@bitmovin/api-sdk 1.209.0 → 1.210.0

package/dist/models/AnalyticsAdsImpressionSample.d.ts

@@ -1,866 +0,0 @@
-/**
- * @export
- * @class AnalyticsAdsImpressionSample
- */
-export declare class AnalyticsAdsImpressionSample {
-    /**
-     * Ad click through url
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    adClickthroughUrl?: string;
-    /**
-     * Ad description
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    adDescription?: string;
-    /**
-     * Ad duration
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    adDuration?: number;
-    /**
-     * Ad fallback index
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    adFallbackIndex?: number;
-    /**
-     * Ad id
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    adId?: string;
-    /**
-     * Ad id player
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    adIdPlayer?: string;
-    /**
-     * Ad impression id
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    adImpressionId?: string;
-    /**
-     * Ad is persistent
-     * @type {boolean}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    adIsPersistent?: boolean;
-    /**
-     * Ad module
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    adModule?: string;
-    /**
-     * Ad module version
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    adModuleVersion?: string;
-    /**
-     * Ad offset
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    adOffset?: string;
-    /**
-     * Ad playback height
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    adPlaybackHeight?: number;
-    /**
-     * Ad playback width
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    adPlaybackWidth?: number;
-    /**
-     * Ad pod position
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    adPodPosition?: number;
-    /**
-     * Ad position
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    adPosition?: string;
-    /**
-     * Ad preload offset
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    adPreloadOffset?: number;
-    /**
-     * Ad replace content duration
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    adReplaceContentDuration?: number;
-    /**
-     * Ad schedule duration
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    adScheduleTime?: number;
-    /**
-     * Ad skip after
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    adSkipAfter?: number;
-    /**
-     * Ad is skippable
-     * @type {boolean}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    adSkippable?: boolean;
-    /**
-     * Ad startup time
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    adStartupTime?: number;
-    /**
-     * Ad system
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    adSystem?: string;
-    /**
-     * Ad tag path
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    adTagPath?: string;
-    /**
-     * Ad system
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    adTagServer?: string;
-    /**
-     * Ad tag type
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    adTagType?: string;
-    /**
-     * Ad tag url
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    adTagUrl?: string;
-    /**
-     * Ad title
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    adTitle?: string;
-    /**
-     * Ad wrapper ads count
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    adWrapperAdsCount?: number;
-    /**
-     * Advertiser name
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    advertiserName?: string;
-    /**
-     * Analytics version
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    analyticsVersion?: string;
-    /**
-     * Api framework
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    apiFramework?: string;
-    /**
-     * Organization id
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    apiorgId?: string;
-    /**
-     * User id
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    apiuserId?: string;
-    /**
-     * Audio bitrate
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    audioBitrate?: number;
-    /**
-     * Is autoplay
-     * @type {boolean}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    autoplay?: boolean;
-    /**
-     * Browser name
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    browser?: string;
-    /**
-     * Browser is bot
-     * @type {boolean}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    browserIsBot?: boolean;
-    /**
-     * Browser version major
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    browserVersionMajor?: string;
-    /**
-     * Browser version minor
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    browserVersionMinor?: string;
-    /**
-     * CDN Provider
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    cdnProvider?: string;
-    /**
-     * City
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    city?: string;
-    /**
-     * Click percentage
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    clickPercentage?: number;
-    /**
-     * Click position
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    clickPosition?: number;
-    /**
-     * Clicked
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    clicked?: number;
-    /**
-     * Current time of the client
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    clientTime?: number;
-    /**
-     * Close percentage
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    closePercentage?: number;
-    /**
-     * Close position
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    closePosition?: number;
-    /**
-     * Closed
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    closed?: number;
-    /**
-     * Completed
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    completed?: number;
-    /**
-     * Country
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    country?: string;
-    /**
-     * Creative ad id
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    creativeAdId?: string;
-    /**
-     * Creative id
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    creativeId?: string;
-    /**
-     * Free form data set via the customData1 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    customData1?: string;
-    /**
-     * Free form data set via the customData2 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    customData2?: string;
-    /**
-     * Free form data set via the customData3 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    customData3?: string;
-    /**
-     * Free form data set via the customData4 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    customData4?: string;
-    /**
-     * Free form data set via the customData5 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    customData5?: string;
-    /**
-     * Free form data set via the customData6 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    customData6?: string;
-    /**
-     * Free form data set via the customData7 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    customData7?: string;
-    /**
-     * Free form data set via the customData8 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    customData8?: string;
-    /**
-     * Free form data set via the customData9 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    customData9?: string;
-    /**
-     * Free form data set via the customData10 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    customData10?: string;
-    /**
-     * Free form data set via the customData11 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    customData11?: string;
-    /**
-     * Free form data set via the customData12 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    customData12?: string;
-    /**
-     * Free form data set via the customData13 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    customData13?: string;
-    /**
-     * Free form data set via the customData14 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    customData14?: string;
-    /**
-     * Free form data set via the customData15 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    customData15?: string;
-    /**
-     * Free form data set via the customData16 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    customData16?: string;
-    /**
-     * Free form data set via the customData17 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    customData17?: string;
-    /**
-     * Free form data set via the customData18 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    customData18?: string;
-    /**
-     * Free form data set via the customData19 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    customData19?: string;
-    /**
-     * Free form data set via the customData20 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    customData20?: string;
-    /**
-     * Free form data set via the customData21 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    customData21?: string;
-    /**
-     * Free form data set via the customData22 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    customData22?: string;
-    /**
-     * Free form data set via the customData23 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    customData23?: string;
-    /**
-     * Free form data set via the customData24 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    customData24?: string;
-    /**
-     * Free form data set via the customData25 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    customData25?: string;
-    /**
-     * Free form data set via the customData26 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    customData26?: string;
-    /**
-     * Free form data set via the customData27 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    customData27?: string;
-    /**
-     * Free form data set via the customData28 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    customData28?: string;
-    /**
-     * Free form data set via the customData29 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    customData29?: string;
-    /**
-     * Free form data set via the customData30 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    customData30?: string;
-    /**
-     * Custom user ID
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    customUserId?: string;
-    /**
-     * Deal id
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    dealId?: string;
-    /**
-     * Type of device (Desktop, Phone, Tablet)
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    deviceClass?: string;
-    /**
-     * Type of the device detected via User Agent
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    deviceType?: string;
-    /**
-     * Domain the player was loaded on (.www is stripped away)
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    domain?: string;
-    /**
-     * Error code
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    errorCode?: number;
-    /**
-     * Error data
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    errorData?: string;
-    /**
-     * Error message
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    errorMessage?: string;
-    /**
-     * Error percentage
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    errorPercentage?: number;
-    /**
-     * Error position
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    errorPosition?: number;
-    /**
-     * Exit position
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    exitPosition?: number;
-    /**
-     * A/B test experiment name
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    experimentName?: string;
-    /**
-     * IP Address of the client
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    ipAddress?: string;
-    /**
-     * The users Internet Service Provider inferred via the IP address
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    isp?: string;
-    /**
-     * Language set in the browser
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    language?: string;
-    /**
-     * Analytics license key
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    licenseKey?: string;
-    /**
-     * Manifest download time
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    manifestDownloadTime?: number;
-    /**
-     * Media path
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    mediaPath?: string;
-    /**
-     * Media server
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    mediaServer?: string;
-    /**
-     * Media url
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    mediaUrl?: string;
-    /**
-     * Midpoint
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    midpoint?: number;
-    /**
-     * Minimum suggested duration
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    minSuggestedDuration?: number;
-    /**
-     * Operating system
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    operatingsystem?: string;
-    /**
-     * Operating system version major
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    operatingsystemVersionMajor?: string;
-    /**
-     * Operating system version minor
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    operatingsystemVersionMinor?: string;
-    /**
-     * Time in milliseconds the page took to load
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    pageLoadTime?: number;
-    /**
-     * Player load type. 1 = Foreground, 2 = Background
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    pageLoadType?: number;
-    /**
-     * path on the website
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    path?: string;
-    /**
-     * Percentage in viewport
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    percentageInViewport?: number;
-    /**
-     * Platform the player is running on (web, android, ios)
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    platform?: string;
-    /**
-     * Video player being used for this session
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    player?: string;
-    /**
-     * Player license key
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    playerKey?: string;
-    /**
-     * Time in milliseconds the player took to start up
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    playerStartuptime?: number;
-    /**
-     * HTML or native playback
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    playerTech?: string;
-    /**
-     * Player software version
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    playerVersion?: string;
-    /**
-     * Play percentage
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    playPercentage?: number;
-    /**
-     * Quartile 1
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    quartile1?: number;
-    /**
-     * Quartile 3
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    quartile3?: number;
-    /**
-     * Geographic region (ISO 3166-2 code)
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    region?: string;
-    /**
-     * Screen as reported by the browser
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    screenHeight?: number;
-    /**
-     * Screen as reported by the browser
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    screenWidth?: number;
-    /**
-     * Screen orientation (PORTRAIT, LANDSCAPE OR UNKNOWN)
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    screenOrientation?: string;
-    /**
-     * Video size (FULLSCREEN or WINDOW)
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    size?: string;
-    /**
-     * Skip percentage
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    skipPercentage?: number;
-    /**
-     * Skip position
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    skipPosition?: number;
-    /**
-     * Skipped
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    skipped?: number;
-    /**
-     * Started
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    started?: number;
-    /**
-     * Format of the stream (HLS, DASH, Progressive MP4)
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    streamFormat?: string;
-    /**
-     * Survey url
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    surveyUrl?: string;
-    /**
-     * Current time in milliseconds
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    time?: number;
-    /**
-     * Time in viewport
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    timeInViewport?: number;
-    /**
-     * Time played
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    timePlayed?: number;
-    /**
-     * Universal ad id registry
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    universalAdIdRegistry?: string;
-    /**
-     * Universal ad id value
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    universalAdIdValue?: string;
-    /**
-     * ID that is persisted across sessions to identify a browser
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    userId?: string;
-    /**
-     * Bitrate of the played back video rendition
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    videoBitrate?: number;
-    /**
-     * ID of the video
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    videoId?: string;
-    /**
-     * ID of related video impression
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    videoImpressionId?: string;
-    /**
-     * Free form human readable video ad title
-     * @type {string}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    videoTitle?: string;
-    /**
-     * Height of the video player on the page
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    videoWindowHeight?: number;
-    /**
-     * Width of the video player on the page
-     * @type {number}
-     * @memberof AnalyticsAdsImpressionSample
-     */
-    videoWindowWidth?: number;
-    constructor(obj?: Partial<AnalyticsAdsImpressionSample>);
-}
-export default AnalyticsAdsImpressionSample;