Implementation
Supported platforms
Content tracking is supported on iOS and Android mobile devices.
Event schemas
The Downloaded Content feature is the offline version of the the (standard) online Media Collection API, so the event data that your player batches and sends to the back-end must use the same event schemas that you use when you make online calls. For information on these schemas, see:
Order of events
- The first event in the batch payload must be
sessionStart
as per usual with the Media Collection API. - You must include
media.downloaded: true
in the standard metadata parameters (params
key) on thesessionStart
event to indicate to the back-end that you are sending downloaded content. If this parameter is not present or is set to false when you send downloaded data, the API will return a 400 response code (Bad Request). This parameter distinguishes downloaded versus live content to the back-end. Ifmedia.downloaded: true
is set on a live session, this will likewise result in a 400 response from the API. - It is the responsibility of the implementation to correctly store player events in the order of their appearance.
Response codes
- 201 - Created: Successful Request; the data is valid and the session was created and will be processed.
- 400 - Bad Request; schema validation has failed, all data is discarded, no sessions data will be processed.