Feature/ad and adbreak custom data bridging

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+### Added
+
+- Added support for the customData property on the Ad and AdBreak types.
+
 ## [11.4.0] - 26-07-06
 
 ### Fixed

android/src/main/java/com/theoplayer/ads/AdAdapter.kt

@@ -12,6 +12,8 @@ import com.theoplayer.android.api.ads.CompanionAd
 import com.theoplayer.android.api.ads.ima.GoogleImaAd
 import com.theoplayer.android.api.ads.UniversalAdId
 import com.theoplayer.android.api.event.ads.AdIntegrationKind
+import com.theoplayer.util.BridgeUtils
+import org.json.JSONObject
 import java.lang.Exception
 
 private const val PROP_AD_SYSTEM = "adSystem"
@@ -49,6 +51,7 @@ private const val PROP_COMPANION_HEIGHT = "height"
 private const val PROP_COMPANION_RESOURCEURI = "resourceURI"
 private const val PROP_UNIVERSAL_AD_ID_REGISTRY = "adIdRegistry"
 private const val PROP_UNIVERSAL_AD_ID_VALUE = "adIdValue"
+private const val PROP_CUSTOM_DATA = "customData"
 
 private const val INVALID_DOUBLE = -1.0
 private const val INVALID_INT = -1
@@ -130,6 +133,12 @@ object AdAdapter {
       }
       adPayload.putArray(PROP_AD_WRAPPER_CREATIVE_IDS, wrapperCreativeIdsPayload)
     }
+    val customData = ad.customData
+    if (customData is JSONObject) {
+      adPayload.putMap(PROP_CUSTOM_DATA, BridgeUtils.fromJSONObjectToBridge(customData))
+    } else if (customData is Map<*, *>) {
+      adPayload.putMap(PROP_CUSTOM_DATA, BridgeUtils.fromJSONObjectToBridge(JSONObject(customData)))
+    }
     return adPayload
   }
 
@@ -146,6 +155,12 @@ object AdAdapter {
     adbreakPayload.putInt(PROP_ADBREAK_MAXDURATION,adbreak.maxDuration)
     adbreakPayload.putInt(PROP_ADBREAK_TIMEOFFSET, adbreak.timeOffset)
     adbreakPayload.putDouble(PROP_ADBREAK_MAXREMAININGDURATION, adbreak.maxRemainingDuration)
+    val customData = adbreak.customData
+    if (customData is JSONObject) {
+      adbreakPayload.putMap(PROP_CUSTOM_DATA, BridgeUtils.fromJSONObjectToBridge(customData))
+    } else if (customData is Map<*, *>) {
+      adbreakPayload.putMap(PROP_CUSTOM_DATA, BridgeUtils.fromJSONObjectToBridge(JSONObject(customData)))
+    }
     val adsPayload = Arguments.createArray()
     for (ad in adbreak.ads) {
       // Some ads in the ad break are possibly not loaded yet.

ios/ads/THEOplayerRCTAdAdapter.swift

@@ -34,6 +34,7 @@
 let PROP_ADBREAK_ADS: String = "ads"
 let PROP_ADBREAK_INTEGRATION: String = "integration"
 let PROP_ADBREAK_CUSTOM_INTEGRATION: String = "customIntegration"
+let PROP_CUSTOM_DATA: String = "customData"
 let PROP_COMPANION_AD_SLOT_ID: String = "adSlotId"
 let PROP_COMPANION_ALT_TEXT: String = "altText"
 let PROP_COMPANION_CLICK_THROUGH: String = "clickThrough"
@@ -49,6 +50,9 @@
         if let customIntegration = ad.customIntegration {
             adData[PROP_AD_CUSTOM_INTEGRATION] = customIntegration
         }
+        if let customData = ad.customData as? [String: Any] {
+            adData[PROP_CUSTOM_DATA] = customData
+        }
         adData[PROP_AD_TYPE] = ad.type
         if let adId = ad.id {
             adData[PROP_AD_ID] = adId
@@ -180,6 +184,9 @@
         adBreakData[PROP_ADBREAK_MAX_REMAINING_DURATION] = adBreak.maxRemainingDuration
         adBreakData[PROP_ADBREAK_INTEGRATION] = adBreak.integration
         adBreakData[PROP_ADBREAK_CUSTOM_INTEGRATION] = adBreak.customIntegration
+        if let customData = adBreak.customData as? [String: Any] {
+            adBreakData[PROP_CUSTOM_DATA] = customData
+        }
         // process adds when adbreak contains them
         if !adBreak.ads.isEmpty {
             var adList: [[String:Any]] = []

ios/ads/THEOplayerRCTAdsNative.swift

@@ -30,6 +30,8 @@ class NativeAd: THEOplayerSDK.Ad {
     var clickThrough: String? = nil
     /**The type of custom ad integration.*/
     var customIntegration: String? = nil
+    /** Additional integration-specific data associated with this ad.*/
+    var customData: [String: Any]? = nil
 
     init(adBreak: AdBreak, companions: [THEOplayerSDK.CompanionAd], type: String, id: String? = nil, skipOffset: Int? = nil, resourceURI: String? = nil, width: Int? = nil, height: Int? = nil, isSlate: Bool = false, integration: THEOplayerSDK.AdIntegrationKind, duration: Int? = 0, clickThrough: String?, customIntegration: String?) {
         self.adBreak = adBreak
@@ -134,6 +136,8 @@ class NativeAdBreak: THEOplayerSDK.AdBreak {
        - For other integrations, this may be `nil`.
     */
    var id: String? = nil
+    /** Additional integration-specific data associated with this ad break.*/
+    var customData: [String: Any]? = nil
 
     init(ads: [Ad], id: String? = nil, maxDuration: Int, maxRemainingDuration: Double, timeOffset: Int, integration: THEOplayerSDK.AdIntegrationKind, customIntegration: String? = nil) {
         self.ads = ads

src/api/ads/Ad.ts

@@ -129,6 +129,14 @@ export interface Ad {
    * <br/> - Only supported for `'theo'` and `'google-ima'`.
    */
   universalAdIds: UniversalAdId[];
+
+  /**
+   * Additional integration-specific data associated with this ad.
+   *
+   * @remarks
+   * <br/> - The value depends on the ad integration. It may be `undefined` if the integration does not provide any custom data.
+   */
+  customData?: Record<string, unknown>;
 }
 
 /**

src/api/ads/AdBreak.ts

@@ -56,4 +56,12 @@ export interface AdBreak {
    * <br/> - This feature is not available in the Google IMA integration and will default to -1.
    */
   maxRemainingDuration: number | undefined;
+
+  /**
+   * Additional integration-specific data associated with this ad break.
+   *
+   * @remarks
+   * <br/> - The value depends on the ad integration. It may be `undefined` if the integration does not provide any custom data.
+   */
+  customData?: Record<string, unknown>;
 }