Native Ads

Native ads are video or interactive ads that appear within the context of the user experience, such as in-feed sponsored content.

Building the Ad Placement (Ad Spot)

Add the required controllers to set up the ad placement:

Java

// Spot integration for native ad
InneractiveAdSpot mSpot = InneractiveAdSpotManager.get().createSpot();

// Adding the native controller
NativeAdUnitController adUnitController = new NativeAdUnitController();

// Adding the native video controller
NativeAdVideoContentController nativeAdVideoContentController = new NativeAdVideoContentController();

// Adding the native video controller to the ad unit controller
adUnitController.addContentController(nativeAdVideoContentController);
mSpot.addUnitController(adUnitController);

Adding Listeners

Add listeners for the controller and the spot.

Adding Event Listener for the Controller

The examples below demonstrate how you would add an EventListener to receive native ad callbacks.

Events:

Java

adUnitController.setEventsListener(new NativeAdEventsListenerWithImpressionData() {
  @Override
  public void onAdImpression(InneractiveAdSpot adSpot, ImpressionData impressionData) { }

  @Override
  public void onAdImpression(InneractiveAdSpot adSpot) { }

  @Override
  public void onAdClicked(InneractiveAdSpot adSpot) { }

  @Override
  public void onAdWillCloseInternalBrowser(InneractiveAdSpot adSpot) { }

  @Override
  public void onAdWillOpenExternalApp(InneractiveAdSpot adSpot) { }
});

Video Events:

Java

nativeAdVideoContentController.setEventsListener(new VideoContentListener() {
  @Override
  public void onProgress(int totalDurationInMsec, int positionInMsec) {
                
  }

  @Override
  public void onCompleted() {

  }

  @Override
  public void onPlayerError() {

  }
});

adUnitController.addContentController(nativeAdVideoContentController);

Adding Request Listener for the Spot

The example below demonstrates how you would add a RequestListener for the Spot:

Java

InneractiveAdSpot.NativeAdRequestListener spotListener = new InneractiveAdSpot.NativeAdRequestListener() {
  // When the ad loaded successfully
  @Override
  public void onInneractiveSuccessfulNativeAdRequest(InneractiveAdSpot adSpot, NativeAdContent adContent) {
  // Native ad is ready
  adContent.bindMediaView(new MediaView(applicationContext));
    
  populateNativeAdLayout(adContent);  
  registerViewsForInteraction(adContent);
  }
  // When the ad request fails to send
  @Override
  public void onInneractiveFailedAdRequest(InneractiveAdSpot adSpot, InneractiveErrorCode errorCode) {
  // Handle ad request failure
  }
};

mSpot.setRequestListener(spotListener);

Fetching the Ad

Native ads are only available through SDK Bidding mediation. In SDK Bidding, DT Exchange must first generate a token for the Mediation SDK to use when identifying the request to the server.

Use getBidderToken to generate a Bidder Token in a background thread:

Java

BidTokenProvider.getBidderToken();

Return type: java.lang.String. If an error occurs, the returned value is null.

If DT Exchange wins the auction, load the ad with the signaldata (adm) that was received from the server:

Java

mSpot.loadAd(adm);

Displaying the Ad

Define the ad layout in your XML file:

XML

<LinearLayout>
  <ImageView android:id="@+id/ad_icon"/>
  <LinearLayout>
    <TextView android:id="@+id/ad_title"/>
    <TextView android:id="@+id/ad_description"/>
    <RatingBar android:id="@+id/ad_rating"/>
  </LinearLayout>
</LinearLayout>


<FrameLayout
  android:id="@+id/media_view_container"
  android:layout_width="match_parent"
  android:layout_height="wrap_content"
  app:layout_constraintHeight_min="<SET_HEIGHT>"/>	
    
<Button android:id="@+id/ad_cta_btn"/>
</androidx.constraintlayout.widget.ConstraintLayout>

Use populateNativeAdLayout to create the Native layout:

Java

public void populateNativeAdLayout(NativeAdContent content) {
	
LayoutInflater inflater = LayoutInflater.from(context);
       adView = (ViewGroup) inflater.inflate(R.layout.native_ad_layout, null))

String adTitle = content.getAdTitle();
String adDescription = content.getAdDescription();
Uri appIconUri = content.getAppIcon();
String callToAction = content.getAdCallToAction();
Float rating = content.getRating();
MediaView mediaView = content.getMediaView();
Float aspectRatio = content.getMediaAspectRatio();

// Bind to native ad layout view e.g.:
// ImageView iconImageView = adView.findViewById(R.id.ad_icon);
// iconImageView.setImageURI(appIconUri);
// FrameLayout mediaViewContainer = adView.findViewById(R.id.media_view_container);
// mediaViewContainer.addView(mediaView);
}

For a list of supported Native Ads asset types, see the oRTB Specification for Native Ads.

Use registerViewsForInteraction to enable user interaction with the Native ad and register tracking events:

Java

public void registerViewsForInteraction(NativeAdContent content) {
  adView.setTag(NativeAdContent.ViewTag.ROOT);
  content.getMediaView().setTag(NativeAdContent.ViewTag.MEDIA_VIEW);
  iconImageView.setTag(NativeAdContent.ViewTag.AD_ICON);
  ctaButton.setTag(NativeAdContent.ViewTag.CTA);
  ratingView.setTag(NativeAdContent.ViewTag.RATING);
  descriptionTextView.setTeg(NativeAdContent.ViewTag.AD_DESCRIPTION);
  titleTextView.setTag(NativeAdContent.ViewTag.AD_TITLE);
	
  content.registerViewsForInteraction(rootViewGroup, content.getMediaView(), iconImageView, 
    Arrays.asList(ctaButton, ratingView, adDescription, adTitle));
}

Releasing an Ad Placement

DT recommends releasing the allocated resources for ad display. For more information, see Releasing Ad Instance Resources.