Reporting for external Players

For external Players or special Cases, the Customer can use a special Gateway to report the same Events as nexxPLAY does. For these Purposes, a Ping URL has to be built like the following:

Media Event Ping

GET https://ping.nexx.cloud/:domainid/:streamtype/:mediahash/:event

Path Parameters

Name
Type
Description

domainid

integer

The Domain ID

streamtype

string

The Type of the current Media Object

mediahash

string

The Hash ID of the current Media Object

event

string

The Action to Report. Currently supported is [display, playerstart, play, click, engage, adcall, ad, adclick]

Query Parameters

Name
Type
Description

feedid

string

If the Media Items for this Action were collected by a MRSS Feed/Podcast, report this ID here

deliveryPartner

integer

If the Action tool place by a known Delivery Partner, but within the Context of the Domain ID, add the Delivery Partner ID here.

affiliatePartner

integer

If the Action took place on a Frontend, provided by a known Affiliate Partner, add the Affilate Partner ID here (not the Affiliate Partner Code!).

gateway

string

The Playback Gateway for this Action. Supported values (for Standard Actions) are [desktop, mobile, tablet, ios, android, win8, osx, smarttv, androidtv, smart]

device

string

The Playback Device for this Action. Supported values a re [pc, mobile, tablet, tv, smart, watch]

r

string

A random Value (Cache Buster)

OK

For the playEvent, the following additional Query Parameters are supported:

Parameter

Description

protocol

The Stream Protocol [http, dash, hls]

codec

The Stream Codec [mp4, webm, hevc, vp9, mp3, opus, aac]

protection

The Stream is protected via [token, url, playready, widevine, fairplay]

For the engageEvent, the following additional Query Parameters are supported:

Parameter

Description

action

The Engagement Action, provided by 3Q

context

The Engagement Context

value

The Engagement Value, if suitable

For the clickEvent, the following additional Query Parameters are supported:

Parameter

Description

targetItem

The Item ID, that has been clicked, if the Click was handled on an Item, presented by the main Item

targetStreamtype

The Item Streamtype, that has been clicked, if the Click was handled on an Item, presented by the main Item

targetURL

The URL, that was opened by the Click

For all ad*Calls, the following Query Parameters are supported:

Parameter

Description

type

The Type of the Asset [bumper, preroll, midroll, postroll, banner]

mode

The used Technology [vast, ima, plugin]

provider

A Reference Code for the Ad Provider, provided by 3Q

Last updated