Interface MKPauseAd

Example:

{
    "ads": [
        {
            "id": "95323546",
            "sequence": 2,
            "creatives": [
                {
                    "id": "1360588028",
                    "nonLinearAds": {
                        "trackingEvents": [
                            {
                                "event": "impression",
                                "url": ["http://ads.example.com/ad/l/1?s=e37eb&n=535339%3B535338%3B528945&t=1783541371058982261&f=&r=535338&adid=95323546&reid=1360588028&arid=0&auid=&cn=defaultImpression&et=i&_cc=95323546,1360588028,,,1783541371,2&tpos=0&async=0&iw=&uxnw=535339&uxss=s23484960&uxct=2&metr=15&init=1&cr="]
                            },
                            {
                                "event": "pause",
                                "url": ["http://ads.example.com/ad/l/1?s=e37eb&n=535339%3B535338%3B528945&t=1783541371058982261&f=&r=535338&adid=95323546&reid=1360588028&arid=0&auid=&cn=_pause&et=s&_cc=&tpos=0&async=0"]
                            },
                            {
                                "event": "resume",
                                "url": ["http://ads.example.com/ad/l/1?s=e37eb&n=535339%3B535338%3B528945&t=1783541371058982261&f=&r=535338&adid=95323546&reid=1360588028&arid=0&auid=&cn=_resume&et=s&_cc=&tpos=0&async=0"]
                            },
                            {
                                "event": "complete",
                                "url": ["http://ads.example.com/ad/l/1?s=e37eb&n=535339%3B535338%3B528945&t=1783541371058982261&f=&r=535338&adid=95323546&reid=1360588028&arid=0&auid=&cn=complete&et=i&_cc=&tpos=0&async=0&init=1&iw=&uxnw=535339&uxss=s23484960&uxct=2&metr=15"]
                            }
                        ],
                        "nonLinear": [
                            {
                                "width": 1920,
                                "height": 1080,
                                "scalable": true,
                                "maintainAspectRatio": true,
                                "minSuggestedDurationSeconds": 5,
                                "renderDelaySeconds": 3,
                                "staticResources": [
                                    {
                                        "url": "https://cdn.example.com/pause/pause-ad-creative_1783449324.png",
                                        "creativeType": "image/png"
                                    }
                                ],
                                "clickThrough": {
                                    "url": ["http://ads.example.com/ad/l/1?s=e37eb&n=535339%3B535338%3B528945&t=1783541371058982261&f=&r=535338&adid=95323546&reid=1360588028&arid=0&auid=&cn=defaultClick&et=c&_cc=&tpos=0&async=0&cr="]
                                },
                                "clickTracking": {
                                    "url": ["http://ads.example.com/ad/l/1?s=e37eb&n=535339%3B535338%3B528945&t=1783541371058982261&f=&r=535338&adid=95323546&reid=1360588028&arid=0&auid=&cn=defaultClick&et=c&_cc=&tpos=0&async=0&cr="]
                                }
                            }
                        ]
                    }
                }
            ]
        }
    ]
}

Note:

  • PauseAds are processed in ascending sequence order and only one pauseAd image is preloaded at a time.
  • Image loading has a 10 sec timeout. If timed out then next image is loaded.
  • If all pauseAds used, then no further pauseAds shown.
  • Tracking URLs are notified only if MKPlayerConfig.enableAdTrackingBeacons is true.
interface MKPauseAd {
    creatives: {
        id?: string;
        nonLinearAds: {
            nonLinear: {
                clickThrough?: { url: string[] };
                clickTracking?: { url: string[] };
                height: number;
                maintainAspectRatio?: boolean;
                minSuggestedDurationSeconds?: number;
                renderDelaySeconds?: number;
                scalable?: boolean;
                staticResources: { creativeType: string; url: string }[];
                width: number;
            }[];
            trackingEvents: { event: string; url: string[] }[];
        };
    }[];
    id: string;
    sequence: number;
}

Properties

creatives id sequence

Properties

creatives

creatives: {
    id?: string;
    nonLinearAds: {
        nonLinear: {
            clickThrough?: { url: string[] };
            clickTracking?: { url: string[] };
            height: number;
            maintainAspectRatio?: boolean;
            minSuggestedDurationSeconds?: number;
            renderDelaySeconds?: number;
            scalable?: boolean;
            staticResources: { creativeType: string; url: string }[];
            width: number;
        }[];
        trackingEvents: { event: string; url: string[] }[];
    };
}[]

The creatives associated with pauseAd.

Type declaration

  • Optionalid?: string

    PauseAd creative ID

  • nonLinearAds: {
        nonLinear: {
            clickThrough?: { url: string[] };
            clickTracking?: { url: string[] };
            height: number;
            maintainAspectRatio?: boolean;
            minSuggestedDurationSeconds?: number;
            renderDelaySeconds?: number;
            scalable?: boolean;
            staticResources: { creativeType: string; url: string }[];
            width: number;
        }[];
        trackingEvents: { event: string; url: string[] }[];
    }

    Non-linear pauseAd info corresponding to the creative

    • nonLinear: {
          clickThrough?: { url: string[] };
          clickTracking?: { url: string[] };
          height: number;
          maintainAspectRatio?: boolean;
          minSuggestedDurationSeconds?: number;
          renderDelaySeconds?: number;
          scalable?: boolean;
          staticResources: { creativeType: string; url: string }[];
          width: number;
      }[]

      Non-linear pauseAd creative info

    • trackingEvents: { event: string; url: string[] }[]

      Tracking URLs associated with pauseAd creative

id

id: string

PauseAd ID

sequence

sequence: number

The sequence number of pauseAd.

Settings

Member Visibility

On This Page

Properties