Support Collecting Arbitrary ORTB Parameters

EventHandlers/EventHandlers.xcodeproj/project.pbxproj

@@ -3,7 +3,7 @@
 	archiveVersion = 1;
 	classes = {
 	};
-	objectVersion = 51;
+	objectVersion = 54;
 	objects = {
 
 /* Begin PBXBuildFile section */
@@ -1200,7 +1200,7 @@
 				CLANG_WARN_QUOTED_INCLUDE_IN_FRAMEWORK_HEADER = NO;
 				CODE_SIGN_IDENTITY = "";
 				CODE_SIGN_STYLE = Manual;
-				CURRENT_PROJECT_VERSION = 2.1.6;
+				CURRENT_PROJECT_VERSION = 2.2.0;
 				DEFINES_MODULE = YES;
 				DEVELOPMENT_TEAM = "";
 				DYLIB_COMPATIBILITY_VERSION = 1;
@@ -1214,7 +1214,7 @@
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MARKETING_VERSION = 2.1.6;
+				MARKETING_VERSION = 2.2.0;
 				MODULEMAP_FILE = "";
 				PRODUCT_BUNDLE_IDENTIFIER = org.prebid.mobile.PrebidMobileGAMEventHandlers;
 				PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)";
@@ -1235,7 +1235,7 @@
 				CLANG_ENABLE_MODULES = YES;
 				CLANG_WARN_QUOTED_INCLUDE_IN_FRAMEWORK_HEADER = NO;
 				CODE_SIGN_STYLE = Manual;
-				CURRENT_PROJECT_VERSION = 2.1.6;
+				CURRENT_PROJECT_VERSION = 2.2.0;
 				DEFINES_MODULE = YES;
 				DEVELOPMENT_TEAM = "";
 				DYLIB_COMPATIBILITY_VERSION = 1;
@@ -1249,7 +1249,7 @@
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MARKETING_VERSION = 2.1.6;
+				MARKETING_VERSION = 2.2.0;
 				MODULEMAP_FILE = "";
 				PRODUCT_BUNDLE_IDENTIFIER = org.prebid.mobile.PrebidMobileGAMEventHandlers;
 				PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)";
@@ -1269,7 +1269,7 @@
 				CLANG_CXX_LANGUAGE_STANDARD = "gnu++17";
 				CLANG_ENABLE_MODULES = YES;
 				CODE_SIGN_STYLE = Automatic;
-				CURRENT_PROJECT_VERSION = 2.1.6;
+				CURRENT_PROJECT_VERSION = 2.2.0;
 				DEFINES_MODULE = YES;
 				DEVELOPMENT_TEAM = "";
 				DYLIB_COMPATIBILITY_VERSION = 1;
@@ -1284,7 +1284,7 @@
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MARKETING_VERSION = 2.1.6;
+				MARKETING_VERSION = 2.2.0;
 				PRODUCT_BUNDLE_IDENTIFIER = org.prebid.mobile.PrebidMobileMAXAdapters;
 				PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)";
 				SKIP_INSTALL = YES;
@@ -1304,7 +1304,7 @@
 				CLANG_CXX_LANGUAGE_STANDARD = "gnu++17";
 				CLANG_ENABLE_MODULES = YES;
 				CODE_SIGN_STYLE = Automatic;
-				CURRENT_PROJECT_VERSION = 2.1.6;
+				CURRENT_PROJECT_VERSION = 2.2.0;
 				DEFINES_MODULE = YES;
 				DEVELOPMENT_TEAM = "";
 				DYLIB_COMPATIBILITY_VERSION = 1;
@@ -1319,7 +1319,7 @@
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MARKETING_VERSION = 2.1.6;
+				MARKETING_VERSION = 2.2.0;
 				PRODUCT_BUNDLE_IDENTIFIER = org.prebid.mobile.PrebidMobileMAXAdapters;
 				PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)";
 				SKIP_INSTALL = YES;
@@ -1381,7 +1381,7 @@
 				CLANG_CXX_LANGUAGE_STANDARD = "gnu++17";
 				CLANG_ENABLE_MODULES = YES;
 				CODE_SIGN_STYLE = Automatic;
-				CURRENT_PROJECT_VERSION = 2.1.6;
+				CURRENT_PROJECT_VERSION = 2.2.0;
 				DEFINES_MODULE = YES;
 				DYLIB_COMPATIBILITY_VERSION = 1;
 				DYLIB_CURRENT_VERSION = 1;
@@ -1395,7 +1395,7 @@
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MARKETING_VERSION = 2.1.6;
+				MARKETING_VERSION = 2.2.0;
 				PRODUCT_BUNDLE_IDENTIFIER = org.prebid.mobile.PrebidMobileAdMobAdapters;
 				PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)";
 				PROVISIONING_PROFILE_SPECIFIER = None;
@@ -1416,7 +1416,7 @@
 				CLANG_CXX_LANGUAGE_STANDARD = "gnu++17";
 				CLANG_ENABLE_MODULES = YES;
 				CODE_SIGN_STYLE = Automatic;
-				CURRENT_PROJECT_VERSION = 2.1.6;
+				CURRENT_PROJECT_VERSION = 2.2.0;
 				DEFINES_MODULE = YES;
 				DYLIB_COMPATIBILITY_VERSION = 1;
 				DYLIB_CURRENT_VERSION = 1;
@@ -1430,7 +1430,7 @@
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MARKETING_VERSION = 2.1.6;
+				MARKETING_VERSION = 2.2.0;
 				PRODUCT_BUNDLE_IDENTIFIER = org.prebid.mobile.PrebidMobileAdMobAdapters;
 				PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)";
 				PROVISIONING_PROFILE_SPECIFIER = None;

PrebidMobile.podspec

@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name         = "PrebidMobile"
-  s.version      = "2.1.6"
+  s.version      = "2.2.0"
   s.summary      = "PrebidMobile is a lightweight framework that integrates directly with Prebid Server."
 
   s.description  = <<-DESC

PrebidMobile.xcodeproj/project.pbxproj

@@ -3,7 +3,7 @@
 	archiveVersion = 1;
 	classes = {
 	};
-	objectVersion = 52;
+	objectVersion = 54;
 	objects = {
 
 /* Begin PBXBuildFile section */
@@ -4455,7 +4455,7 @@
 				CODE_SIGN_IDENTITY = "";
 				CODE_SIGN_STYLE = Automatic;
 				CONFIGURATION_BUILD_DIR = "$(BUILD_DIR)/$(CONFIGURATION)$(EFFECTIVE_PLATFORM_NAME)";
-				CURRENT_PROJECT_VERSION = 2.1.6;
+				CURRENT_PROJECT_VERSION = 2.2.0;
 				DEFINES_MODULE = YES;
 				DEVELOPMENT_TEAM = "";
 				DYLIB_COMPATIBILITY_VERSION = 1;
@@ -4474,7 +4474,7 @@
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MARKETING_VERSION = 2.1.6;
+				MARKETING_VERSION = 2.2.0;
 				MODULEMAP_FILE = PrebidMobile/BuildFiles/PrebidMobile.modulemap;
 				SKIP_INSTALL = YES;
 				SWIFT_OPTIMIZATION_LEVEL = "-Onone";
@@ -4491,7 +4491,7 @@
 				CODE_SIGN_IDENTITY = "";
 				CODE_SIGN_STYLE = Automatic;
 				CONFIGURATION_BUILD_DIR = "$(BUILD_DIR)/$(CONFIGURATION)$(EFFECTIVE_PLATFORM_NAME)";
-				CURRENT_PROJECT_VERSION = 2.1.6;
+				CURRENT_PROJECT_VERSION = 2.2.0;
 				DEFINES_MODULE = YES;
 				DEVELOPMENT_TEAM = "";
 				DYLIB_COMPATIBILITY_VERSION = 1;
@@ -4510,7 +4510,7 @@
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MARKETING_VERSION = 2.1.6;
+				MARKETING_VERSION = 2.2.0;
 				MODULEMAP_FILE = PrebidMobile/BuildFiles/PrebidMobile.modulemap;
 				SKIP_INSTALL = YES;
 				SWIFT_VERSION = 5.0;

PrebidMobile/AdUnits/AdUnit.swift

@@ -24,7 +24,7 @@ public class AdUnit: NSObject, DispatcherDelegate {
     var adSizes: [CGSize] {
         get { [adUnitConfig.adSize] + (adUnitConfig.additionalSizes ?? []) }
     }
-
+        
     private static let PB_MIN_RefreshTime = 30000.0
 
     private(set) var dispatcher: Dispatcher?
@@ -387,6 +387,16 @@ public class AdUnit: NSObject, DispatcherDelegate {
         return adUnitConfig.gpid
     }
 
+    // MARK: Global ORTBObject
+
+    public func setOrtbConfig(_ ortbObject: [String: Any]?) {
+        adUnitConfig.ortbConfig = ortbObject
+    }
+
+    public func getOrtbConfig() -> [String: Any]? {
+        return adUnitConfig.ortbConfig
+    }
+
     // MARK: - others
 
     /**

PrebidMobile/AdUnits/MultiformatAdUnit/PrebidRequest.swift

@@ -29,6 +29,8 @@ public class PrebidRequest: NSObject {
 
     private(set) var gpid: String?
 
+    private(set) var ortbConfig: [String: Any]?
+
     // MARK: - Private properties
 
     private var extData = [String: Set<String>]()

PrebidMobile/AdUnits/Native/NativeAd.swift

@@ -176,10 +176,14 @@ public class NativeAd: NSObject, CacheExpiryDelegate {
             Log.error("The native Ad is expired, cannot use it for tracking")
             return false
         }
-        viewForTracking = view
-        setupViewabilityTracker()
-        attachGestureRecognizersToNativeView(nativeView: view, withClickableViews: clickableViews)
-        return true
+        if (viewForTracking != nil || impressionHasBeenTracked) {
+            return false
+        } else {
+            viewForTracking = view
+            setupViewabilityTracker()
+            attachGestureRecognizersToNativeView(nativeView: view, withClickableViews: clickableViews)
+            return true
+        }
     }
 
     private func unregisterViewFromTracking() {
@@ -219,6 +223,9 @@ public class NativeAd: NSObject, CacheExpiryDelegate {
                 return
             }
             strongSelf.checkViewability()
+            if (strongSelf.viewForTracking == nil) {
+                timer.invalidate()
+            }
         }
     }
 

PrebidMobile/Constants.swift

@@ -18,7 +18,7 @@ import UIKit
 public let PrebidLocalCacheIdKey = "hb_cache_id_local"
 
 @objc public class Constants: NSObject {
-    @objc public static let PREBID_VERSION = "2.1.6"
+    @objc public static let PREBID_VERSION = "2.2.0"
 }
 
 extension String {

PrebidMobile/PrebidMobileRendering/AdTypes/AdView/AdConfiguration.swift

@@ -122,7 +122,10 @@ public class AdConfiguration: AutoRefreshCountConfig {
 
     public var clickHandlerOverride: ((PBMVoidBlock) -> Void)?
 
+    public var ortbConfig: [String: Any]?
+
     // MARK: Private properties
 
     private var _autoRefreshDelay: TimeInterval? = PBMAutoRefresh.AUTO_REFRESH_DELAY_DEFAULT
+
 }

PrebidMobile/PrebidMobileRendering/Networking/Parameters/PBMParameterBuilderService.m

@@ -45,6 +45,7 @@ @implementation PBMParameterBuilderService
 }
 
 + (nonnull NSDictionary<NSString* , NSString *> *)buildParamsDictWithAdConfiguration:(nonnull PBMAdConfiguration *)adConfiguration extraParameterBuilders:(nullable NSArray<id<PBMParameterBuilder> > *)extraParameterBuilders {
+    //build
     return [self buildParamsDictWithAdConfiguration:adConfiguration
                                              bundle:NSBundle.mainBundle
                                  pbmLocationManager:PBMLocationManager.shared
@@ -71,6 +72,7 @@ @implementation PBMParameterBuilderService
                                                               extraParameterBuilders:(nullable NSArray<id<PBMParameterBuilder> > *)extraParameterBuilders{
 
     PBMORTBBidRequest *bidRequest = [PBMParameterBuilderService createORTBBidRequestWithTargeting:targeting];
+    bidRequest.ortbObject = adConfiguration.ortbConfig;
     NSMutableArray<id<PBMParameterBuilder> > * const parameterBuilders = [[NSMutableArray alloc] init];
     [parameterBuilders addObjectsFromArray:@[
         [[PBMBasicParameterBuilder alloc] initWithAdConfiguration:adConfiguration
@@ -109,7 +111,7 @@ + (nonnull PBMORTBBidRequest *)createORTBBidRequestWithTargeting:(nonnull Target
     bidRequest.user.buyeruid    = targeting.buyerUID;
     bidRequest.user.customdata  = targeting.userCustomData;
     bidRequest.user.userid      = targeting.userID;
-
+    
     if (targeting.userExt) {
         bidRequest.user.ext = [targeting.userExt mutableCopy];
     }

PrebidMobile/PrebidMobileRendering/ORTB/PBMORTBBidRequest.h

@@ -135,6 +135,10 @@ NS_ASSUME_NONNULL_BEGIN
 
 @property (nonatomic, strong) PBMORTBBidRequestExtPrebid *extPrebid;
 
+@property (nonatomic, strong, nullable) NSDictionary<NSString *, id> *arbitraryJsonConfig;
+
+@property (nonatomic, strong, nullable) NSDictionary<NSString *, id> *ortbObject;
+
 - (instancetype)init;
 
 @end

PrebidMobile/PrebidMobileRendering/ORTB/PBMORTBBidRequest.m

@@ -68,6 +68,58 @@ - (nonnull PBMJsonDictionary *)toJsonDictionary {
     ext[@"prebid"] = [[self.extPrebid toJsonDictionary] nullIfEmpty];
     ret[@"ext"] = [[ext pbmCopyWithoutEmptyVals] nullIfEmpty];
 
+    //remove "protected" fields from ortbObject then do a merge but merge ret into the ortbObject (addEntriesFromDictionary)
+    NSMutableDictionary *o = [self.arbitraryJsonConfig mutableCopy];
+    if (o[@"regs"]) {
+        o[@"regs"] = nil;
+    }
+    if (o[@"device"]) {
+        o[@"device"] = nil;
+    }
+    if (o[@"geo"]) {
+        o[@"geo"] = nil;
+    }
+    //merge with config from API/JSON
+    ret = [self mergeDictionaries: ret joiningArgument2: o joiningArgument3: false];
+
+    NSMutableDictionary *o2 = [self.ortbObject mutableCopy];
+
+    if (o2[@"regs"]) {
+        o2[@"regs"] = nil;
+    }
+    if (o2[@"device"]) {
+        o2[@"device"] = nil;
+    }
+    if (o2[@"geo"]) {
+        o[@"geo"] = nil;
+    }
+    //merge with ortbConfig from SDK
+    ret = [self mergeDictionaries: ret joiningArgument2: o2 joiningArgument3: true];
+
+    ret = [ret pbmCopyWithoutEmptyVals];
+
+    return ret;
+}
+
+- (nonnull PBMMutableJsonDictionary *)mergeDictionaries:(NSMutableDictionary*)dictionary1 joiningArgument2:(NSMutableDictionary*)dictionary2
+                                       joiningArgument3:(Boolean)firstHasPriority{
+    PBMMutableJsonDictionary *ret = dictionary1;
+
+    for (id key in dictionary2)
+        if ([ret objectForKey: key]){
+            if ([[ret objectForKey: key] isKindOfClass: [NSDictionary class]]) {
+                //if is dictionary, need to call this method recursively for ret object for key and dictionary2 for key
+                [ret setObject:[self mergeDictionaries:[ret objectForKey: key] joiningArgument2: [dictionary2 objectForKey: key] joiningArgument3:firstHasPriority] forKey: key];
+            } else {
+                if (!firstHasPriority) {
+                    [ret setObject:[dictionary2 objectForKey: key] forKey:key];
+                }
+            }
+            //not sure what to do if array of objects
+        } else {
+            [ret setObject:[dictionary2 objectForKey:key] forKey: key];
+        }
+
     ret = [ret pbmCopyWithoutEmptyVals];
 
     return ret;
@@ -98,6 +150,8 @@ - (instancetype)initWithJsonDictionary:(nonnull PBMJsonDictionary *)jsonDictiona
 
     _extPrebid = [[PBMORTBBidRequestExtPrebid alloc] initWithJsonDictionary:jsonDictionary[@"ext"][@"prebid"] ?: @{}];
 
+    _arbitraryJsonConfig = jsonDictionary;
+
     return self;
 }
 

PrebidMobile/PrebidMobileRendering/Prebid/Integrations/GAM/BannerView.swift

@@ -64,6 +64,11 @@ public class BannerView: UIView,
         set { adUnitConfig.adPosition = newValue }
     }
 
+    @objc public var ortbConfig: [String: Any]? {
+        get { adUnitConfig.ortbConfig }
+        set { adUnitConfig.ortbConfig = newValue }
+    }
+
     @objc public weak var delegate: BannerViewDelegate?
 
     // MARK: Readonly storage

PrebidMobile/PrebidMobileRendering/Prebid/Integrations/GAM/BaseInterstitialAdUnit.swift

@@ -46,6 +46,11 @@ public class BaseInterstitialAdUnit :
         get { adUnitConfig.adFormats }
         set { adUnitConfig.adFormats = newValue }
     }
+
+    @objc public var ortbConfig: [String: Any]? {
+        get { adUnitConfig.ortbConfig }
+        set { adUnitConfig.ortbConfig = newValue }
+    }
 
     @objc public var isReady: Bool {
         objc_sync_enter(blocksLockToken)

PrebidMobile/PrebidMobileRendering/Prebid/Integrations/MediationAPI/MediationBannerAdUnit.swift

@@ -70,6 +70,11 @@ public class MediationBannerAdUnit : NSObject {
         set { adUnitConfig.additionalSizes = newValue }
     }
 
+    public var ortbConfig: [String: Any]? {
+        get { adUnitConfig.ortbConfig }
+        set { adUnitConfig.ortbConfig = newValue }
+    }
+
     // MARK: - Ext Data (imp[].ext.data)
 
     @available(*, deprecated, message: "This method is deprecated. Please, use addExtData method instead.")