iOS GAM Bidding-Only Integration - Rewarded Video

Back to Bidding-Only Integration

To integrate Rewarded Video ads into the app you should use the Prebid SDK RewardedVideoAdUnit class. It makes bid requests to Prebid Server and provides targeting keywords of the winning bid to the GMA SDK.

Integration Example

func createAd() {
    // 1. Create a RewardedVideoAdUnit using Prebid Mobile SDK
    adUnit = RewardedVideoAdUnit(configId: CONFIG_ID)
    
    // 2. Configure video parameters using Prebid Mobile SDK
    let parameters = VideoParameters()
    parameters.mimes = ["video/mp4"]
    parameters.protocols = [Signals.Protocols.VAST_2_0]
    parameters.playbackMethod = [Signals.PlaybackMethod.AutoPlaySoundOn]
    adUnit.parameters = parameters
    
    // 3. Make a bid request to Prebid Server using Prebid Mobile SDK
    let gamRequest = GAMRequest()
    adUnit.fetchDemand(adObject: gamRequest) { [weak self] resultCode in
        DemoLogger.shared.info("Prebid demand fetch for GAM \(resultCode.name())")
        
        // 4. Load the GAM rewarded ad using Google Mobile Ads SDK
        GADRewardedAd.load(withAdUnitID: AD_UNIT_ID, request: gamRequest) { [weak self] ad, error in
            guard let self = self else { return }
            if let error = error {
                DemoLogger.shared.error("Failed to load rewarded ad with error: \(error.localizedDescription)")
            } else if let ad = ad {
                // 5. Present the rewarded ad
                ad.fullScreenContentDelegate = self
                ad.present(fromRootViewController: self, userDidEarnRewardHandler: {
                    _ = ad.adReward
                })
            }
        }
    }
}

Step 1: Create an Ad Unit

Initialize the RewardedVideoAdUnit with properties:

  • configId - an ID of Stored Impression on Prebid Server

Step 2: Configure video parameters

Using the VideoParameters object you can customize the bid request for video ads.

placement

Not needed for Instream video integration, which uses placement=1 and plcmt=1.

The OpenRTB 2.6 Placement Type for the auction can be expressed as an integer array or you can use an enum for easier readability.

  • 2 or InBanner : In-Banner placement exists within a web banner that leverages the banner space to deliver a video experience as opposed to another static or rich media format. The format relies on the existence of display ad inventory on the page for its delivery.
  • 3 or InArticle : In-Article placement loads and plays dynamically between paragraphs of editorial content; existing as a standalone branded message.
  • 4 or InFeed : In-Feed placement is found in content, social, or product feeds.
  • 5 or Slider, Floating or Interstitial : Open RTB supports one of three values for option 5 as either Slider, Floating or Interstitial. If an enum value is supplied in placement, bidders will receive value 5 for placement type and assume to be interstitial with the instl flag set to 1.

Notes:

  • VideoInterstitialAdUnit and rewarded video ads will default to placement= 5 if no placement value is supplied.

api

The api property is dedicated to adding values for API Frameworks to bid response according to the OpenRTB 2.6 spec. The supported values for GMA SDK integration are:

  • 1 or Signals.Api.VPAID_1 : VPAID 1.0
  • 2 or Signals.Api.VPAID_2 : VPAID 2.0
  • 3 or Signals.Api.MRAID_1 : MRAID-1 support signal
  • 5 or Signals.Api.MRAID_2 : MRAID-2 support signal
  • 6 or Signals.Api.MRAID_3 : MRAID-3 support signal
  • 7 or Signals.Api.OMID_1 : signals OMSDK support

maxBitrate

Integer representing the OpenRTB 2.6 maximum bit rate in Kbps.

minBitrate

Integer representing the OpenRTB 2.6 minimum bit rate in Kbps.

maxDuration

Integer representing the OpenRTB 2.6 maximum video ad duration in seconds.

minDuration

Integer representing the OpenRTB 2.6 minimum video ad duration in seconds.

mimes

Array of strings representing the supported OpenRTB 2.6 content MIME types (e.g., “video/x-ms-wmv”, “video/mp4”). Required property.

playbackMethod

Array of OpenRTB 2.6 playback methods. If none are specified, any method may be used. Only one method is typically used in practice. It is strongly advised to use only the first element of the array.

  • 1 or Signals.PlaybackMethod.AutoPlaySoundOn : Initiates on Page Load with Sound On
  • 2 or Signals.PlaybackMethod.AutoPlaySoundOff : Initiates on Page Load with Sound Off by Default
  • 3 or Signals.PlaybackMethod.ClickToPlay : Initiates on Click with Sound On
  • 4 or Signals.PlaybackMethod.MouseOver : Initiates on Mouse-Over with Sound On
  • 5 or Signals.PlaybackMethod.EnterSoundOn : Initiates on Entering Viewport with Sound On
  • 6 or Signals.PlaybackMethod.EnterSoundOff: Initiates on Entering Viewport with Sound Off by Default

protocols

Array or enum of OpenRTB 2.6 supported Protocols. Values can be one of:

  • 1 or Signals.Protocols.VAST_1_0 : VAST 1.0
  • 2 or Signals.Protocols.VAST_2_0 : VAST 2.0
  • 3 or Signals.Protocols.VAST_3_0 : VAST 3.0
  • 4 or Signals.Protocols.VAST_1_0_Wrapper : VAST 1.0 Wrapper
  • 5 or Signals.Protocols.VAST_2_0_Wrapper : VAST 2.0 Wrapper
  • 6 or Signals.Protocols.VAST_3_0_Wrapper : VAST 3.0 Wrapper
  • 7 or Signals.Protocols.VAST_4_0 : VAST 4.0
  • 8 or Signals.Protocols.VAST_4_0_Wrapper : VAST 4.0 Wrapper

Step 3: Make the bid request

The fetchDemand method makes a bid request to the Prebid Server. The GAMRequest object provided to this method must be the one used in the next step to make the GAM ad request.

When Prebid Server responds, Prebid SDK will set the targeting keywords of the winning bid into provided object.

Step 4: Load a GAM Rewarded Ad

After receiving a bid it’s time to load the ad from GAM. If the GAMRequest contains targeting keywords, the respective Prebid line item may be returned from GAM, and GMA SDK will render its creative.

Step 5: Display the Rewarded Ad

Follow the GMA SDK guide to display the rewarded ad.

Further Reading