SKOverlay

Table of Contents

What is SKOverlay?

SKOverlay is a StoreKit class that allows developers to seamlessly nudge users to install apps. By using the iTunes identifier of another app, developers can display a banner‑sized overlay featuring the app’s icon, title, and a brief description. The overlay’s position on the screen can be adjusted to fit the app’s layout. SKOverlay is designed specifically for app recommendations, and for promoting other types of media, developers should use SKStoreProductViewController instead.

Demo

SKOverlay

How does NextGen SDK signals SKOverlay support to DSPs via Bid Request?

  • We will signal whether an impression is eligible for SKOverlay or not by passing a custom skoverlay field in the imp[].ext.skadn object.
  • For eligible requests the skoverlay field will denote a 1.
  • The skoverlay field will be omitted if not an eligible bid request.

Our SDK signals the SKOverlay to DSPs through the following field, which is included only for fullscreen video ads:

imp[].ext.skadn.skoverlay

Bid Request Signal Example


"skadn": 
{
"skoverlay": 1
}

 

Field Type Required Description Signal Value Expected Behaviour

skoverlay

int

Yes

Indicates whether SKOverlay is requested for the impression.

1, 0

Default Value – 1

If skoverlay: 1

  • DSP can respond with SKOverlay config.

If skoverlay: 0 or omitted

  • SKOverlay is not requested

 

 

What’s expected from the DSP in the Bid Response?

DSPs should respond with SKOverlay signal configuration under:

seatbid[].bid[].ext.skadn.skoverlay

Bid Response Example:


"ext": {
   "skadn": {
    "skoverlay": {
      "present": 1,
      "dismissible": 1,
      "delay": 1,
      "pos": 0,
      "autoclose": 0,
      "companion": 1,
      "click": 1
    }
  }
}

What are the supported SKOverlay display control NextGen SDK offers?

Field

Type

Required

Description

Signal Value

Expected Behavior

present

int

Yes

Indicates if DSP wants to support SKOverlay on their video ad.

0/1

If present = 1

  • DSP supports the SKOverlay on the fullscreen video ad.

 If present = 0

  • DSP does not support the SKOverlay on the full screen video ad.
  • All other properties are ignored.

dismissible

int

No

Indicates whether the DSP allows the user to dismiss the SKOverlay via swipe-down gesture.

0/1

Default Value: 0

If dismissible = 1

  • Users can dismiss the overlay by swiping it down.

If dismissible = 0

  • Users cannot dismiss the overlay manually. It will remain visible and will only disappear automatically when the ad finishes playing (or when autoclose is triggered, if applicable).

delay

int

No

Defines the delay (in seconds) after which the SKOverlay should be displayed once the ad starts playing.

0-60 sec

>Default value – 5 sec

If delay = 0

  • The SKOverlay is shown immediately when the ad begins.

If delay > 0

  • The SKOverlay appears after the specified number of seconds.

pos

int

No

Indicates the position of the SKOverlay on the video.
Currently, SKOverlay supports 2 positions, which are ‘bottom’ (default) and ‘bottom raised’

0/1

Default value: 0

If 0=  Bottom (default):

  • The SKOverlay is displayed at the bottom of the screen.

If 1 = Bottom Raised:

  • The SKOverlay is displayed slightly above the bottom, ideal for apps with a tab bar at the bottom.

autoclose

int

No

Specifies the duration (in seconds) after which the SKOverlay will automatically dismiss itself, starting from the moment it is displayed.

0/sec

If delay = 2 and autoclose = 3:

  • The SKOverlay appears 2 seconds after the video ad starts playing.
  • The SKOverlay automatically dismisses 3 seconds later, i.e., 5 seconds from the ad start.

If autoclose = 0:

  • The SKOverlay will remain visible until the ad finishes playing (or is dismissed manually if dismissible = 1).

companion

int

No

Indicates whether the DSP wants the SKOverlay to also appear on the companion ad or end card.

0/1

If companion = 1 (Yes):

  • The SKOverlay is displayed on the companion ad/end card.

If companion = 0 (No):

  • The SKOverlay is not displayed on the companion ad/end card.

click

int

No

Indicates whether the DSP wants to trigger a click tracking event when the SKOverlay is displayed.

0/1

If click = 1 (Yes):

  • A click tracking event is fired when the SKOverlay appears.

If click = 0 (No):

  • No click tracking event is triggered on the overlay display.
 
Doc Feedback Product Feedback

Last Modified: August 28, 2025 at 10:15 am