Ads: report Ad Events - konstantin-shinkarenko/doc-sample-proj GitHub Wiki
In case of Conviva Ad module used to integrate against your Ad SDK, there's no need to use the below events. Conviva captures them automatically. If no module available, refer to the below documentation:
Here's the list of ad events to be reported from your application to Conviva:
adAnalytics.reportAdLoaded(Map<String,Object> adInfo);adAnalytics.reportAdStarted(Map<String,Object> adInfo);adAnalytics.reportAdFailed(Map<String,Object> adInfo, String errorMessage);adAnalytics.reportAdSkipped();adAnalytics.reportAdEnded();-
adAnalytics.reportAdMetric(ConvivaSdkConstants.PLAYBACK.<KEY_NAME> key, int | long | String | enum value);Refer to the available list of pre-defined metric keys in the table below.
TBD: specification for each method
| Key | Description |
|---|---|
| PLAYER_STATE | Requires: enum ConvivaSdkConstants.PlayerState. All player state changes such as Playing, Buffering etc. should be reported to CONVIVA SDK. |
| BITRATE | Requires: int (kbps). Report new bitrate value on change event (video + audio, or video only if audio isn't available) |
| SEEK_START | Optional: int (units - ??) . Start of seeking or scrubbing by user. If seek position is known, report as the method argument. |
| SEEK_END | Requires: none. End of seeking or scrubbing by user |
| PLAY_HEAD_TIME | Requires: long (seconds or ms - ??). Current playback position. |
| BUFFER_LENGTH | Requires: long (seconds or ms - ??). Report current Buffer length of the player. |
| RENDERED_FRAMERATE | Rendered framerate in fps. |
| CDN IP |
Requires: string. CDN IP address in string format. ☞ NOTE: The Conviva ExoPlayer module can also auto collect the CDN IP. Please contact Conviva Support to enable auto collection. |