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