The csPlayerData object

CS Player injects the csPlayerData object into HTML content (interactive advertisements and web pages). The object describes the screen, the frame and the advertisement being played.

  • displayAddress — screen address taken from the screen metadata

  • displayId — screen id

  • displayName — screen name

  • displayLatLong — screen coordinates; for on-transport screens with the mobile screen type the coordinates of the GPS/GLONASS receiver are passed, when available

  • displayResolution — screen resolution, an object of the form {"width": 600, "height": 300 }

  • displayPlacementType — placement type indoor / outdoor, taken from the screen metadata

  • displayInstallationType — screen type fixed / mobile, taken from the screen metadata

  • displayCriteria — array of screen criteria, contains objects of the form {"id": 1, "name": "Name" }

  • frameId — frame id

  • frameName — frame name

  • gid — frame inventory number

  • frameResolution — frame resolution, an object of the form {"width": 600, "height": 300 }

  • frameCriteria — array of frame criteria, contains objects of the form {"id": 1, "name": "Name" }

  • campaignId — campaign id

  • campaignName — campaign name

  • advertisementId — advertisement id

  • advertisementName — advertisement name

  • duration — expected duration of the advertisement slot

  • categories — array of campaign categories, contains objects of the form {"id": 1, "name": "Name" }

  • variables — user variables, an object of the form {"key_1":"value_1", "key_2":"value_2",…​, "key_N":"value_N"} containing all user variables defined for this advertisement, campaign, frame, screen, playlist, schedule, or media library file

  • showingAdvertisementEndTime — time when the playback of the current advertisement ends (number of milliseconds since midnight January 1, 1970 UTC)