diff --git a/example/ios/Runner.xcworkspace/contents.xcworkspacedata b/example/ios/Runner.xcworkspace/contents.xcworkspacedata index 1d526a16..21a3cc14 100644 --- a/example/ios/Runner.xcworkspace/contents.xcworkspacedata +++ b/example/ios/Runner.xcworkspace/contents.xcworkspacedata @@ -4,4 +4,7 @@ + + diff --git a/ios/Classes/KontextInAppWebViewPlugin.swift b/ios/Classes/KontextInAppWebViewPlugin.swift index 9597d51b..ace3ec84 100644 --- a/ios/Classes/KontextInAppWebViewPlugin.swift +++ b/ios/Classes/KontextInAppWebViewPlugin.swift @@ -55,10 +55,18 @@ final class KontextInAppWebViewPlatformView: NSObject, FlutterPlatformView, WKNa private let channel: FlutterMethodChannel private let webView: WKWebView private let settings: IOSInAppWebViewSettings + private let omService: OMManaging + private let omAudioSessionHelper: OMAudioSessionHelper private var hasLoadedInitialUrl = false private var isInitialCookieSeedingComplete: Bool private var hasPendingInitialLoad = false private let initialUrl: URL? + private var omCreativeType: OMCreativeType? + private var hasLoadedPage = false + private var pendingOpenMeasurementStart = false + private var activeOMSession: OMSession? + private var activeOMSessionUsesVideoAudioSession = false + private var lastContentURL: URL? init( frame: CGRect, @@ -67,11 +75,18 @@ final class KontextInAppWebViewPlatformView: NSObject, FlutterPlatformView, WKNa creationParams: [String: Any]? ) { self.settings = IOSInAppWebViewSettings(creationParams: creationParams) + self.omService = OMManager.shared + self.omAudioSessionHelper = OMAudioSessionHelper.shared if let urlString = ((creationParams?["initialUrlRequest"] as? [String: Any])?["url"] as? String) { self.initialUrl = URL(string: urlString) } else { self.initialUrl = nil } + if let creativeType = creationParams?["initialOmCreativeType"] as? String { + self.omCreativeType = OMCreativeType(rawValue: creativeType) + } else { + self.omCreativeType = nil + } let initialCookiesToSeed: [HTTPCookie] if #available(iOS 11.0, *), self.settings.sharedCookiesEnabled { initialCookiesToSeed = HTTPCookieStorage.shared.cookies ?? [] @@ -89,6 +104,15 @@ final class KontextInAppWebViewPlatformView: NSObject, FlutterPlatformView, WKNa forMainFrameOnly: false ) ) + if let omsdkJS = KontextInAppWebViewPlatformView.loadOpenMeasurementJavaScript() { + userContentController.addUserScript( + WKUserScript( + source: omsdkJS, + injectionTime: .atDocumentStart, + forMainFrameOnly: true + ) + ) + } userContentController.addUserScript( WKUserScript( source: KontextInAppWebViewPlatformView.makeConsoleShimScript(), @@ -155,6 +179,7 @@ final class KontextInAppWebViewPlatformView: NSObject, FlutterPlatformView, WKNa } deinit { + finishOpenMeasurementSession() webView.configuration.userContentController.removeScriptMessageHandler(forName: kontextNativeBridgeName) webView.configuration.userContentController.removeScriptMessageHandler(forName: kontextConsoleBridgeName) channel.setMethodCallHandler(nil) @@ -179,6 +204,27 @@ final class KontextInAppWebViewPlatformView: NSObject, FlutterPlatformView, WKNa case "loadInitialUrl": loadInitialUrl() result(nil) + case "configureOpenMeasurement": + let args = call.arguments as? [String: Any] + if let creativeType = args?["creativeType"] as? String { + configureOpenMeasurement(creativeType: creativeType) + } else { + omCreativeType = nil + } + result(nil) + case "startOpenMeasurementSession": + startOpenMeasurementSession() + result(nil) + case "logOpenMeasurementError": + let args = call.arguments as? [String: Any] + logOpenMeasurementError( + errorType: args?["errorType"] as? String, + message: args?["message"] as? String + ) + result(nil) + case "finishOpenMeasurementSession": + finishOpenMeasurementSession() + result(nil) default: result(FlutterMethodNotImplemented) } @@ -278,7 +324,10 @@ final class KontextInAppWebViewPlatformView: NSObject, FlutterPlatformView, WKNa } func webView(_ webView: WKWebView, didFinish navigation: WKNavigation!) { + hasLoadedPage = true + lastContentURL = webView.url ?? initialUrl webView.evaluateJavaScript(kontextPlatformReadyScript, completionHandler: nil) + startOpenMeasurementSessionIfReady() } private func sendLoadError(_ error: Error, failingURL: URL?) { @@ -336,6 +385,8 @@ final class KontextInAppWebViewPlatformView: NSObject, FlutterPlatformView, WKNa } guard !hasLoadedInitialUrl else { return } hasLoadedInitialUrl = true + hasLoadedPage = false + lastContentURL = initialUrl guard let initialUrl else { return } webView.load(URLRequest(url: initialUrl)) @@ -428,6 +479,109 @@ final class KontextInAppWebViewPlatformView: NSObject, FlutterPlatformView, WKNa """ } + private func configureOpenMeasurement(creativeType: String) { + omCreativeType = OMCreativeType(rawValue: creativeType) + startOpenMeasurementSessionIfReady() + } + + private func startOpenMeasurementSession() { + pendingOpenMeasurementStart = true + startOpenMeasurementSessionIfReady() + } + + private func startOpenMeasurementSessionIfReady() { + guard activeOMSession == nil else { + return + } + + guard pendingOpenMeasurementStart else { + return + } + + guard let omCreativeType else { + return + } + + guard hasLoadedPage else { + return + } + + guard omService.activate() else { + return + } + + let usesVideoAudioSession = omCreativeType == .video + if usesVideoAudioSession { + omAudioSessionHelper.acquireVideoSession() + } + + do { + let session = try omService.createSession( + webView, + url: lastContentURL ?? webView.url ?? initialUrl, + creativeType: omCreativeType + ) + session.start() + activeOMSession = session + activeOMSessionUsesVideoAudioSession = usesVideoAudioSession + pendingOpenMeasurementStart = false + } catch OMManager.OMError.sdkIsNotActive { + if usesVideoAudioSession { + omAudioSessionHelper.releaseVideoSession() + } + return + } catch { + pendingOpenMeasurementStart = false + if usesVideoAudioSession { + omAudioSessionHelper.releaseVideoSession() + } + } + } + + private func logOpenMeasurementError(errorType: String?, message: String?) { + activeOMSession?.logError(errorType: errorType, message: message) + } + + private func finishOpenMeasurementSession() { + pendingOpenMeasurementStart = false + + guard let activeOMSession else { + return + } + + let usesVideoAudioSession = activeOMSessionUsesVideoAudioSession + self.activeOMSession = nil + activeOMSessionUsesVideoAudioSession = false + activeOMSession.retire() + activeOMSession.finish() + OMRetentionPool.shared.retain(activeOMSession) + if usesVideoAudioSession { + omAudioSessionHelper.releaseVideoSession() + } + } + + private static func loadOpenMeasurementJavaScript() -> String? { + let classBundle = Bundle(for: KontextInAppWebViewPlatformView.self) + let bundleCandidates: [Bundle] = [ + Bundle.main, + classBundle, + classBundle.url(forResource: "kontext_flutter_sdk", withExtension: "bundle").flatMap(Bundle.init(url:)), + Bundle.main.url(forResource: "kontext_flutter_sdk", withExtension: "bundle").flatMap(Bundle.init(url:)) + ].compactMap { $0 } + + for bundle in bundleCandidates { + guard let url = bundle.url(forResource: "omsdk-v1", withExtension: "js") else { + continue + } + + if let source = try? String(contentsOf: url, encoding: .utf8) { + return source + } + } + + return nil + } + private func urlArgument(_ url: URL?) -> Any { url?.absoluteString ?? NSNull() } diff --git a/ios/Classes/KontextSdkPlugin.swift b/ios/Classes/KontextSdkPlugin.swift index 2138ae1b..8808b029 100644 --- a/ios/Classes/KontextSdkPlugin.swift +++ b/ios/Classes/KontextSdkPlugin.swift @@ -15,6 +15,7 @@ public class KontextSdkPlugin: NSObject, FlutterPlugin { SKAdNetworkPlugin.register(with: registrar) SKOverlayPlugin.register(with: registrar) SKStoreProductPlugin.register(with: registrar) + OMSDKPlugin.register(with: registrar) KontextInAppWebViewPlugin.register(with: registrar) } } diff --git a/ios/Classes/OMSDK/OMAudioSessionHelper.swift b/ios/Classes/OMSDK/OMAudioSessionHelper.swift new file mode 100644 index 00000000..56f69aba --- /dev/null +++ b/ios/Classes/OMSDK/OMAudioSessionHelper.swift @@ -0,0 +1,79 @@ +import AVFoundation + +/// Manages AVAudioSession for OMID device volume change tracking in HTML video ads. +/// +/// The OMID native SDK automatically detects device volume changes, but requires +/// an active audio session with `.mixWithOthers` to observe `outputVolume` via KVO. +/// Without this, device volume change events are not delivered to verification scripts. +/// +/// Reference: IAB OMSDK demo WebViewVideoController.swift +final class OMAudioSessionHelper { + /// Shared helper used by all web views in the process. + static let shared = OMAudioSessionHelper() + + private init() {} + + /// Number of active OM video sessions currently holding the shared audio session. + /// + /// Multiple web views can host HTML video ads at the same time. The counter keeps + /// the shared AVAudioSession active until the last tracked video session is released. + private var activeVideoSessionCount = 0 + private var isAudioSessionActive = false + + /// Records a video session that needs OMID device volume change tracking. + /// + /// Activates the shared audio session on the first acquisition. + func acquireVideoSession() { + activeVideoSessionCount += 1 + activateAudioSessionIfNeeded() + } + + /// Releases a previously tracked video session. + /// + /// Deactivates the shared audio session only after the last tracked session ends. + func releaseVideoSession() { + guard activeVideoSessionCount > 0 else { + return + } + + activeVideoSessionCount -= 1 + + guard activeVideoSessionCount == 0 else { + return + } + + deactivateAudioSessionIfNeeded() + } + + private func activateAudioSessionIfNeeded() { + guard !isAudioSessionActive else { + return + } + + let session = AVAudioSession.sharedInstance() + + do { + try session.setCategory(.playback, mode: .default, options: [.mixWithOthers]) + try session.setActive(true) + isAudioSessionActive = true + } catch { + NSLog("[OM] Failed to activate audio session: \(error)") + } + } + + private func deactivateAudioSessionIfNeeded() { + guard isAudioSessionActive else { + return + } + + let session = AVAudioSession.sharedInstance() + + do { + try session.setActive(false, options: [.notifyOthersOnDeactivation]) + } catch { + NSLog("[OM] Failed to deactivate audio session: \(error)") + } + + isAudioSessionActive = false + } +} diff --git a/ios/Classes/OMSDK/OMConstants.swift b/ios/Classes/OMSDK/OMConstants.swift new file mode 100644 index 00000000..58376ff5 --- /dev/null +++ b/ios/Classes/OMSDK/OMConstants.swift @@ -0,0 +1,8 @@ +import Foundation + +enum OMConstants { + static let partnerName = "Kontextso" + static let integrationVersion = "1.0.0" + static let retentionInterval: TimeInterval = 1.0 + static let channelName = "kontext_flutter_sdk/omsdk" +} diff --git a/ios/Classes/OMSDK/OMManager.swift b/ios/Classes/OMSDK/OMManager.swift new file mode 100644 index 00000000..b636e8e1 --- /dev/null +++ b/ios/Classes/OMSDK/OMManager.swift @@ -0,0 +1,108 @@ +import Foundation +import WebKit +@preconcurrency import OMSDK_Kontextso + +enum OMCreativeType: String { + case display + case video +} + +protocol OMManaging: AnyObject { + @discardableResult + func activate() -> Bool + + func createSession( + _ webView: WKWebView, + url: URL?, + creativeType: OMCreativeType + ) throws -> OMSession +} + +final class OMManager: OMManaging { + enum OMError: Error { + case sdkIsNotActive + case partnerIsNotAvailable + case sessionCreationFailed(String) + } + + static let shared = OMManager() + + private init() {} + + private let partner = OMIDKontextsoPartner( + name: OMConstants.partnerName, + versionString: OMConstants.integrationVersion + ) + + @discardableResult + func activate() -> Bool { + if isActive { + return true + } + + OMIDKontextsoSDK.shared.activate() + return isActive + } + + func createSession( + _ webView: WKWebView, + url: URL?, + creativeType: OMCreativeType + ) throws -> OMSession { + guard isActive else { + throw OMError.sdkIsNotActive + } + + guard let partner else { + throw OMError.partnerIsNotAvailable + } + + do { + let context = try OMIDKontextsoAdSessionContext( + partner: partner, + webView: webView, + contentUrl: url?.absoluteString, + customReferenceIdentifier: nil + ) + + let omCreativeType: OMIDCreativeType + let impressionOwner: OMIDOwner + let mediaEventsOwner: OMIDOwner + + switch creativeType { + case .display: + omCreativeType = .htmlDisplay + impressionOwner = .javaScriptOwner + mediaEventsOwner = .noneOwner + case .video: + omCreativeType = .video + impressionOwner = .javaScriptOwner + mediaEventsOwner = .javaScriptOwner + } + + let configuration = try OMIDKontextsoAdSessionConfiguration( + creativeType: omCreativeType, + impressionType: .beginToRender, + impressionOwner: impressionOwner, + mediaEventsOwner: mediaEventsOwner, + isolateVerificationScripts: false + ) + + let session = try OMIDKontextsoAdSession( + configuration: configuration, + adSessionContext: context + ) + session.mainAdView = webView + + return try OMSession(session: session, webView: webView) + } catch { + throw OMError.sessionCreationFailed(error.localizedDescription) + } + } +} + +private extension OMManager { + var isActive: Bool { + OMIDKontextsoSDK.shared.isActive + } +} diff --git a/ios/Classes/OMSDK/OMRetentionPool.swift b/ios/Classes/OMSDK/OMRetentionPool.swift new file mode 100644 index 00000000..70ff869c --- /dev/null +++ b/ios/Classes/OMSDK/OMRetentionPool.swift @@ -0,0 +1,20 @@ +import Foundation + +final class OMRetentionPool { + static let shared = OMRetentionPool() + + private init() {} + + private var retainedSessions: [UUID: OMSession] = [:] + + func retain(_ session: OMSession) { + let id = UUID() + retainedSessions[id] = session + + DispatchQueue.main.asyncAfter( + deadline: .now() + OMConstants.retentionInterval + ) { [weak self] in + self?.retainedSessions.removeValue(forKey: id) + } + } +} diff --git a/ios/Classes/OMSDK/OMSDKPlugin.swift b/ios/Classes/OMSDK/OMSDKPlugin.swift new file mode 100644 index 00000000..2279f656 --- /dev/null +++ b/ios/Classes/OMSDK/OMSDKPlugin.swift @@ -0,0 +1,29 @@ +import Flutter +import Foundation + +final class OMSDKPlugin: NSObject, FlutterPlugin { + private let omService: OMManaging + + init(omService: OMManaging = OMManager.shared) { + self.omService = omService + super.init() + } + + static func register(with registrar: FlutterPluginRegistrar) { + let channel = FlutterMethodChannel( + name: OMConstants.channelName, + binaryMessenger: registrar.messenger() + ) + let plugin = OMSDKPlugin() + registrar.addMethodCallDelegate(plugin, channel: channel) + } + + func handle(_ call: FlutterMethodCall, result: @escaping FlutterResult) { + switch call.method { + case "activate": + result(omService.activate()) + default: + result(FlutterMethodNotImplemented) + } + } +} diff --git a/ios/Classes/OMSDK/OMSession.swift b/ios/Classes/OMSDK/OMSession.swift new file mode 100644 index 00000000..9458312d --- /dev/null +++ b/ios/Classes/OMSDK/OMSession.swift @@ -0,0 +1,35 @@ +import Foundation +import WebKit +@preconcurrency import OMSDK_Kontextso + +final class OMSession { + private let session: OMIDKontextsoAdSession + private let webView: WKWebView + private let adEvents: OMIDKontextsoAdEvents + + init(session: OMIDKontextsoAdSession, webView: WKWebView) throws { + self.session = session + self.webView = webView + self.adEvents = try OMIDKontextsoAdEvents(adSession: session) + } + + func start() { + session.start() + } + + func retire() { + webView.evaluateJavaScript( + "window.postMessage({ type: 'retire-iframe' }, '*');", + completionHandler: nil + ) + } + + func finish() { + session.finish() + } + + func logError(errorType: String?, message: String?) { + let omErrorType: OMIDErrorType = errorType == "video" ? .media : .generic + session.logError(withType: omErrorType, message: message ?? "unknown") + } +} diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/Info.plist b/ios/Frameworks/OMSDK_Kontextso.xcframework/Info.plist new file mode 100644 index 00000000..46ab6181 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/Info.plist @@ -0,0 +1,75 @@ + + + + + AvailableLibraries + + + BinaryPath + OMSDK_Kontextso.framework/OMSDK_Kontextso + LibraryIdentifier + tvos-arm64_x86_64-simulator + LibraryPath + OMSDK_Kontextso.framework + SupportedArchitectures + + arm64 + x86_64 + + SupportedPlatform + tvos + SupportedPlatformVariant + simulator + + + BinaryPath + OMSDK_Kontextso.framework/OMSDK_Kontextso + LibraryIdentifier + tvos-arm64 + LibraryPath + OMSDK_Kontextso.framework + SupportedArchitectures + + arm64 + + SupportedPlatform + tvos + + + BinaryPath + OMSDK_Kontextso.framework/OMSDK_Kontextso + LibraryIdentifier + ios-arm64_x86_64-simulator + LibraryPath + OMSDK_Kontextso.framework + SupportedArchitectures + + arm64 + x86_64 + + SupportedPlatform + ios + SupportedPlatformVariant + simulator + + + BinaryPath + OMSDK_Kontextso.framework/OMSDK_Kontextso + LibraryIdentifier + ios-arm64 + LibraryPath + OMSDK_Kontextso.framework + SupportedArchitectures + + arm64 + + SupportedPlatform + ios + + + CFBundlePackageType + XFWK + XCFrameworkFormatVersion + 1.0 + + diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDAdEvents.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDAdEvents.h new file mode 100644 index 00000000..f54d6533 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDAdEvents.h @@ -0,0 +1,50 @@ +// +// OMIDAdEvents.h +// AppVerificationLibrary +// +// Created by Daria Sukhonosova on 22/06/2017. +// + +#import +#import "OMIDAdSession.h" +#import "OMIDVASTProperties.h" + +/** + * Ad event API enabling the integration partner to signal to all verification providers when key events have occurred. + * Only one ad events implementation can be associated with the ad session and any attempt to create multiple instances will result in an error. + */ +@interface OMIDKontextsoAdEvents : NSObject + +/** + * Initializes ad events instance associated with the supplied ad session. + * + * @param session The ad session associated with the ad events. + * @return A new ad events instance associated with the supplied ad session. Returns nil if the supplied ad session is nil or if an ad events instance has already been registered with the ad session. + */ +- (nullable instancetype)initWithAdSession:(nonnull OMIDKontextsoAdSession *)session error:(NSError * _Nullable * _Nullable)error; + +/** + * Notifies the ad session that an impression event has occurred. + * + * When triggered all registered verification providers will be notified of this event. + * + * NOTE: the ad session will be automatically started if this method has been called first. + */ +- (BOOL)impressionOccurredWithError:(NSError *_Nullable *_Nullable)error; + +/** + * Notifies the ad session that display loaded event has occurred. + * + * When triggered all registered verification providers will be notified of this event. + */ +- (BOOL)loadedWithError:(NSError *_Nullable *_Nullable)error; + +/** + * Notifies the ad session that video/audio loaded event has occurred. + * + * When triggered all registered verification providers will be notified of this event. + * @param vastProperties contains static information about the video/audio placement. + */ +- (BOOL)loadedWithVastProperties:(OMIDKontextsoVASTProperties *_Nonnull)vastProperties + error:(NSError *_Nullable *_Nullable)error; +@end diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDAdSession.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDAdSession.h new file mode 100644 index 00000000..27b540fe --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDAdSession.h @@ -0,0 +1,134 @@ +// +// OMIDAdSession.h +// AppVerificationLibrary +// +// Created by Daria on 06/06/2017. +// + +#import +#import "OMIDAdSessionContext.h" +#import "OMIDAdSessionConfiguration.h" +#import "OMIDFriendlyObstructionType.h" + +NS_ASSUME_NONNULL_BEGIN + +/** + * List of supported error types. + */ +typedef NS_ENUM(NSUInteger, OMIDErrorType) { + /** + * The integration is publishing a "generic" error to verification scripts. + */ + OMIDErrorGeneric = 1, + /** + * The integration is publishing a "video" error to verification scripts. + */ + OMIDErrorMedia = 2 +}; + +/** + * Ad session API enabling the integration partner to notify OMID of key state relating to viewability calculations. + * In addition to viewability this API will also notify all verification providers of key ad session lifecycle events. + */ +@interface OMIDKontextsoAdSession : NSObject + +/** + * The AdSession configuration is used for check owners. + */ +@property(nonatomic, readonly) OMIDKontextsoAdSessionConfiguration *configuration; +/** + * The native view which is used for viewability tracking. + */ +@property(nonatomic, weak, nullable) UIView *mainAdView; + +/** + * Initializes new ad session supplying the context. + * + * Note that creating an OMIDAdSession sends a message to the OM SDK JS Service running in the + * webview. If the OM SDK JS Service has not loaded before the ad session is created, the + * message is lost, and the verification scripts will not receive any events. + * + * To prevent this, the implementation must wait until the webview finishes loading OM SDK + * JavaScript before creating the OMIDAdSession. The easiest way is to create the OMIDAdSession + * in a webview delegate callback (-[WKNavigationDelegate webView:didFinishNavigation:]. Alternatively, + * if an implementation can receive an HTML5 DOMContentLoaded event from the webview, it can create + * the OMIDAdSession in a message handler for that event. + * + * @param context The context that provides the required information for initialising the ad session. + * @return A new OMIDAdSession instance, or nil if the supplied context is nil. + */ +- (nullable instancetype)initWithConfiguration:(OMIDKontextsoAdSessionConfiguration *)configuration + adSessionContext:(OMIDKontextsoAdSessionContext *)context + error:(NSError *_Nullable *_Nullable)error; + + +/** + * Notifies all verification providers that the ad session has started and ad view tracking will begin. + * + * This method will have no affect if called after the ad session has finished. + */ +- (void)start; + +/** + * Notifies all verification providers that the ad session has finished and all ad view tracking will stop. + * + * This method will have no affect if called after the ad session has finished. + * + * Note that ending an OMID ad session sends a message to the verification scripts running inside + * the webview supplied by the integration. So that the verification scripts have enough time to + * handle the 'sessionFinish' event, the integration must maintain a strong reference to the webview + * for at least 1.0 seconds after ending the session. + */ +- (void)finish; + +/** + * Adds friendly obstruction which should then be excluded from all ad session viewability calculations. + * It also provides a purpose and detailed reason string to pass forward to the measurement vendors. + * + * This method will have no affect if called after the ad session has finished. + * + * @param friendlyObstruction The view to be excluded from all ad session viewability calculations. + * @param purpose The purpose of why this obstruction was necessary. + * @param detailedReason An explanation for why this obstruction is part of the ad experience if not already + * obvious from the purpose. Can be nil. If not nil, must be 50 characters or less and only contain characers + * `A-z`, `0-9`, or spaces. + * @return Whether this friendly obstruction was successfully added. If the session has finished or the + * friendlyObstruction has already been added for this session, this method will return NO with no associated + * error object. However, if one or more arguments are against requirements, it will return NO with an error + * object assigned. + */ +- (BOOL)addFriendlyObstruction:(UIView *)friendlyObstruction + purpose:(OMIDFriendlyObstructionType)purpose + detailedReason:(nullable NSString *)detailedReason + error:(NSError *_Nullable *_Nullable)error; + +/** + * Removes registered friendly obstruction. + * + * This method will have no affect if called after the ad session has finished. + * + * @param friendlyObstruction The view to be removed from the list of registered friendly obstructions. + */ +- (void)removeFriendlyObstruction:(UIView *)friendlyObstruction; + +/** + * Utility method to remove all registered friendly obstructions. + * + * This method will have no affect if called after the ad session has finished. + */ +- (void)removeAllFriendlyObstructions; + +/** + * Notifies the ad session that an error has occurred. + * + * When triggered all registered verification providers will be notified of this event. + * + * @param errorType The type of error. + * @param message The message containing details of the error. + */ +- (void)logErrorWithType:(OMIDErrorType)errorType message:(NSString *)message +NS_SWIFT_NAME(logError(withType:message:)); + +@end + +NS_ASSUME_NONNULL_END diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDAdSessionConfiguration.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDAdSessionConfiguration.h new file mode 100644 index 00000000..099bf14a --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDAdSessionConfiguration.h @@ -0,0 +1,135 @@ +// +// OMIDAdSessionConfiguration.h +// AppVerificationLibrary +// +// Created by Saraev Vyacheslav on 15/09/2017. +// + +#import + +/** + * Identifies which integration layer is responsible for sending certain events. + */ +typedef NS_ENUM(NSUInteger, OMIDOwner) { + /** The integration will send the event from a JavaScript session script. */ + OMIDJavaScriptOwner = 1, + /** The integration will send the event from the native layer. */ + OMIDNativeOwner = 2, + /** The integration will not send the event. */ + OMIDNoneOwner = 3 +}; + + +/** + * List of supported creative types. + */ +typedef NS_ENUM(NSUInteger, OMIDCreativeType) { + /** + * Creative type will be set by JavaScript session script. + * Integrations must also pass `OMIDJavaScriptOwner` for `impressionOwner`. + */ + OMIDCreativeTypeDefinedByJavaScript = 1, + // Remaining values set creative type in native layer. + /** + * Rendered in webview, verification code can be inside creative or in metadata. + */ + OMIDCreativeTypeHtmlDisplay = 2, + /** + * Rendered by native, verification code provided in metadata only. + */ + OMIDCreativeTypeNativeDisplay = 3, + /** + * Rendered instream or as standalone video, verification code provided in metadata. + */ + OMIDCreativeTypeVideo = 4, + /** + * Similar to video but only contains audio media. + */ + OMIDCreativeTypeAudio = 5 +}; + +/** + * The criterion for an ad session's OMID impression event. + * Declaring an impression type makes it easier to understand discrepancies between measurers + * of the ad session, since many metrics depend on impressions. + */ +typedef NS_ENUM(NSUInteger, OMIDImpressionType) { + /** + * ImpressionType will be set by JavaScript session script. + * Integrations must also pass `OMIDJavaScriptOwner` for `impressionOwner`. + */ + OMIDImpressionTypeDefinedByJavaScript = 1, + // Remaining values set ImpressionType in native layer. + /** + * The integration is not declaring the criteria for the OMID impression. + */ + OMIDImpressionTypeUnspecified = 2, + /** + * The integration is using count-on-download criteria for the OMID impression. + */ + OMIDImpressionTypeLoaded = 3, + /** + * The integration is using begin-to-render criteria for the OMID impression. + */ + OMIDImpressionTypeBeginToRender = 4, + /** + * The integration is using one-pixel criteria (when the creative has at least 1 visible pixel on + * screen) for the OMID impression. + */ + OMIDImpressionTypeOnePixel = 5, + /** + * The integration is using viewable criteria (1 second for display, 2 seconds while playing for + * video, and at least 50% of the creative is visible) for the OMID impression. + */ + OMIDImpressionTypeViewable = 6, + /** + * The integration is using audible criteria (2 continuous second of media playback with non-zero + * volume) for the OMID impression. + */ + OMIDImpressionTypeAudible = 7, + /** + * The integration's criteria uses none of the above criteria for the OMID impression. + */ + OMIDImpressionTypeOther = 8 +}; + +/** + * The ad session configuration supplies the owner for both the impression and video events. + * The OM SDK JS service will use this information to help identify where the source of these + * events is expected to be received. + */ +@interface OMIDKontextsoAdSessionConfiguration : NSObject + +@property OMIDCreativeType creativeType; +@property OMIDImpressionType impressionType; +@property OMIDOwner impressionOwner; +@property OMIDOwner mediaEventsOwner; +@property BOOL isolateVerificationScripts; + +/** + * Create new ad session configuration supplying the owner for both the impression and media + * events along with the type of creative being rendered/measured. + * The OM SDK JS service will use this information to help identify where the source of these + * events is expected to be received. + * @param creativeType the type of creative to be rendered in this session. + * @param impressionType the type of impression to be triggered in this session. + * @param impressionOwner whether the native or JavaScript layer should be responsible for supplying + * the impression event. + * @param mediaEventsOwner whether the native or JavaScript layer should be responsible for + * supplying media events. This needs to be set only for non-display ad sessions and can be set to + * `OMIDNoneOwner` for display. When the creativeType is `OMIDCreativeTypeDefinedByJavaScript` then + * this should be set to `OMIDJavaScriptOwner` + * @param isolateVerificationScripts determines whether verification scripts will be placed in a + * sandboxed environment. This will not have any effect for native sessions. + * @return A new session configuration instance. Returns nil and sets error if OM SDK isn't active + * or arguments are invalid. + */ +- (nullable instancetype)initWithCreativeType:(OMIDCreativeType)creativeType + impressionType:(OMIDImpressionType)impressionType + impressionOwner:(OMIDOwner)impressionOwner + mediaEventsOwner:(OMIDOwner)mediaEventsOwner + isolateVerificationScripts:(BOOL)isolateVerificationScripts + error:(NSError *_Nullable *_Nullable)error; + +@end + diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDAdSessionContext.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDAdSessionContext.h new file mode 100644 index 00000000..e31cbf1c --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDAdSessionContext.h @@ -0,0 +1,126 @@ +// +// Created by Daria Sukhonosova on 19/04/16. +// + +#import + +#if !(TARGET_OS_TV) +#import +#endif + +#import "OMIDPartner.h" +#import "OMIDUniversalAdID.h" +#import "OMIDVerificationScriptResource.h" + +NS_ASSUME_NONNULL_BEGIN + +/** + * Provides the ad session with details of the partner and whether to an HTML, + * JavaScript, or native session. + */ +@interface OMIDKontextsoAdSessionContext : NSObject + +- (null_unspecified instancetype)init NS_UNAVAILABLE; + +#if !(TARGET_OS_TV) + +/** + * Initializes a new ad session context providing reference to partner and web view where + * the OM SDK JavaScript service has been injected. + * + * Calling this method will set the ad session type to `html`. + *

+ * NOTE: any attempt to create a new ad session will fail if OM SDK has not been + * activated (see {@link OMIDSDK} class for more information). + * + * @param partner Details of the integration partner responsible for the ad session. + * @param webView The WKWebView responsible for serving the ad content. The receiver holds a weak reference only. + * @param contentUrl contains the universal link to the ad's screen. + * @return A new HTML context instance. Returns nil if OM SDK has not been activated or if + * any of the parameters are nil. + * @see OMIDSDK + */ +- (nullable instancetype)initWithPartner:(OMIDKontextsoPartner *)partner + webView:(WKWebView *)webView + contentUrl:(nullable NSString *)contentUrl + customReferenceIdentifier:(nullable NSString *)customReferenceIdentifier + error:(NSError *_Nullable *_Nullable)error; +#endif + +/** + * Initializes a new ad session context providing reference to partner and a list of + * script resources which should be managed by OMID. + * + * Calling this method will set the ad session type to `native`. + *

+ * NOTE: any attempt to create a new ad session will fail if OMID has not been activated + * (see {@link OMIDSDK} class for more information). + * + * @param partner Details of the integration partner responsible for the ad session. + * @param resources The array of all verification providers who expect to receive OMID + * event data. Must contain at least one verification script. The receiver creates a + * deep copy of the array. + * @param contentUrl contains the universal link to the ad's screen. + * @return A new native context instance. Returns nil if OMID has not been activated or if any of the parameters are invalid. + * @see OMIDSDK + */ +- (nullable instancetype)initWithPartner:(OMIDKontextsoPartner *)partner + script:(NSString *)script + resources:(NSArray *)resources + contentUrl:(nullable NSString *)contentUrl + customReferenceIdentifier:(nullable NSString *)customReferenceIdentifier + error:(NSError *_Nullable *_Nullable)error; + +/** + * Initializes a new ad session context providing reference to partner, an optional universalAdID and a list of + * script resources which should be managed by OMID. + * + * Calling this method will set the ad session type to `native`. + *

+ * NOTE: any attempt to create a new ad session will fail if OMID has not been activated + * (see {@link OMIDSDK} class for more information). + * + * @param partner Details of the integration partner responsible for the ad session. + * @param resources The array of all verification providers who expect to receive OMID + * event data. Must contain at least one verification script. The receiver creates a + * deep copy of the array. + * @param contentUrl contains the universal link to the ad's screen. + * @param universalAdID optional identifier for an ad creative. See {@link OMIDUniversalAdID} class for more information. + * @return A new native context instance. Returns nil if OMID has not been activated or if any of the required parameters are invalid. + * @see OMIDSDK + */ +- (nullable instancetype)initWithPartner:(OMIDKontextsoPartner *)partner + script:(NSString *)script + resources:(NSArray *)resources + contentUrl:(nullable NSString *)contentUrl + customReferenceIdentifier:(nullable NSString *)customReferenceIdentifier + universalAdID:(nullable OMIDKontextsoUniversalAdID *)universalAdID + error:(NSError *_Nullable *_Nullable)error; + +#if !(TARGET_OS_TV) +/** + * Initializes a new ad session context providing reference to partner and web view where + * OM SDK JavaScript service has been injected. + * + * Calling this method will set the ad session type to `javascript`. + *

+ * NOTE: any attempt to create a new ad session will fail if OMID has not been activated + * (see {@link OMIDSDK} class for more information). + * + * @param partner Details of the integration partner responsible for the ad session. + * @param webView The WKWebView responsible for serving the ad content. The receiver holds a weak reference only. + * @param contentUrl contains the universal link to the ad's screen. + * @return A new JavaScript context instance. Returns nil if OM SDK has not been + * activated or if any of the parameters are invalid. + * @see OMIDSDK + */ +- (nullable instancetype)initWithPartner:(OMIDKontextsoPartner *)partner + javaScriptWebView:(WKWebView *)webView + contentUrl:(nullable NSString *)contentUrl + customReferenceIdentifier:(nullable NSString *)customReferenceIdentifier + error:(NSError *_Nullable *_Nullable)error; +#endif + +@end + +NS_ASSUME_NONNULL_END diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDFriendlyObstructionType.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDFriendlyObstructionType.h new file mode 100644 index 00000000..ee7bc6ac --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDFriendlyObstructionType.h @@ -0,0 +1,30 @@ +// +// OMIDFriendlyObstructionType.h +// AppVerificationLibrary +// +// Created by Andrew Whitcomb on 4/3/19. +// Copyright © 2019 Integral Ad Science, Inc. All rights reserved. +// + +/** + * List of allowed friendly obstruction purposes. + */ +typedef NS_ENUM(NSUInteger, OMIDFriendlyObstructionType) { + /** + * The friendly obstruction relates to interacting with a video (such as play/pause buttons). + */ + OMIDFriendlyObstructionMediaControls, + /** + * The friendly obstruction relates to closing an ad (such as a close button). + */ + OMIDFriendlyObstructionCloseAd, + /** + * The friendly obstruction is not visibly obstructing the ad but may seem so due to technical + * limitations. + */ + OMIDFriendlyObstructionNotVisible, + /** + * The friendly obstruction is obstructing for any purpose not already described. + */ + OMIDFriendlyObstructionOther +}; diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDImports.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDImports.h new file mode 100644 index 00000000..cec63730 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDImports.h @@ -0,0 +1,10 @@ +#import "OMIDSDK.h" +#import "OMIDScriptInjector.h" +#import "OMIDPartner.h" +#import "OMIDVerificationScriptResource.h" +#import "OMIDAdSessionContext.h" +#import "OMIDAdSession.h" +#import "OMIDAdEvents.h" +#import "OMIDVASTProperties.h" +#import "OMIDMediaEvents.h" +#import "OMIDJavaScriptSessionService.h" diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDJavaScriptSessionService.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDJavaScriptSessionService.h new file mode 100644 index 00000000..4bd74871 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDJavaScriptSessionService.h @@ -0,0 +1,109 @@ +#include +#if !(TARGET_OS_TV) + +#import +#import +#import "OMIDFriendlyObstructionType.h" +#import "OMIDPartner.h" + +NS_ASSUME_NONNULL_BEGIN + +/** + * Service supporting ad sessions managed (started/finished) via JavaScript Session Client APIs + * by providing native-layer measurement signals. + * If the JS Session Client is running in a web view, an instance of this service must be + * initialized with the web view before starting or finishing ad sessions using JS APIs. + * Only one instance of this service may be initialized at a time for a given web view; to reuse a + * web view the current instance must be torn down (see `tearDownWithCompletion`). + */ +@interface OMIDKontextsoJavaScriptSessionService : NSObject + +/** + * Initializes an instance of the service. + * + * @param partner Details of the integration partner responsible for ad sessions. + * @param webView The web view responsible for starting/finishing ad sessions via the JS Session + * Client. + * @param isHTMLAdView Whether the ad is rendered in HTML inside of the provided web view. + * If true, all ad sessions will be of type "html" and calling `setAdView` is + * not required. + * If false, all ad sessions will be of type "javascript" and `setAdView` must + * be called after initialization. + */ +- (nullable instancetype)initWithPartner:(OMIDKontextsoPartner *)partner + webView:(WKWebView *)webView + isHTMLAdView:(BOOL)isHTMLAdView + error:(NSError *_Nullable *_Nullable)error; + +/** + * Tears down this instance of the service. + * Calling this method will cause OM SDK to begin a teardown process including finishing all currently + * active ad sessions measured by this service instance and tearing down communication with the OM + * SDK's JavaScript layer running in the web view. + * This may require up to one second, for example in order to allow verification scripts time to process + * the `sessionFinish` event. + * Once this process has completed, the web view may be torn down or reused for another instance of + * the service without any adverse effects. If there is no need to tear down or reuse the web view, this + * method is not required. + * @param completionBlock Invoked by OM SDK after the teardown process has completed, + * or one second, whichever comes sooner. + */ +- (void)tearDownWithCompletion:(void (^)(BOOL success, NSError *_Nullable error))completionBlock; + +/** + * The native view containing the ad. + * This property is readonly and must be set using `setAdView`. + * If `isHTMLAdView` was passed as true in `initWithPartner`, this will equal + * the web view by default. + */ +@property(readonly, nonatomic, weak) UIView *adView; + +/** + * Sets the native view that contains the ad and is used for viewability tracking. + * If `isHTMLAdView` was passed as true in `initWithPartner`, this method is + * not required since the ad view will be set to the web view by default. + * @param adView The native view. + * @return Whether the ad view was successfully set. + */ +- (BOOL)setAdView:(nullable UIView *)adView + error:(NSError **)error; + +/** + * Adds a friendly obstruction which should then be excluded from all ad session viewability + * calculations. While this instance of OMIDJavaScriptSessionService is running, this friendly + * obstruction will be added to each ad session started by the integrator via the JS Session Client + * until the obstruction is removed by calling `removeFriendlyObstruction` or + * `removeAllFriendlyObstructions`. + * + * @param friendlyObstruction The view to be excluded from all ad session viewability calculations. + * @param purpose The purpose of why this obstruction was necessary. + * @param detailedReason An explanation for why this obstruction is part of the ad experience if not + * already obvious from the purpose. Can be nil. If not nil, must be 50 characters or less and only + * contain characters `A-z`, `0-9`, or spaces. + * @return Whether this friendly obstruction was successfully added. If the friendlyObstruction has + * already been added for this session, this method will return NO with no associated error object. + * However, if one or more arguments are against requirements, it will return NO with an error + * object assigned. + */ +- (BOOL)addFriendlyObstruction:(UIView *)friendlyObstruction + purpose:(OMIDFriendlyObstructionType)purpose + detailedReason:(nullable NSString *)detailedReason + error:(NSError *_Nullable *_Nullable)error; + +/** + * Removes a registered friendly obstruction from any currently running and future ad sessions + * measured by this instance of OMIDJavaScriptSessionService. + */ +- (void)removeFriendlyObstruction:(UIView *)friendlyObstruction; + +/** + * Removes all registered friendly obstructions from any currently running and future ad sessions + * measured by this instance of OMIDJavaScriptSessionService. + */ +- (void)removeAllFriendlyObstructions; + +@end + +NS_ASSUME_NONNULL_END + +#endif diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDMediaEvents.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDMediaEvents.h new file mode 100644 index 00000000..76f3cca6 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDMediaEvents.h @@ -0,0 +1,155 @@ +// +// OMIDMediaEvents.h +// AppVerificationLibrary +// +// Created by Justin Hines on 6/13/19. +// + +#import +#import "OMIDAdSession.h" +#import "OMIDVASTProperties.h" + +/** + * List of supported media event player states. + */ +typedef NS_ENUM(NSUInteger, OMIDPlayerState) { + /** + * The player is collapsed in such a way that the video is hidden. + * The video may or may not still be progressing in this state, and sound may be audible. + * This refers specifically to the video player state on the page, and not the state of + * the browser window. + */ + OMIDPlayerStateMinimized, + /** + * The player has been reduced from its original size. + * The video is still potentially visible. + */ + OMIDPlayerStateCollapsed, + /** + * The player's default playback size. + */ + OMIDPlayerStateNormal, + /** + * The player has expanded from its original size. + */ + OMIDPlayerStateExpanded, + /** + * The player has entered fullscreen mode. + */ + OMIDPlayerStateFullscreen +}; + +/** + * List of supported media event user interaction types. + */ +typedef NS_ENUM(NSUInteger, OMIDInteractionType) { + /** + * The user clicked to load the ad's landing page. + */ + OMIDInteractionTypeClick, + /** + * The user engaged with ad content to load a separate experience. + */ + OMIDInteractionTypeAcceptInvitation +}; + +/** + * This provides a complete list of native media events supported by OMID. + * Using this event API assumes the media player is fully responsible for communicating all media events at the appropriate times. + * Only one media events implementation can be associated with the ad session and any attempt to create multiple instances will result in an error. + */ +@interface OMIDKontextsoMediaEvents : NSObject + +/** + * Initializes media events instance for the associated ad session. + * Any attempt to create a media events instance will fail if the supplied ad session has already started. + * + * @param session The ad session associated with the ad events. + * @return A new media events instance. Returns nil if the supplied ad session is nil or if a media events instance has already been registered with the ad session or if a media events instance has been created after the ad session has started. + * @see OMIDAdSession + */ +- (nullable instancetype)initWithAdSession:(nonnull OMIDKontextsoAdSession *)session error:(NSError *_Nullable *_Nullable)error; + +/** + * Notifies all media listeners that media content has started playing. + * + * @param duration The duration of the selected media (in seconds). + * @param mediaPlayerVolume The volume from the native media player with a range between 0 and 1. + */ +- (void)startWithDuration:(CGFloat)duration + mediaPlayerVolume:(CGFloat)mediaPlayerVolume; + +/** + * Notifies all media listeners that media playback has reached the first quartile. + */ +- (void)firstQuartile; + +/** + * Notifies all media listeners that media playback has reached the midpoint. + */ +- (void)midpoint; + +/** + * Notifies all media listeners that media playback has reached the third quartile. + */ +- (void)thirdQuartile; + +/** + * Notifies all media listeners that media playback is complete. + */ +- (void)complete; + +/** + * Notifies all media listeners that media playback has paused after a user interaction. + */ +- (void)pause; + +/** + * Notifies all media listeners that media playback has resumed after being paused. + */ +- (void)resume; + +/** + * Notifies all media listeners that media playback has stopped as a user skip interaction. + * Once skipped, it should not be possible for the media to resume playing content. + */ +- (void)skipped; + +/** + * Notifies all media listeners that media playback has stopped and started buffering. + */ +- (void)bufferStart; + +/** + * Notifies all media listeners that buffering has finished and media playback has resumed. + */ +- (void)bufferFinish; + +/** + * Notifies all media listeners that the media player volume has changed. + * + * @param playerVolume The volume from the native media player with a range between 0 and 1. + */ +- (void)volumeChangeTo:(CGFloat)playerVolume; + +/** + * Notifies all media listeners that media player state has changed. + * See `OMIDPlayerState` for list of supported states. + * + * @param playerState The latest media player state. + * @see OMIDPlayerState + */ +- (void)playerStateChangeTo:(OMIDPlayerState)playerState; + +/** + * Notifies all media listeners that the user has performed an ad interaction. + * See `OMIDInteractionType` for a list of supported types. + * + * @param interactionType The latest user integration. + * @see OMIDInteractionType + */ +- (void)adUserInteractionWithType:(OMIDInteractionType)interactionType +NS_SWIFT_NAME(adUserInteraction(withType:)); + +@end + diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDPartner.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDPartner.h new file mode 100644 index 00000000..b54556dc --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDPartner.h @@ -0,0 +1,32 @@ +// +// OMIDPartner.h +// AppVerificationLibrary +// +// Created by Daria on 06/06/2017. +// + +#import + +/** + * Details about the integration partner which will be supplied to the ad session. + */ +@interface OMIDKontextsoPartner : NSObject + +@property(nonatomic, readonly, nonnull) NSString *name; +@property(nonatomic, readonly, nonnull) NSString *versionString; + +/** + * Initializes new partner instance providing both name and versionString. + * + * Both name and version are mandatory. + * + * @param name It is used to uniquely identify the integration partner. + * @param versionString It is used to uniquely identify the integration partner. + * @return A new partner instance, or nil if any of the parameters are either null or blank + */ +- (nullable instancetype)initWithName:(nonnull NSString *)name + versionString:(nonnull NSString *)versionString; + +- (null_unspecified instancetype)init NS_UNAVAILABLE; + +@end diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDSDK.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDSDK.h new file mode 100644 index 00000000..daa9820b --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDSDK.h @@ -0,0 +1,58 @@ +// +// OMIDSDK.h +// AppVerificationLibrary +// +// Created by Daria on 05/06/2017. +// + +#import + +NS_ASSUME_NONNULL_BEGIN + +/** + * This application level class will be called by all integration partners to ensure OM SDK has been activated before calling any other API methods. + * Any attempt to use other API methods prior to activation will result in an error. + * + * Note that OM SDK may only be used on the main UI thread. + * Make sure you are on the main thread when you initialize the SDK, create its + * objects, and invoke its methods. + */ +@interface OMIDKontextsoSDK : NSObject + +/** + * The current semantic version of the integrated OMID library. + */ ++ (NSString *)versionString; + +/** + * Shared OMIDSDK instance. + */ +@property(class, readonly) OMIDKontextsoSDK *sharedInstance +NS_SWIFT_NAME(shared); + +/** + * A Boolean value indicating whether OM SDK has been activated. + * + * @discussion Check that OM SDK is active prior to creating any ad sessions. + */ +@property(atomic, readonly, getter=isActive) BOOL active; + +/** + * Activate OM SDK before calling other API methods. + * + * @discussion Activation sets up the OM SDK environment. In CTV apps (running tvOS), `activate` should be called on launch in + * order to capture a "last activity" timestamp on launch and each time the user foregrounds the app). + * + * @return Boolean indicating success. + */ +- (BOOL)activate; + +/** + * Update the last activity time + * After activating OM SDK in CTV apps, refresh the "last activity" timestamp in response to user input prior to starting an ad session. + */ +- (void)updateLastActivity; + +@end + +NS_ASSUME_NONNULL_END diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDScriptInjector.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDScriptInjector.h new file mode 100644 index 00000000..f6dd4572 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDScriptInjector.h @@ -0,0 +1,26 @@ +// +// OMIDScriptInjector.h +// AppVerificationLibrary +// +// Created by Daria on 21/06/2017. +// + +#import + +/** + * Utility class which enables integration partners to use a standard approach for injecting OM SDK JS into the served tag HTML content. + */ +@interface OMIDKontextsoScriptInjector : NSObject + +/* + Injects the downloaded OMID JS content into the served HTML. + @param scriptContent containing the OMID JS service content to be injected into the hidden tracking web view. + @param html of the tag content which should be modified to include the downloaded OMID JS content. + @param error If an error occurs, contains an NSError object. + @return modified HTML including OMID JS or nil if an error occurs. + */ ++ (nullable NSString *)injectScriptContent:(nonnull NSString *)scriptContent + intoHTML:(nonnull NSString *)html + error:(NSError *_Nullable *_Nullable)error; + +@end diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDUniversalAdID.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDUniversalAdID.h new file mode 100644 index 00000000..25fb50d5 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDUniversalAdID.h @@ -0,0 +1,40 @@ +// +// OMIDUniversalAdID.h +// AppVerificationLibrary +// +// Created by Teodor Cristea on 31.03.2025. +// Copyright © 2025 IAB Techlab. All rights reserved. +// + +#import + +NS_ASSUME_NONNULL_BEGIN + +/** + * Details about the UniversalAdID for the purpose of tracking ad creatives which will be supplied to the ad session. + */ +@interface OMIDKontextsoUniversalAdID : NSObject + +@property(nonatomic, readonly, nonnull) NSString *value; +@property(nonatomic, readonly, nonnull) NSString *idRegistry; + +/** + * Initializes new UniversalAdID instance providing both value and idRegistry. + * The UniversalAdID's purpose is to identify an ad creative across different platforms throughout the lifecycle of an advertising campaign. + * + * Both value and idRegistry are mandatory. + * + * @param value It is used to identify the unique creative identifier. + * @param idRegistry It is used to identify the URL for the registry website where the unique creative ID is cataloged. + * @return A new UniversalAdID instance, or nil if any of the parameters are either null or blank + */ +- (nullable instancetype)initWithValue:(nonnull NSString *)value + idRegistry:(nonnull NSString *)idRegistry + error:(NSError *_Nullable *_Nullable)error; + ++ (instancetype)new NS_UNAVAILABLE; +- (null_unspecified instancetype)init NS_UNAVAILABLE; + +@end + +NS_ASSUME_NONNULL_END diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDVASTProperties.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDVASTProperties.h new file mode 100644 index 00000000..5874fbd1 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDVASTProperties.h @@ -0,0 +1,71 @@ +// +// OMIDVASTProperties.h +// AppVerificationLibrary +// +// Created by Daria Sukhonosova on 30/06/2017. +// + +#import + +/** + * List of supported media player positions. + */ +typedef NS_ENUM(NSUInteger, OMIDPosition) { + /** + * The ad plays preceding video content. + */ + OMIDPositionPreroll, + /** + * The ad plays in the middle of video content, or between two separate content videos. + */ + OMIDPositionMidroll, + /** + * The ad plays following video content. + */ + OMIDPositionPostroll, + /** + * The ad plays independently of any video content. + */ + OMIDPositionStandalone +}; + +/** + * This object is used to capture key VAST properties so this can be shared with all registered verification providers. + */ +@interface OMIDKontextsoVASTProperties : NSObject + +@property(nonatomic, readonly, getter = isSkippable) BOOL skippable; +@property(nonatomic, readonly) CGFloat skipOffset; +@property(nonatomic, readonly, getter = isAutoPlay) BOOL autoPlay; +@property(nonatomic, readonly) OMIDPosition position; + +/** + * This method enables the media player to create a new VAST properties instance for skippable media ad placement. + * + * @param skipOffset The number of seconds before the skip button is presented. + * @param autoPlay Determines whether the media will auto-play content. + * @param position The position of the media in relation to other content. + * @return A new instance of VAST properties. + */ +- (nonnull instancetype)initWithSkipOffset:(CGFloat)skipOffset + autoPlay:(BOOL)autoPlay + position:(OMIDPosition)position; + +/** + * This method enables the media player to create a new VAST properties instance for non-skippable media ad placement. + * + * @param autoPlay Determines whether the media will auto-play content. + * @param position The position of the media in relation to other content. + * @return A new instance of VAST properties. + */ +- (nonnull instancetype)initWithAutoPlay:(BOOL)autoPlay + position:(OMIDPosition)position; + +- (null_unspecified instancetype)init NS_UNAVAILABLE; + +/** + * For OM SDK internal use only. + */ +- (NSDictionary *_Nonnull)toJSON; + +@end diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDVerificationScriptResource.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDVerificationScriptResource.h new file mode 100644 index 00000000..c43451a3 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMIDVerificationScriptResource.h @@ -0,0 +1,45 @@ +// +// OMIDVerificationScriptResource.h +// AppVerificationLibrary +// +// Created by Daria on 06/06/2017. +// + +#import + +/** + * Details about the verification provider which will be supplied to the ad session. + */ +@interface OMIDKontextsoVerificationScriptResource : NSObject + +@property(nonatomic, readonly, nonnull) NSURL *URL; +@property(nonatomic, readonly, nullable) NSString *vendorKey; +@property(nonatomic, readonly, nullable) NSString *parameters; + +/** + * Initializes new verification script resource instance which requires vendor specific verification parameters. + * + * When calling this method all arguments are mandatory. + * + * @param vendorKey It is used to uniquely identify the verification provider. + * @param URL The URL to be injected into the OMID managed JavaScript execution environment. + * @param parameters The parameters which the verification provider script is expecting for the ad session. + * @return A new verification script resource instance, or nil if any of the parameters are either null or blank. + */ +- (nullable instancetype)initWithURL:(nonnull NSURL *)URL + vendorKey:(nonnull NSString *)vendorKey + parameters:(nonnull NSString *)parameters; + +/** + * Initializes new verification script resource instance which does not require any vendor specific verification parameters. + * + * When calling this method all arguments are mandatory. + * + * @param URL The URL to be injected into the OMID managed JavaScript execution environment. + * @return A new verification script resource instance, or nil if URL is nil or blank. + */ +- (nullable instancetype)initWithURL:(nonnull NSURL *)URL; + +- (null_unspecified instancetype)init NS_UNAVAILABLE; + +@end diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMSDK.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMSDK.h new file mode 100644 index 00000000..bc3714ad --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Headers/OMSDK.h @@ -0,0 +1,18 @@ +// +// OMSDK.h +// OMSDK +// +// Created by Nathanael Hardy on 10/16/20. +// + +#import + +//! Project version number for OMSDK. +FOUNDATION_EXPORT double OMSDKVersionNumber; + +//! Project version string for OMSDK. +FOUNDATION_EXPORT const unsigned char OMSDKVersionString[]; + +// In this header, you should import all the public headers of your framework using statements like #import + +#import diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Info.plist b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Info.plist new file mode 100644 index 00000000..cd19d79e Binary files /dev/null and b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Info.plist differ diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Modules/module.modulemap b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Modules/module.modulemap new file mode 100644 index 00000000..078b6857 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/Modules/module.modulemap @@ -0,0 +1,4 @@ +module OMSDK_Kontextso { + header "Headers/OMIDImports.h" + export * +} diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/OMSDK_Kontextso b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/OMSDK_Kontextso new file mode 100755 index 00000000..c9ca07a8 Binary files /dev/null and b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/OMSDK_Kontextso differ diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/PrivacyInfo.xcprivacy b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/PrivacyInfo.xcprivacy new file mode 100644 index 00000000..5ab7e387 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64/OMSDK_Kontextso.framework/PrivacyInfo.xcprivacy @@ -0,0 +1,42 @@ + + + + + + NSPrivacyCollectedDataTypes + + + NSPrivacyCollectedDataType + NSPrivacyCollectedDataTypeProductInteraction + NSPrivacyCollectedDataTypeLinked + + NSPrivacyCollectedDataTypeTracking + + NSPrivacyCollectedDataTypePurposes + + NSPrivacyCollectedDataTypePurposeThirdPartyAdvertising + NSPrivacyCollectedDataTypePurposeDeveloperAdvertising + + + + NSPrivacyCollectedDataType + NSPrivacyCollectedDataTypeAdvertisingData + NSPrivacyCollectedDataTypeLinked + + NSPrivacyCollectedDataTypeTracking + + NSPrivacyCollectedDataTypePurposes + + NSPrivacyCollectedDataTypePurposeThirdPartyAdvertising + NSPrivacyCollectedDataTypePurposeDeveloperAdvertising + + + + + diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDAdEvents.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDAdEvents.h new file mode 100644 index 00000000..f54d6533 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDAdEvents.h @@ -0,0 +1,50 @@ +// +// OMIDAdEvents.h +// AppVerificationLibrary +// +// Created by Daria Sukhonosova on 22/06/2017. +// + +#import +#import "OMIDAdSession.h" +#import "OMIDVASTProperties.h" + +/** + * Ad event API enabling the integration partner to signal to all verification providers when key events have occurred. + * Only one ad events implementation can be associated with the ad session and any attempt to create multiple instances will result in an error. + */ +@interface OMIDKontextsoAdEvents : NSObject + +/** + * Initializes ad events instance associated with the supplied ad session. + * + * @param session The ad session associated with the ad events. + * @return A new ad events instance associated with the supplied ad session. Returns nil if the supplied ad session is nil or if an ad events instance has already been registered with the ad session. + */ +- (nullable instancetype)initWithAdSession:(nonnull OMIDKontextsoAdSession *)session error:(NSError * _Nullable * _Nullable)error; + +/** + * Notifies the ad session that an impression event has occurred. + * + * When triggered all registered verification providers will be notified of this event. + * + * NOTE: the ad session will be automatically started if this method has been called first. + */ +- (BOOL)impressionOccurredWithError:(NSError *_Nullable *_Nullable)error; + +/** + * Notifies the ad session that display loaded event has occurred. + * + * When triggered all registered verification providers will be notified of this event. + */ +- (BOOL)loadedWithError:(NSError *_Nullable *_Nullable)error; + +/** + * Notifies the ad session that video/audio loaded event has occurred. + * + * When triggered all registered verification providers will be notified of this event. + * @param vastProperties contains static information about the video/audio placement. + */ +- (BOOL)loadedWithVastProperties:(OMIDKontextsoVASTProperties *_Nonnull)vastProperties + error:(NSError *_Nullable *_Nullable)error; +@end diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDAdSession.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDAdSession.h new file mode 100644 index 00000000..27b540fe --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDAdSession.h @@ -0,0 +1,134 @@ +// +// OMIDAdSession.h +// AppVerificationLibrary +// +// Created by Daria on 06/06/2017. +// + +#import +#import "OMIDAdSessionContext.h" +#import "OMIDAdSessionConfiguration.h" +#import "OMIDFriendlyObstructionType.h" + +NS_ASSUME_NONNULL_BEGIN + +/** + * List of supported error types. + */ +typedef NS_ENUM(NSUInteger, OMIDErrorType) { + /** + * The integration is publishing a "generic" error to verification scripts. + */ + OMIDErrorGeneric = 1, + /** + * The integration is publishing a "video" error to verification scripts. + */ + OMIDErrorMedia = 2 +}; + +/** + * Ad session API enabling the integration partner to notify OMID of key state relating to viewability calculations. + * In addition to viewability this API will also notify all verification providers of key ad session lifecycle events. + */ +@interface OMIDKontextsoAdSession : NSObject + +/** + * The AdSession configuration is used for check owners. + */ +@property(nonatomic, readonly) OMIDKontextsoAdSessionConfiguration *configuration; +/** + * The native view which is used for viewability tracking. + */ +@property(nonatomic, weak, nullable) UIView *mainAdView; + +/** + * Initializes new ad session supplying the context. + * + * Note that creating an OMIDAdSession sends a message to the OM SDK JS Service running in the + * webview. If the OM SDK JS Service has not loaded before the ad session is created, the + * message is lost, and the verification scripts will not receive any events. + * + * To prevent this, the implementation must wait until the webview finishes loading OM SDK + * JavaScript before creating the OMIDAdSession. The easiest way is to create the OMIDAdSession + * in a webview delegate callback (-[WKNavigationDelegate webView:didFinishNavigation:]. Alternatively, + * if an implementation can receive an HTML5 DOMContentLoaded event from the webview, it can create + * the OMIDAdSession in a message handler for that event. + * + * @param context The context that provides the required information for initialising the ad session. + * @return A new OMIDAdSession instance, or nil if the supplied context is nil. + */ +- (nullable instancetype)initWithConfiguration:(OMIDKontextsoAdSessionConfiguration *)configuration + adSessionContext:(OMIDKontextsoAdSessionContext *)context + error:(NSError *_Nullable *_Nullable)error; + + +/** + * Notifies all verification providers that the ad session has started and ad view tracking will begin. + * + * This method will have no affect if called after the ad session has finished. + */ +- (void)start; + +/** + * Notifies all verification providers that the ad session has finished and all ad view tracking will stop. + * + * This method will have no affect if called after the ad session has finished. + * + * Note that ending an OMID ad session sends a message to the verification scripts running inside + * the webview supplied by the integration. So that the verification scripts have enough time to + * handle the 'sessionFinish' event, the integration must maintain a strong reference to the webview + * for at least 1.0 seconds after ending the session. + */ +- (void)finish; + +/** + * Adds friendly obstruction which should then be excluded from all ad session viewability calculations. + * It also provides a purpose and detailed reason string to pass forward to the measurement vendors. + * + * This method will have no affect if called after the ad session has finished. + * + * @param friendlyObstruction The view to be excluded from all ad session viewability calculations. + * @param purpose The purpose of why this obstruction was necessary. + * @param detailedReason An explanation for why this obstruction is part of the ad experience if not already + * obvious from the purpose. Can be nil. If not nil, must be 50 characters or less and only contain characers + * `A-z`, `0-9`, or spaces. + * @return Whether this friendly obstruction was successfully added. If the session has finished or the + * friendlyObstruction has already been added for this session, this method will return NO with no associated + * error object. However, if one or more arguments are against requirements, it will return NO with an error + * object assigned. + */ +- (BOOL)addFriendlyObstruction:(UIView *)friendlyObstruction + purpose:(OMIDFriendlyObstructionType)purpose + detailedReason:(nullable NSString *)detailedReason + error:(NSError *_Nullable *_Nullable)error; + +/** + * Removes registered friendly obstruction. + * + * This method will have no affect if called after the ad session has finished. + * + * @param friendlyObstruction The view to be removed from the list of registered friendly obstructions. + */ +- (void)removeFriendlyObstruction:(UIView *)friendlyObstruction; + +/** + * Utility method to remove all registered friendly obstructions. + * + * This method will have no affect if called after the ad session has finished. + */ +- (void)removeAllFriendlyObstructions; + +/** + * Notifies the ad session that an error has occurred. + * + * When triggered all registered verification providers will be notified of this event. + * + * @param errorType The type of error. + * @param message The message containing details of the error. + */ +- (void)logErrorWithType:(OMIDErrorType)errorType message:(NSString *)message +NS_SWIFT_NAME(logError(withType:message:)); + +@end + +NS_ASSUME_NONNULL_END diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDAdSessionConfiguration.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDAdSessionConfiguration.h new file mode 100644 index 00000000..099bf14a --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDAdSessionConfiguration.h @@ -0,0 +1,135 @@ +// +// OMIDAdSessionConfiguration.h +// AppVerificationLibrary +// +// Created by Saraev Vyacheslav on 15/09/2017. +// + +#import + +/** + * Identifies which integration layer is responsible for sending certain events. + */ +typedef NS_ENUM(NSUInteger, OMIDOwner) { + /** The integration will send the event from a JavaScript session script. */ + OMIDJavaScriptOwner = 1, + /** The integration will send the event from the native layer. */ + OMIDNativeOwner = 2, + /** The integration will not send the event. */ + OMIDNoneOwner = 3 +}; + + +/** + * List of supported creative types. + */ +typedef NS_ENUM(NSUInteger, OMIDCreativeType) { + /** + * Creative type will be set by JavaScript session script. + * Integrations must also pass `OMIDJavaScriptOwner` for `impressionOwner`. + */ + OMIDCreativeTypeDefinedByJavaScript = 1, + // Remaining values set creative type in native layer. + /** + * Rendered in webview, verification code can be inside creative or in metadata. + */ + OMIDCreativeTypeHtmlDisplay = 2, + /** + * Rendered by native, verification code provided in metadata only. + */ + OMIDCreativeTypeNativeDisplay = 3, + /** + * Rendered instream or as standalone video, verification code provided in metadata. + */ + OMIDCreativeTypeVideo = 4, + /** + * Similar to video but only contains audio media. + */ + OMIDCreativeTypeAudio = 5 +}; + +/** + * The criterion for an ad session's OMID impression event. + * Declaring an impression type makes it easier to understand discrepancies between measurers + * of the ad session, since many metrics depend on impressions. + */ +typedef NS_ENUM(NSUInteger, OMIDImpressionType) { + /** + * ImpressionType will be set by JavaScript session script. + * Integrations must also pass `OMIDJavaScriptOwner` for `impressionOwner`. + */ + OMIDImpressionTypeDefinedByJavaScript = 1, + // Remaining values set ImpressionType in native layer. + /** + * The integration is not declaring the criteria for the OMID impression. + */ + OMIDImpressionTypeUnspecified = 2, + /** + * The integration is using count-on-download criteria for the OMID impression. + */ + OMIDImpressionTypeLoaded = 3, + /** + * The integration is using begin-to-render criteria for the OMID impression. + */ + OMIDImpressionTypeBeginToRender = 4, + /** + * The integration is using one-pixel criteria (when the creative has at least 1 visible pixel on + * screen) for the OMID impression. + */ + OMIDImpressionTypeOnePixel = 5, + /** + * The integration is using viewable criteria (1 second for display, 2 seconds while playing for + * video, and at least 50% of the creative is visible) for the OMID impression. + */ + OMIDImpressionTypeViewable = 6, + /** + * The integration is using audible criteria (2 continuous second of media playback with non-zero + * volume) for the OMID impression. + */ + OMIDImpressionTypeAudible = 7, + /** + * The integration's criteria uses none of the above criteria for the OMID impression. + */ + OMIDImpressionTypeOther = 8 +}; + +/** + * The ad session configuration supplies the owner for both the impression and video events. + * The OM SDK JS service will use this information to help identify where the source of these + * events is expected to be received. + */ +@interface OMIDKontextsoAdSessionConfiguration : NSObject + +@property OMIDCreativeType creativeType; +@property OMIDImpressionType impressionType; +@property OMIDOwner impressionOwner; +@property OMIDOwner mediaEventsOwner; +@property BOOL isolateVerificationScripts; + +/** + * Create new ad session configuration supplying the owner for both the impression and media + * events along with the type of creative being rendered/measured. + * The OM SDK JS service will use this information to help identify where the source of these + * events is expected to be received. + * @param creativeType the type of creative to be rendered in this session. + * @param impressionType the type of impression to be triggered in this session. + * @param impressionOwner whether the native or JavaScript layer should be responsible for supplying + * the impression event. + * @param mediaEventsOwner whether the native or JavaScript layer should be responsible for + * supplying media events. This needs to be set only for non-display ad sessions and can be set to + * `OMIDNoneOwner` for display. When the creativeType is `OMIDCreativeTypeDefinedByJavaScript` then + * this should be set to `OMIDJavaScriptOwner` + * @param isolateVerificationScripts determines whether verification scripts will be placed in a + * sandboxed environment. This will not have any effect for native sessions. + * @return A new session configuration instance. Returns nil and sets error if OM SDK isn't active + * or arguments are invalid. + */ +- (nullable instancetype)initWithCreativeType:(OMIDCreativeType)creativeType + impressionType:(OMIDImpressionType)impressionType + impressionOwner:(OMIDOwner)impressionOwner + mediaEventsOwner:(OMIDOwner)mediaEventsOwner + isolateVerificationScripts:(BOOL)isolateVerificationScripts + error:(NSError *_Nullable *_Nullable)error; + +@end + diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDAdSessionContext.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDAdSessionContext.h new file mode 100644 index 00000000..e31cbf1c --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDAdSessionContext.h @@ -0,0 +1,126 @@ +// +// Created by Daria Sukhonosova on 19/04/16. +// + +#import + +#if !(TARGET_OS_TV) +#import +#endif + +#import "OMIDPartner.h" +#import "OMIDUniversalAdID.h" +#import "OMIDVerificationScriptResource.h" + +NS_ASSUME_NONNULL_BEGIN + +/** + * Provides the ad session with details of the partner and whether to an HTML, + * JavaScript, or native session. + */ +@interface OMIDKontextsoAdSessionContext : NSObject + +- (null_unspecified instancetype)init NS_UNAVAILABLE; + +#if !(TARGET_OS_TV) + +/** + * Initializes a new ad session context providing reference to partner and web view where + * the OM SDK JavaScript service has been injected. + * + * Calling this method will set the ad session type to `html`. + *

+ * NOTE: any attempt to create a new ad session will fail if OM SDK has not been + * activated (see {@link OMIDSDK} class for more information). + * + * @param partner Details of the integration partner responsible for the ad session. + * @param webView The WKWebView responsible for serving the ad content. The receiver holds a weak reference only. + * @param contentUrl contains the universal link to the ad's screen. + * @return A new HTML context instance. Returns nil if OM SDK has not been activated or if + * any of the parameters are nil. + * @see OMIDSDK + */ +- (nullable instancetype)initWithPartner:(OMIDKontextsoPartner *)partner + webView:(WKWebView *)webView + contentUrl:(nullable NSString *)contentUrl + customReferenceIdentifier:(nullable NSString *)customReferenceIdentifier + error:(NSError *_Nullable *_Nullable)error; +#endif + +/** + * Initializes a new ad session context providing reference to partner and a list of + * script resources which should be managed by OMID. + * + * Calling this method will set the ad session type to `native`. + *

+ * NOTE: any attempt to create a new ad session will fail if OMID has not been activated + * (see {@link OMIDSDK} class for more information). + * + * @param partner Details of the integration partner responsible for the ad session. + * @param resources The array of all verification providers who expect to receive OMID + * event data. Must contain at least one verification script. The receiver creates a + * deep copy of the array. + * @param contentUrl contains the universal link to the ad's screen. + * @return A new native context instance. Returns nil if OMID has not been activated or if any of the parameters are invalid. + * @see OMIDSDK + */ +- (nullable instancetype)initWithPartner:(OMIDKontextsoPartner *)partner + script:(NSString *)script + resources:(NSArray *)resources + contentUrl:(nullable NSString *)contentUrl + customReferenceIdentifier:(nullable NSString *)customReferenceIdentifier + error:(NSError *_Nullable *_Nullable)error; + +/** + * Initializes a new ad session context providing reference to partner, an optional universalAdID and a list of + * script resources which should be managed by OMID. + * + * Calling this method will set the ad session type to `native`. + *

+ * NOTE: any attempt to create a new ad session will fail if OMID has not been activated + * (see {@link OMIDSDK} class for more information). + * + * @param partner Details of the integration partner responsible for the ad session. + * @param resources The array of all verification providers who expect to receive OMID + * event data. Must contain at least one verification script. The receiver creates a + * deep copy of the array. + * @param contentUrl contains the universal link to the ad's screen. + * @param universalAdID optional identifier for an ad creative. See {@link OMIDUniversalAdID} class for more information. + * @return A new native context instance. Returns nil if OMID has not been activated or if any of the required parameters are invalid. + * @see OMIDSDK + */ +- (nullable instancetype)initWithPartner:(OMIDKontextsoPartner *)partner + script:(NSString *)script + resources:(NSArray *)resources + contentUrl:(nullable NSString *)contentUrl + customReferenceIdentifier:(nullable NSString *)customReferenceIdentifier + universalAdID:(nullable OMIDKontextsoUniversalAdID *)universalAdID + error:(NSError *_Nullable *_Nullable)error; + +#if !(TARGET_OS_TV) +/** + * Initializes a new ad session context providing reference to partner and web view where + * OM SDK JavaScript service has been injected. + * + * Calling this method will set the ad session type to `javascript`. + *

+ * NOTE: any attempt to create a new ad session will fail if OMID has not been activated + * (see {@link OMIDSDK} class for more information). + * + * @param partner Details of the integration partner responsible for the ad session. + * @param webView The WKWebView responsible for serving the ad content. The receiver holds a weak reference only. + * @param contentUrl contains the universal link to the ad's screen. + * @return A new JavaScript context instance. Returns nil if OM SDK has not been + * activated or if any of the parameters are invalid. + * @see OMIDSDK + */ +- (nullable instancetype)initWithPartner:(OMIDKontextsoPartner *)partner + javaScriptWebView:(WKWebView *)webView + contentUrl:(nullable NSString *)contentUrl + customReferenceIdentifier:(nullable NSString *)customReferenceIdentifier + error:(NSError *_Nullable *_Nullable)error; +#endif + +@end + +NS_ASSUME_NONNULL_END diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDFriendlyObstructionType.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDFriendlyObstructionType.h new file mode 100644 index 00000000..ee7bc6ac --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDFriendlyObstructionType.h @@ -0,0 +1,30 @@ +// +// OMIDFriendlyObstructionType.h +// AppVerificationLibrary +// +// Created by Andrew Whitcomb on 4/3/19. +// Copyright © 2019 Integral Ad Science, Inc. All rights reserved. +// + +/** + * List of allowed friendly obstruction purposes. + */ +typedef NS_ENUM(NSUInteger, OMIDFriendlyObstructionType) { + /** + * The friendly obstruction relates to interacting with a video (such as play/pause buttons). + */ + OMIDFriendlyObstructionMediaControls, + /** + * The friendly obstruction relates to closing an ad (such as a close button). + */ + OMIDFriendlyObstructionCloseAd, + /** + * The friendly obstruction is not visibly obstructing the ad but may seem so due to technical + * limitations. + */ + OMIDFriendlyObstructionNotVisible, + /** + * The friendly obstruction is obstructing for any purpose not already described. + */ + OMIDFriendlyObstructionOther +}; diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDImports.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDImports.h new file mode 100644 index 00000000..cec63730 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDImports.h @@ -0,0 +1,10 @@ +#import "OMIDSDK.h" +#import "OMIDScriptInjector.h" +#import "OMIDPartner.h" +#import "OMIDVerificationScriptResource.h" +#import "OMIDAdSessionContext.h" +#import "OMIDAdSession.h" +#import "OMIDAdEvents.h" +#import "OMIDVASTProperties.h" +#import "OMIDMediaEvents.h" +#import "OMIDJavaScriptSessionService.h" diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDJavaScriptSessionService.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDJavaScriptSessionService.h new file mode 100644 index 00000000..4bd74871 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDJavaScriptSessionService.h @@ -0,0 +1,109 @@ +#include +#if !(TARGET_OS_TV) + +#import +#import +#import "OMIDFriendlyObstructionType.h" +#import "OMIDPartner.h" + +NS_ASSUME_NONNULL_BEGIN + +/** + * Service supporting ad sessions managed (started/finished) via JavaScript Session Client APIs + * by providing native-layer measurement signals. + * If the JS Session Client is running in a web view, an instance of this service must be + * initialized with the web view before starting or finishing ad sessions using JS APIs. + * Only one instance of this service may be initialized at a time for a given web view; to reuse a + * web view the current instance must be torn down (see `tearDownWithCompletion`). + */ +@interface OMIDKontextsoJavaScriptSessionService : NSObject + +/** + * Initializes an instance of the service. + * + * @param partner Details of the integration partner responsible for ad sessions. + * @param webView The web view responsible for starting/finishing ad sessions via the JS Session + * Client. + * @param isHTMLAdView Whether the ad is rendered in HTML inside of the provided web view. + * If true, all ad sessions will be of type "html" and calling `setAdView` is + * not required. + * If false, all ad sessions will be of type "javascript" and `setAdView` must + * be called after initialization. + */ +- (nullable instancetype)initWithPartner:(OMIDKontextsoPartner *)partner + webView:(WKWebView *)webView + isHTMLAdView:(BOOL)isHTMLAdView + error:(NSError *_Nullable *_Nullable)error; + +/** + * Tears down this instance of the service. + * Calling this method will cause OM SDK to begin a teardown process including finishing all currently + * active ad sessions measured by this service instance and tearing down communication with the OM + * SDK's JavaScript layer running in the web view. + * This may require up to one second, for example in order to allow verification scripts time to process + * the `sessionFinish` event. + * Once this process has completed, the web view may be torn down or reused for another instance of + * the service without any adverse effects. If there is no need to tear down or reuse the web view, this + * method is not required. + * @param completionBlock Invoked by OM SDK after the teardown process has completed, + * or one second, whichever comes sooner. + */ +- (void)tearDownWithCompletion:(void (^)(BOOL success, NSError *_Nullable error))completionBlock; + +/** + * The native view containing the ad. + * This property is readonly and must be set using `setAdView`. + * If `isHTMLAdView` was passed as true in `initWithPartner`, this will equal + * the web view by default. + */ +@property(readonly, nonatomic, weak) UIView *adView; + +/** + * Sets the native view that contains the ad and is used for viewability tracking. + * If `isHTMLAdView` was passed as true in `initWithPartner`, this method is + * not required since the ad view will be set to the web view by default. + * @param adView The native view. + * @return Whether the ad view was successfully set. + */ +- (BOOL)setAdView:(nullable UIView *)adView + error:(NSError **)error; + +/** + * Adds a friendly obstruction which should then be excluded from all ad session viewability + * calculations. While this instance of OMIDJavaScriptSessionService is running, this friendly + * obstruction will be added to each ad session started by the integrator via the JS Session Client + * until the obstruction is removed by calling `removeFriendlyObstruction` or + * `removeAllFriendlyObstructions`. + * + * @param friendlyObstruction The view to be excluded from all ad session viewability calculations. + * @param purpose The purpose of why this obstruction was necessary. + * @param detailedReason An explanation for why this obstruction is part of the ad experience if not + * already obvious from the purpose. Can be nil. If not nil, must be 50 characters or less and only + * contain characters `A-z`, `0-9`, or spaces. + * @return Whether this friendly obstruction was successfully added. If the friendlyObstruction has + * already been added for this session, this method will return NO with no associated error object. + * However, if one or more arguments are against requirements, it will return NO with an error + * object assigned. + */ +- (BOOL)addFriendlyObstruction:(UIView *)friendlyObstruction + purpose:(OMIDFriendlyObstructionType)purpose + detailedReason:(nullable NSString *)detailedReason + error:(NSError *_Nullable *_Nullable)error; + +/** + * Removes a registered friendly obstruction from any currently running and future ad sessions + * measured by this instance of OMIDJavaScriptSessionService. + */ +- (void)removeFriendlyObstruction:(UIView *)friendlyObstruction; + +/** + * Removes all registered friendly obstructions from any currently running and future ad sessions + * measured by this instance of OMIDJavaScriptSessionService. + */ +- (void)removeAllFriendlyObstructions; + +@end + +NS_ASSUME_NONNULL_END + +#endif diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDMediaEvents.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDMediaEvents.h new file mode 100644 index 00000000..76f3cca6 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDMediaEvents.h @@ -0,0 +1,155 @@ +// +// OMIDMediaEvents.h +// AppVerificationLibrary +// +// Created by Justin Hines on 6/13/19. +// + +#import +#import "OMIDAdSession.h" +#import "OMIDVASTProperties.h" + +/** + * List of supported media event player states. + */ +typedef NS_ENUM(NSUInteger, OMIDPlayerState) { + /** + * The player is collapsed in such a way that the video is hidden. + * The video may or may not still be progressing in this state, and sound may be audible. + * This refers specifically to the video player state on the page, and not the state of + * the browser window. + */ + OMIDPlayerStateMinimized, + /** + * The player has been reduced from its original size. + * The video is still potentially visible. + */ + OMIDPlayerStateCollapsed, + /** + * The player's default playback size. + */ + OMIDPlayerStateNormal, + /** + * The player has expanded from its original size. + */ + OMIDPlayerStateExpanded, + /** + * The player has entered fullscreen mode. + */ + OMIDPlayerStateFullscreen +}; + +/** + * List of supported media event user interaction types. + */ +typedef NS_ENUM(NSUInteger, OMIDInteractionType) { + /** + * The user clicked to load the ad's landing page. + */ + OMIDInteractionTypeClick, + /** + * The user engaged with ad content to load a separate experience. + */ + OMIDInteractionTypeAcceptInvitation +}; + +/** + * This provides a complete list of native media events supported by OMID. + * Using this event API assumes the media player is fully responsible for communicating all media events at the appropriate times. + * Only one media events implementation can be associated with the ad session and any attempt to create multiple instances will result in an error. + */ +@interface OMIDKontextsoMediaEvents : NSObject + +/** + * Initializes media events instance for the associated ad session. + * Any attempt to create a media events instance will fail if the supplied ad session has already started. + * + * @param session The ad session associated with the ad events. + * @return A new media events instance. Returns nil if the supplied ad session is nil or if a media events instance has already been registered with the ad session or if a media events instance has been created after the ad session has started. + * @see OMIDAdSession + */ +- (nullable instancetype)initWithAdSession:(nonnull OMIDKontextsoAdSession *)session error:(NSError *_Nullable *_Nullable)error; + +/** + * Notifies all media listeners that media content has started playing. + * + * @param duration The duration of the selected media (in seconds). + * @param mediaPlayerVolume The volume from the native media player with a range between 0 and 1. + */ +- (void)startWithDuration:(CGFloat)duration + mediaPlayerVolume:(CGFloat)mediaPlayerVolume; + +/** + * Notifies all media listeners that media playback has reached the first quartile. + */ +- (void)firstQuartile; + +/** + * Notifies all media listeners that media playback has reached the midpoint. + */ +- (void)midpoint; + +/** + * Notifies all media listeners that media playback has reached the third quartile. + */ +- (void)thirdQuartile; + +/** + * Notifies all media listeners that media playback is complete. + */ +- (void)complete; + +/** + * Notifies all media listeners that media playback has paused after a user interaction. + */ +- (void)pause; + +/** + * Notifies all media listeners that media playback has resumed after being paused. + */ +- (void)resume; + +/** + * Notifies all media listeners that media playback has stopped as a user skip interaction. + * Once skipped, it should not be possible for the media to resume playing content. + */ +- (void)skipped; + +/** + * Notifies all media listeners that media playback has stopped and started buffering. + */ +- (void)bufferStart; + +/** + * Notifies all media listeners that buffering has finished and media playback has resumed. + */ +- (void)bufferFinish; + +/** + * Notifies all media listeners that the media player volume has changed. + * + * @param playerVolume The volume from the native media player with a range between 0 and 1. + */ +- (void)volumeChangeTo:(CGFloat)playerVolume; + +/** + * Notifies all media listeners that media player state has changed. + * See `OMIDPlayerState` for list of supported states. + * + * @param playerState The latest media player state. + * @see OMIDPlayerState + */ +- (void)playerStateChangeTo:(OMIDPlayerState)playerState; + +/** + * Notifies all media listeners that the user has performed an ad interaction. + * See `OMIDInteractionType` for a list of supported types. + * + * @param interactionType The latest user integration. + * @see OMIDInteractionType + */ +- (void)adUserInteractionWithType:(OMIDInteractionType)interactionType +NS_SWIFT_NAME(adUserInteraction(withType:)); + +@end + diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDPartner.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDPartner.h new file mode 100644 index 00000000..b54556dc --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDPartner.h @@ -0,0 +1,32 @@ +// +// OMIDPartner.h +// AppVerificationLibrary +// +// Created by Daria on 06/06/2017. +// + +#import + +/** + * Details about the integration partner which will be supplied to the ad session. + */ +@interface OMIDKontextsoPartner : NSObject + +@property(nonatomic, readonly, nonnull) NSString *name; +@property(nonatomic, readonly, nonnull) NSString *versionString; + +/** + * Initializes new partner instance providing both name and versionString. + * + * Both name and version are mandatory. + * + * @param name It is used to uniquely identify the integration partner. + * @param versionString It is used to uniquely identify the integration partner. + * @return A new partner instance, or nil if any of the parameters are either null or blank + */ +- (nullable instancetype)initWithName:(nonnull NSString *)name + versionString:(nonnull NSString *)versionString; + +- (null_unspecified instancetype)init NS_UNAVAILABLE; + +@end diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDSDK.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDSDK.h new file mode 100644 index 00000000..daa9820b --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDSDK.h @@ -0,0 +1,58 @@ +// +// OMIDSDK.h +// AppVerificationLibrary +// +// Created by Daria on 05/06/2017. +// + +#import + +NS_ASSUME_NONNULL_BEGIN + +/** + * This application level class will be called by all integration partners to ensure OM SDK has been activated before calling any other API methods. + * Any attempt to use other API methods prior to activation will result in an error. + * + * Note that OM SDK may only be used on the main UI thread. + * Make sure you are on the main thread when you initialize the SDK, create its + * objects, and invoke its methods. + */ +@interface OMIDKontextsoSDK : NSObject + +/** + * The current semantic version of the integrated OMID library. + */ ++ (NSString *)versionString; + +/** + * Shared OMIDSDK instance. + */ +@property(class, readonly) OMIDKontextsoSDK *sharedInstance +NS_SWIFT_NAME(shared); + +/** + * A Boolean value indicating whether OM SDK has been activated. + * + * @discussion Check that OM SDK is active prior to creating any ad sessions. + */ +@property(atomic, readonly, getter=isActive) BOOL active; + +/** + * Activate OM SDK before calling other API methods. + * + * @discussion Activation sets up the OM SDK environment. In CTV apps (running tvOS), `activate` should be called on launch in + * order to capture a "last activity" timestamp on launch and each time the user foregrounds the app). + * + * @return Boolean indicating success. + */ +- (BOOL)activate; + +/** + * Update the last activity time + * After activating OM SDK in CTV apps, refresh the "last activity" timestamp in response to user input prior to starting an ad session. + */ +- (void)updateLastActivity; + +@end + +NS_ASSUME_NONNULL_END diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDScriptInjector.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDScriptInjector.h new file mode 100644 index 00000000..f6dd4572 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDScriptInjector.h @@ -0,0 +1,26 @@ +// +// OMIDScriptInjector.h +// AppVerificationLibrary +// +// Created by Daria on 21/06/2017. +// + +#import + +/** + * Utility class which enables integration partners to use a standard approach for injecting OM SDK JS into the served tag HTML content. + */ +@interface OMIDKontextsoScriptInjector : NSObject + +/* + Injects the downloaded OMID JS content into the served HTML. + @param scriptContent containing the OMID JS service content to be injected into the hidden tracking web view. + @param html of the tag content which should be modified to include the downloaded OMID JS content. + @param error If an error occurs, contains an NSError object. + @return modified HTML including OMID JS or nil if an error occurs. + */ ++ (nullable NSString *)injectScriptContent:(nonnull NSString *)scriptContent + intoHTML:(nonnull NSString *)html + error:(NSError *_Nullable *_Nullable)error; + +@end diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDUniversalAdID.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDUniversalAdID.h new file mode 100644 index 00000000..25fb50d5 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDUniversalAdID.h @@ -0,0 +1,40 @@ +// +// OMIDUniversalAdID.h +// AppVerificationLibrary +// +// Created by Teodor Cristea on 31.03.2025. +// Copyright © 2025 IAB Techlab. All rights reserved. +// + +#import + +NS_ASSUME_NONNULL_BEGIN + +/** + * Details about the UniversalAdID for the purpose of tracking ad creatives which will be supplied to the ad session. + */ +@interface OMIDKontextsoUniversalAdID : NSObject + +@property(nonatomic, readonly, nonnull) NSString *value; +@property(nonatomic, readonly, nonnull) NSString *idRegistry; + +/** + * Initializes new UniversalAdID instance providing both value and idRegistry. + * The UniversalAdID's purpose is to identify an ad creative across different platforms throughout the lifecycle of an advertising campaign. + * + * Both value and idRegistry are mandatory. + * + * @param value It is used to identify the unique creative identifier. + * @param idRegistry It is used to identify the URL for the registry website where the unique creative ID is cataloged. + * @return A new UniversalAdID instance, or nil if any of the parameters are either null or blank + */ +- (nullable instancetype)initWithValue:(nonnull NSString *)value + idRegistry:(nonnull NSString *)idRegistry + error:(NSError *_Nullable *_Nullable)error; + ++ (instancetype)new NS_UNAVAILABLE; +- (null_unspecified instancetype)init NS_UNAVAILABLE; + +@end + +NS_ASSUME_NONNULL_END diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDVASTProperties.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDVASTProperties.h new file mode 100644 index 00000000..5874fbd1 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDVASTProperties.h @@ -0,0 +1,71 @@ +// +// OMIDVASTProperties.h +// AppVerificationLibrary +// +// Created by Daria Sukhonosova on 30/06/2017. +// + +#import + +/** + * List of supported media player positions. + */ +typedef NS_ENUM(NSUInteger, OMIDPosition) { + /** + * The ad plays preceding video content. + */ + OMIDPositionPreroll, + /** + * The ad plays in the middle of video content, or between two separate content videos. + */ + OMIDPositionMidroll, + /** + * The ad plays following video content. + */ + OMIDPositionPostroll, + /** + * The ad plays independently of any video content. + */ + OMIDPositionStandalone +}; + +/** + * This object is used to capture key VAST properties so this can be shared with all registered verification providers. + */ +@interface OMIDKontextsoVASTProperties : NSObject + +@property(nonatomic, readonly, getter = isSkippable) BOOL skippable; +@property(nonatomic, readonly) CGFloat skipOffset; +@property(nonatomic, readonly, getter = isAutoPlay) BOOL autoPlay; +@property(nonatomic, readonly) OMIDPosition position; + +/** + * This method enables the media player to create a new VAST properties instance for skippable media ad placement. + * + * @param skipOffset The number of seconds before the skip button is presented. + * @param autoPlay Determines whether the media will auto-play content. + * @param position The position of the media in relation to other content. + * @return A new instance of VAST properties. + */ +- (nonnull instancetype)initWithSkipOffset:(CGFloat)skipOffset + autoPlay:(BOOL)autoPlay + position:(OMIDPosition)position; + +/** + * This method enables the media player to create a new VAST properties instance for non-skippable media ad placement. + * + * @param autoPlay Determines whether the media will auto-play content. + * @param position The position of the media in relation to other content. + * @return A new instance of VAST properties. + */ +- (nonnull instancetype)initWithAutoPlay:(BOOL)autoPlay + position:(OMIDPosition)position; + +- (null_unspecified instancetype)init NS_UNAVAILABLE; + +/** + * For OM SDK internal use only. + */ +- (NSDictionary *_Nonnull)toJSON; + +@end diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDVerificationScriptResource.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDVerificationScriptResource.h new file mode 100644 index 00000000..c43451a3 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDVerificationScriptResource.h @@ -0,0 +1,45 @@ +// +// OMIDVerificationScriptResource.h +// AppVerificationLibrary +// +// Created by Daria on 06/06/2017. +// + +#import + +/** + * Details about the verification provider which will be supplied to the ad session. + */ +@interface OMIDKontextsoVerificationScriptResource : NSObject + +@property(nonatomic, readonly, nonnull) NSURL *URL; +@property(nonatomic, readonly, nullable) NSString *vendorKey; +@property(nonatomic, readonly, nullable) NSString *parameters; + +/** + * Initializes new verification script resource instance which requires vendor specific verification parameters. + * + * When calling this method all arguments are mandatory. + * + * @param vendorKey It is used to uniquely identify the verification provider. + * @param URL The URL to be injected into the OMID managed JavaScript execution environment. + * @param parameters The parameters which the verification provider script is expecting for the ad session. + * @return A new verification script resource instance, or nil if any of the parameters are either null or blank. + */ +- (nullable instancetype)initWithURL:(nonnull NSURL *)URL + vendorKey:(nonnull NSString *)vendorKey + parameters:(nonnull NSString *)parameters; + +/** + * Initializes new verification script resource instance which does not require any vendor specific verification parameters. + * + * When calling this method all arguments are mandatory. + * + * @param URL The URL to be injected into the OMID managed JavaScript execution environment. + * @return A new verification script resource instance, or nil if URL is nil or blank. + */ +- (nullable instancetype)initWithURL:(nonnull NSURL *)URL; + +- (null_unspecified instancetype)init NS_UNAVAILABLE; + +@end diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMSDK.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMSDK.h new file mode 100644 index 00000000..bc3714ad --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMSDK.h @@ -0,0 +1,18 @@ +// +// OMSDK.h +// OMSDK +// +// Created by Nathanael Hardy on 10/16/20. +// + +#import + +//! Project version number for OMSDK. +FOUNDATION_EXPORT double OMSDKVersionNumber; + +//! Project version string for OMSDK. +FOUNDATION_EXPORT const unsigned char OMSDKVersionString[]; + +// In this header, you should import all the public headers of your framework using statements like #import + +#import diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Info.plist b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Info.plist new file mode 100644 index 00000000..997832b8 Binary files /dev/null and b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Info.plist differ diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Modules/module.modulemap b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Modules/module.modulemap new file mode 100644 index 00000000..078b6857 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Modules/module.modulemap @@ -0,0 +1,4 @@ +module OMSDK_Kontextso { + header "Headers/OMIDImports.h" + export * +} diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/OMSDK_Kontextso b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/OMSDK_Kontextso new file mode 100755 index 00000000..f107a88b Binary files /dev/null and b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/OMSDK_Kontextso differ diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/PrivacyInfo.xcprivacy b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/PrivacyInfo.xcprivacy new file mode 100644 index 00000000..5ab7e387 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/PrivacyInfo.xcprivacy @@ -0,0 +1,42 @@ + + + + + + NSPrivacyCollectedDataTypes + + + NSPrivacyCollectedDataType + NSPrivacyCollectedDataTypeProductInteraction + NSPrivacyCollectedDataTypeLinked + + NSPrivacyCollectedDataTypeTracking + + NSPrivacyCollectedDataTypePurposes + + NSPrivacyCollectedDataTypePurposeThirdPartyAdvertising + NSPrivacyCollectedDataTypePurposeDeveloperAdvertising + + + + NSPrivacyCollectedDataType + NSPrivacyCollectedDataTypeAdvertisingData + NSPrivacyCollectedDataTypeLinked + + NSPrivacyCollectedDataTypeTracking + + NSPrivacyCollectedDataTypePurposes + + NSPrivacyCollectedDataTypePurposeThirdPartyAdvertising + NSPrivacyCollectedDataTypePurposeDeveloperAdvertising + + + + + diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/_CodeSignature/CodeResources b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/_CodeSignature/CodeResources new file mode 100644 index 00000000..79d05bd1 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/ios-arm64_x86_64-simulator/OMSDK_Kontextso.framework/_CodeSignature/CodeResources @@ -0,0 +1,289 @@ + + + + + files + + Headers/OMIDAdEvents.h + + am/yiZOXFWtpRJvhlFJlaWbUWOQ= + + Headers/OMIDAdSession.h + + fxqpQp6PpN5FhdpKtzp1m8pxakg= + + Headers/OMIDAdSessionConfiguration.h + + FaFKqWWZiE/UwFJptVcKf3+TC/8= + + Headers/OMIDAdSessionContext.h + + G3eoR7OHiMnEJWDGL11uI27M+w8= + + Headers/OMIDFriendlyObstructionType.h + + ymPA8TI4PL8pK0zhc5ilyQj/SsA= + + Headers/OMIDImports.h + + /ghw/vX0KUlF9SSq4LZhhZDpZb4= + + Headers/OMIDJavaScriptSessionService.h + + 1fiDz/ZFUv3vsIyROVepMB9RhNU= + + Headers/OMIDMediaEvents.h + + Gf3AkxkJ3Vx4DwCYAfQcOC21U60= + + Headers/OMIDPartner.h + + g/b45DUwpunphzi8Bb/s8MDv3/s= + + Headers/OMIDSDK.h + + 1bJmHENCgd81ADE2yJwQG63gYvM= + + Headers/OMIDScriptInjector.h + + Z6KYAHtDRU1RL+NxsVqVpbi1UIA= + + Headers/OMIDUniversalAdID.h + + HfpQibx5013NtmzEmU6YLsOU8wM= + + Headers/OMIDVASTProperties.h + + 9Oe9DoZD7Gu4m4djKpP3HW1wi8A= + + Headers/OMIDVerificationScriptResource.h + + nnh2Tmyp73GE4UB1EOH44da57VM= + + Headers/OMSDK.h + + SwK6aatAfFlLHnP2+J8eYoZyaqs= + + Info.plist + + v/OyHJM5zGr9wQVB+W+uPt3YLyg= + + Modules/module.modulemap + + jAuAbI2uLxH0F9SXvjWXNNBqYSQ= + + PrivacyInfo.xcprivacy + + 7BgfS40JHW2Znl7afTrGvxB58Ws= + + + files2 + + Headers/OMIDAdEvents.h + + hash2 + + Uon2BFlfaYu7xdPpGhhDoxrnTxS99d+vlwZibVTcNfM= + + + Headers/OMIDAdSession.h + + hash2 + + P2/SRxMST0KToCmq6laq5UfWM7C+/I80sFW5yN9y9IM= + + + Headers/OMIDAdSessionConfiguration.h + + hash2 + + TAjMbUayhPpau5aGanvcngASnJAKVaRBWBOVD6XcK8I= + + + Headers/OMIDAdSessionContext.h + + hash2 + + YG+Bk6tUe1Y3FpXI2FbPuKJ2uMZGn7l5LvaYvTw4K2E= + + + Headers/OMIDFriendlyObstructionType.h + + hash2 + + /ZmBFlTK7mS0fZy4WqxCTpfhwDAEA4qlDHoed4FawBg= + + + Headers/OMIDImports.h + + hash2 + + XQBgb62m3DEN2XBtnlS+hqca4MEIuBJjq6po9fIbZco= + + + Headers/OMIDJavaScriptSessionService.h + + hash2 + + ndvnaaz7rqwG/SOgTCBeDu13IivgmkDbd7/+TmRlgGA= + + + Headers/OMIDMediaEvents.h + + hash2 + + 2MLNvQSUEbX2iruhkH8EpcPD3hldsEnikylbssLYYvk= + + + Headers/OMIDPartner.h + + hash2 + + VP+tsHIL0YmzFVxea6F6Y94/dG9p42Ubmg9bgH8uIxc= + + + Headers/OMIDSDK.h + + hash2 + + ZkojrMZxmVBHkDQQA55ozX8Yid1Kw2c/s7NCvqOEA0E= + + + Headers/OMIDScriptInjector.h + + hash2 + + QdezzQmyENJeVAKI3VQ/WQO+XuVW9W19dZX6lnx6slQ= + + + Headers/OMIDUniversalAdID.h + + hash2 + + XC6x3TXPiqFy3yszzifKwq15Cghu8jSxT9gWoKgiQys= + + + Headers/OMIDVASTProperties.h + + hash2 + + DaMzQ26+i+oaRtWlRtfNFSiPCoS3pnXbR6trg9+ceIE= + + + Headers/OMIDVerificationScriptResource.h + + hash2 + + Kj8QOr3eZHuIfHylEUtC9/vvCUE78deUsyouMlODaRk= + + + Headers/OMSDK.h + + hash2 + + RMvQNEJLOImLem6a8DtHWs08tFMncdsWXtF/QfYUIvQ= + + + Modules/module.modulemap + + hash2 + + cNfPijMaVG/k/dYTmzOjFlnbppT8ERwBfRkuaJeCpZc= + + + PrivacyInfo.xcprivacy + + hash2 + + 5rdpDTW6MDoz1u2y0rCJB5ensp/KZWPv7EAq4o8GtfM= + + + + rules + + ^.* + + ^.*\.lproj/ + + optional + + weight + 1000 + + ^.*\.lproj/locversion.plist$ + + omit + + weight + 1100 + + ^Base\.lproj/ + + weight + 1010 + + ^version.plist$ + + + rules2 + + .*\.dSYM($|/) + + weight + 11 + + ^(.*/)?\.DS_Store$ + + omit + + weight + 2000 + + ^.* + + ^.*\.lproj/ + + optional + + weight + 1000 + + ^.*\.lproj/locversion.plist$ + + omit + + weight + 1100 + + ^Base\.lproj/ + + weight + 1010 + + ^Info\.plist$ + + omit + + weight + 20 + + ^PkgInfo$ + + omit + + weight + 20 + + ^embedded\.provisionprofile$ + + weight + 20 + + ^version\.plist$ + + weight + 20 + + + + diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDAdEvents.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDAdEvents.h new file mode 100644 index 00000000..f54d6533 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDAdEvents.h @@ -0,0 +1,50 @@ +// +// OMIDAdEvents.h +// AppVerificationLibrary +// +// Created by Daria Sukhonosova on 22/06/2017. +// + +#import +#import "OMIDAdSession.h" +#import "OMIDVASTProperties.h" + +/** + * Ad event API enabling the integration partner to signal to all verification providers when key events have occurred. + * Only one ad events implementation can be associated with the ad session and any attempt to create multiple instances will result in an error. + */ +@interface OMIDKontextsoAdEvents : NSObject + +/** + * Initializes ad events instance associated with the supplied ad session. + * + * @param session The ad session associated with the ad events. + * @return A new ad events instance associated with the supplied ad session. Returns nil if the supplied ad session is nil or if an ad events instance has already been registered with the ad session. + */ +- (nullable instancetype)initWithAdSession:(nonnull OMIDKontextsoAdSession *)session error:(NSError * _Nullable * _Nullable)error; + +/** + * Notifies the ad session that an impression event has occurred. + * + * When triggered all registered verification providers will be notified of this event. + * + * NOTE: the ad session will be automatically started if this method has been called first. + */ +- (BOOL)impressionOccurredWithError:(NSError *_Nullable *_Nullable)error; + +/** + * Notifies the ad session that display loaded event has occurred. + * + * When triggered all registered verification providers will be notified of this event. + */ +- (BOOL)loadedWithError:(NSError *_Nullable *_Nullable)error; + +/** + * Notifies the ad session that video/audio loaded event has occurred. + * + * When triggered all registered verification providers will be notified of this event. + * @param vastProperties contains static information about the video/audio placement. + */ +- (BOOL)loadedWithVastProperties:(OMIDKontextsoVASTProperties *_Nonnull)vastProperties + error:(NSError *_Nullable *_Nullable)error; +@end diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDAdSession.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDAdSession.h new file mode 100644 index 00000000..27b540fe --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDAdSession.h @@ -0,0 +1,134 @@ +// +// OMIDAdSession.h +// AppVerificationLibrary +// +// Created by Daria on 06/06/2017. +// + +#import +#import "OMIDAdSessionContext.h" +#import "OMIDAdSessionConfiguration.h" +#import "OMIDFriendlyObstructionType.h" + +NS_ASSUME_NONNULL_BEGIN + +/** + * List of supported error types. + */ +typedef NS_ENUM(NSUInteger, OMIDErrorType) { + /** + * The integration is publishing a "generic" error to verification scripts. + */ + OMIDErrorGeneric = 1, + /** + * The integration is publishing a "video" error to verification scripts. + */ + OMIDErrorMedia = 2 +}; + +/** + * Ad session API enabling the integration partner to notify OMID of key state relating to viewability calculations. + * In addition to viewability this API will also notify all verification providers of key ad session lifecycle events. + */ +@interface OMIDKontextsoAdSession : NSObject + +/** + * The AdSession configuration is used for check owners. + */ +@property(nonatomic, readonly) OMIDKontextsoAdSessionConfiguration *configuration; +/** + * The native view which is used for viewability tracking. + */ +@property(nonatomic, weak, nullable) UIView *mainAdView; + +/** + * Initializes new ad session supplying the context. + * + * Note that creating an OMIDAdSession sends a message to the OM SDK JS Service running in the + * webview. If the OM SDK JS Service has not loaded before the ad session is created, the + * message is lost, and the verification scripts will not receive any events. + * + * To prevent this, the implementation must wait until the webview finishes loading OM SDK + * JavaScript before creating the OMIDAdSession. The easiest way is to create the OMIDAdSession + * in a webview delegate callback (-[WKNavigationDelegate webView:didFinishNavigation:]. Alternatively, + * if an implementation can receive an HTML5 DOMContentLoaded event from the webview, it can create + * the OMIDAdSession in a message handler for that event. + * + * @param context The context that provides the required information for initialising the ad session. + * @return A new OMIDAdSession instance, or nil if the supplied context is nil. + */ +- (nullable instancetype)initWithConfiguration:(OMIDKontextsoAdSessionConfiguration *)configuration + adSessionContext:(OMIDKontextsoAdSessionContext *)context + error:(NSError *_Nullable *_Nullable)error; + + +/** + * Notifies all verification providers that the ad session has started and ad view tracking will begin. + * + * This method will have no affect if called after the ad session has finished. + */ +- (void)start; + +/** + * Notifies all verification providers that the ad session has finished and all ad view tracking will stop. + * + * This method will have no affect if called after the ad session has finished. + * + * Note that ending an OMID ad session sends a message to the verification scripts running inside + * the webview supplied by the integration. So that the verification scripts have enough time to + * handle the 'sessionFinish' event, the integration must maintain a strong reference to the webview + * for at least 1.0 seconds after ending the session. + */ +- (void)finish; + +/** + * Adds friendly obstruction which should then be excluded from all ad session viewability calculations. + * It also provides a purpose and detailed reason string to pass forward to the measurement vendors. + * + * This method will have no affect if called after the ad session has finished. + * + * @param friendlyObstruction The view to be excluded from all ad session viewability calculations. + * @param purpose The purpose of why this obstruction was necessary. + * @param detailedReason An explanation for why this obstruction is part of the ad experience if not already + * obvious from the purpose. Can be nil. If not nil, must be 50 characters or less and only contain characers + * `A-z`, `0-9`, or spaces. + * @return Whether this friendly obstruction was successfully added. If the session has finished or the + * friendlyObstruction has already been added for this session, this method will return NO with no associated + * error object. However, if one or more arguments are against requirements, it will return NO with an error + * object assigned. + */ +- (BOOL)addFriendlyObstruction:(UIView *)friendlyObstruction + purpose:(OMIDFriendlyObstructionType)purpose + detailedReason:(nullable NSString *)detailedReason + error:(NSError *_Nullable *_Nullable)error; + +/** + * Removes registered friendly obstruction. + * + * This method will have no affect if called after the ad session has finished. + * + * @param friendlyObstruction The view to be removed from the list of registered friendly obstructions. + */ +- (void)removeFriendlyObstruction:(UIView *)friendlyObstruction; + +/** + * Utility method to remove all registered friendly obstructions. + * + * This method will have no affect if called after the ad session has finished. + */ +- (void)removeAllFriendlyObstructions; + +/** + * Notifies the ad session that an error has occurred. + * + * When triggered all registered verification providers will be notified of this event. + * + * @param errorType The type of error. + * @param message The message containing details of the error. + */ +- (void)logErrorWithType:(OMIDErrorType)errorType message:(NSString *)message +NS_SWIFT_NAME(logError(withType:message:)); + +@end + +NS_ASSUME_NONNULL_END diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDAdSessionConfiguration.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDAdSessionConfiguration.h new file mode 100644 index 00000000..099bf14a --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDAdSessionConfiguration.h @@ -0,0 +1,135 @@ +// +// OMIDAdSessionConfiguration.h +// AppVerificationLibrary +// +// Created by Saraev Vyacheslav on 15/09/2017. +// + +#import + +/** + * Identifies which integration layer is responsible for sending certain events. + */ +typedef NS_ENUM(NSUInteger, OMIDOwner) { + /** The integration will send the event from a JavaScript session script. */ + OMIDJavaScriptOwner = 1, + /** The integration will send the event from the native layer. */ + OMIDNativeOwner = 2, + /** The integration will not send the event. */ + OMIDNoneOwner = 3 +}; + + +/** + * List of supported creative types. + */ +typedef NS_ENUM(NSUInteger, OMIDCreativeType) { + /** + * Creative type will be set by JavaScript session script. + * Integrations must also pass `OMIDJavaScriptOwner` for `impressionOwner`. + */ + OMIDCreativeTypeDefinedByJavaScript = 1, + // Remaining values set creative type in native layer. + /** + * Rendered in webview, verification code can be inside creative or in metadata. + */ + OMIDCreativeTypeHtmlDisplay = 2, + /** + * Rendered by native, verification code provided in metadata only. + */ + OMIDCreativeTypeNativeDisplay = 3, + /** + * Rendered instream or as standalone video, verification code provided in metadata. + */ + OMIDCreativeTypeVideo = 4, + /** + * Similar to video but only contains audio media. + */ + OMIDCreativeTypeAudio = 5 +}; + +/** + * The criterion for an ad session's OMID impression event. + * Declaring an impression type makes it easier to understand discrepancies between measurers + * of the ad session, since many metrics depend on impressions. + */ +typedef NS_ENUM(NSUInteger, OMIDImpressionType) { + /** + * ImpressionType will be set by JavaScript session script. + * Integrations must also pass `OMIDJavaScriptOwner` for `impressionOwner`. + */ + OMIDImpressionTypeDefinedByJavaScript = 1, + // Remaining values set ImpressionType in native layer. + /** + * The integration is not declaring the criteria for the OMID impression. + */ + OMIDImpressionTypeUnspecified = 2, + /** + * The integration is using count-on-download criteria for the OMID impression. + */ + OMIDImpressionTypeLoaded = 3, + /** + * The integration is using begin-to-render criteria for the OMID impression. + */ + OMIDImpressionTypeBeginToRender = 4, + /** + * The integration is using one-pixel criteria (when the creative has at least 1 visible pixel on + * screen) for the OMID impression. + */ + OMIDImpressionTypeOnePixel = 5, + /** + * The integration is using viewable criteria (1 second for display, 2 seconds while playing for + * video, and at least 50% of the creative is visible) for the OMID impression. + */ + OMIDImpressionTypeViewable = 6, + /** + * The integration is using audible criteria (2 continuous second of media playback with non-zero + * volume) for the OMID impression. + */ + OMIDImpressionTypeAudible = 7, + /** + * The integration's criteria uses none of the above criteria for the OMID impression. + */ + OMIDImpressionTypeOther = 8 +}; + +/** + * The ad session configuration supplies the owner for both the impression and video events. + * The OM SDK JS service will use this information to help identify where the source of these + * events is expected to be received. + */ +@interface OMIDKontextsoAdSessionConfiguration : NSObject + +@property OMIDCreativeType creativeType; +@property OMIDImpressionType impressionType; +@property OMIDOwner impressionOwner; +@property OMIDOwner mediaEventsOwner; +@property BOOL isolateVerificationScripts; + +/** + * Create new ad session configuration supplying the owner for both the impression and media + * events along with the type of creative being rendered/measured. + * The OM SDK JS service will use this information to help identify where the source of these + * events is expected to be received. + * @param creativeType the type of creative to be rendered in this session. + * @param impressionType the type of impression to be triggered in this session. + * @param impressionOwner whether the native or JavaScript layer should be responsible for supplying + * the impression event. + * @param mediaEventsOwner whether the native or JavaScript layer should be responsible for + * supplying media events. This needs to be set only for non-display ad sessions and can be set to + * `OMIDNoneOwner` for display. When the creativeType is `OMIDCreativeTypeDefinedByJavaScript` then + * this should be set to `OMIDJavaScriptOwner` + * @param isolateVerificationScripts determines whether verification scripts will be placed in a + * sandboxed environment. This will not have any effect for native sessions. + * @return A new session configuration instance. Returns nil and sets error if OM SDK isn't active + * or arguments are invalid. + */ +- (nullable instancetype)initWithCreativeType:(OMIDCreativeType)creativeType + impressionType:(OMIDImpressionType)impressionType + impressionOwner:(OMIDOwner)impressionOwner + mediaEventsOwner:(OMIDOwner)mediaEventsOwner + isolateVerificationScripts:(BOOL)isolateVerificationScripts + error:(NSError *_Nullable *_Nullable)error; + +@end + diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDAdSessionContext.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDAdSessionContext.h new file mode 100644 index 00000000..e31cbf1c --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDAdSessionContext.h @@ -0,0 +1,126 @@ +// +// Created by Daria Sukhonosova on 19/04/16. +// + +#import + +#if !(TARGET_OS_TV) +#import +#endif + +#import "OMIDPartner.h" +#import "OMIDUniversalAdID.h" +#import "OMIDVerificationScriptResource.h" + +NS_ASSUME_NONNULL_BEGIN + +/** + * Provides the ad session with details of the partner and whether to an HTML, + * JavaScript, or native session. + */ +@interface OMIDKontextsoAdSessionContext : NSObject + +- (null_unspecified instancetype)init NS_UNAVAILABLE; + +#if !(TARGET_OS_TV) + +/** + * Initializes a new ad session context providing reference to partner and web view where + * the OM SDK JavaScript service has been injected. + * + * Calling this method will set the ad session type to `html`. + *

+ * NOTE: any attempt to create a new ad session will fail if OM SDK has not been + * activated (see {@link OMIDSDK} class for more information). + * + * @param partner Details of the integration partner responsible for the ad session. + * @param webView The WKWebView responsible for serving the ad content. The receiver holds a weak reference only. + * @param contentUrl contains the universal link to the ad's screen. + * @return A new HTML context instance. Returns nil if OM SDK has not been activated or if + * any of the parameters are nil. + * @see OMIDSDK + */ +- (nullable instancetype)initWithPartner:(OMIDKontextsoPartner *)partner + webView:(WKWebView *)webView + contentUrl:(nullable NSString *)contentUrl + customReferenceIdentifier:(nullable NSString *)customReferenceIdentifier + error:(NSError *_Nullable *_Nullable)error; +#endif + +/** + * Initializes a new ad session context providing reference to partner and a list of + * script resources which should be managed by OMID. + * + * Calling this method will set the ad session type to `native`. + *

+ * NOTE: any attempt to create a new ad session will fail if OMID has not been activated + * (see {@link OMIDSDK} class for more information). + * + * @param partner Details of the integration partner responsible for the ad session. + * @param resources The array of all verification providers who expect to receive OMID + * event data. Must contain at least one verification script. The receiver creates a + * deep copy of the array. + * @param contentUrl contains the universal link to the ad's screen. + * @return A new native context instance. Returns nil if OMID has not been activated or if any of the parameters are invalid. + * @see OMIDSDK + */ +- (nullable instancetype)initWithPartner:(OMIDKontextsoPartner *)partner + script:(NSString *)script + resources:(NSArray *)resources + contentUrl:(nullable NSString *)contentUrl + customReferenceIdentifier:(nullable NSString *)customReferenceIdentifier + error:(NSError *_Nullable *_Nullable)error; + +/** + * Initializes a new ad session context providing reference to partner, an optional universalAdID and a list of + * script resources which should be managed by OMID. + * + * Calling this method will set the ad session type to `native`. + *

+ * NOTE: any attempt to create a new ad session will fail if OMID has not been activated + * (see {@link OMIDSDK} class for more information). + * + * @param partner Details of the integration partner responsible for the ad session. + * @param resources The array of all verification providers who expect to receive OMID + * event data. Must contain at least one verification script. The receiver creates a + * deep copy of the array. + * @param contentUrl contains the universal link to the ad's screen. + * @param universalAdID optional identifier for an ad creative. See {@link OMIDUniversalAdID} class for more information. + * @return A new native context instance. Returns nil if OMID has not been activated or if any of the required parameters are invalid. + * @see OMIDSDK + */ +- (nullable instancetype)initWithPartner:(OMIDKontextsoPartner *)partner + script:(NSString *)script + resources:(NSArray *)resources + contentUrl:(nullable NSString *)contentUrl + customReferenceIdentifier:(nullable NSString *)customReferenceIdentifier + universalAdID:(nullable OMIDKontextsoUniversalAdID *)universalAdID + error:(NSError *_Nullable *_Nullable)error; + +#if !(TARGET_OS_TV) +/** + * Initializes a new ad session context providing reference to partner and web view where + * OM SDK JavaScript service has been injected. + * + * Calling this method will set the ad session type to `javascript`. + *

+ * NOTE: any attempt to create a new ad session will fail if OMID has not been activated + * (see {@link OMIDSDK} class for more information). + * + * @param partner Details of the integration partner responsible for the ad session. + * @param webView The WKWebView responsible for serving the ad content. The receiver holds a weak reference only. + * @param contentUrl contains the universal link to the ad's screen. + * @return A new JavaScript context instance. Returns nil if OM SDK has not been + * activated or if any of the parameters are invalid. + * @see OMIDSDK + */ +- (nullable instancetype)initWithPartner:(OMIDKontextsoPartner *)partner + javaScriptWebView:(WKWebView *)webView + contentUrl:(nullable NSString *)contentUrl + customReferenceIdentifier:(nullable NSString *)customReferenceIdentifier + error:(NSError *_Nullable *_Nullable)error; +#endif + +@end + +NS_ASSUME_NONNULL_END diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDFriendlyObstructionType.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDFriendlyObstructionType.h new file mode 100644 index 00000000..ee7bc6ac --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDFriendlyObstructionType.h @@ -0,0 +1,30 @@ +// +// OMIDFriendlyObstructionType.h +// AppVerificationLibrary +// +// Created by Andrew Whitcomb on 4/3/19. +// Copyright © 2019 Integral Ad Science, Inc. All rights reserved. +// + +/** + * List of allowed friendly obstruction purposes. + */ +typedef NS_ENUM(NSUInteger, OMIDFriendlyObstructionType) { + /** + * The friendly obstruction relates to interacting with a video (such as play/pause buttons). + */ + OMIDFriendlyObstructionMediaControls, + /** + * The friendly obstruction relates to closing an ad (such as a close button). + */ + OMIDFriendlyObstructionCloseAd, + /** + * The friendly obstruction is not visibly obstructing the ad but may seem so due to technical + * limitations. + */ + OMIDFriendlyObstructionNotVisible, + /** + * The friendly obstruction is obstructing for any purpose not already described. + */ + OMIDFriendlyObstructionOther +}; diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDImports.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDImports.h new file mode 100644 index 00000000..cec63730 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDImports.h @@ -0,0 +1,10 @@ +#import "OMIDSDK.h" +#import "OMIDScriptInjector.h" +#import "OMIDPartner.h" +#import "OMIDVerificationScriptResource.h" +#import "OMIDAdSessionContext.h" +#import "OMIDAdSession.h" +#import "OMIDAdEvents.h" +#import "OMIDVASTProperties.h" +#import "OMIDMediaEvents.h" +#import "OMIDJavaScriptSessionService.h" diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDJavaScriptSessionService.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDJavaScriptSessionService.h new file mode 100644 index 00000000..4bd74871 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDJavaScriptSessionService.h @@ -0,0 +1,109 @@ +#include +#if !(TARGET_OS_TV) + +#import +#import +#import "OMIDFriendlyObstructionType.h" +#import "OMIDPartner.h" + +NS_ASSUME_NONNULL_BEGIN + +/** + * Service supporting ad sessions managed (started/finished) via JavaScript Session Client APIs + * by providing native-layer measurement signals. + * If the JS Session Client is running in a web view, an instance of this service must be + * initialized with the web view before starting or finishing ad sessions using JS APIs. + * Only one instance of this service may be initialized at a time for a given web view; to reuse a + * web view the current instance must be torn down (see `tearDownWithCompletion`). + */ +@interface OMIDKontextsoJavaScriptSessionService : NSObject + +/** + * Initializes an instance of the service. + * + * @param partner Details of the integration partner responsible for ad sessions. + * @param webView The web view responsible for starting/finishing ad sessions via the JS Session + * Client. + * @param isHTMLAdView Whether the ad is rendered in HTML inside of the provided web view. + * If true, all ad sessions will be of type "html" and calling `setAdView` is + * not required. + * If false, all ad sessions will be of type "javascript" and `setAdView` must + * be called after initialization. + */ +- (nullable instancetype)initWithPartner:(OMIDKontextsoPartner *)partner + webView:(WKWebView *)webView + isHTMLAdView:(BOOL)isHTMLAdView + error:(NSError *_Nullable *_Nullable)error; + +/** + * Tears down this instance of the service. + * Calling this method will cause OM SDK to begin a teardown process including finishing all currently + * active ad sessions measured by this service instance and tearing down communication with the OM + * SDK's JavaScript layer running in the web view. + * This may require up to one second, for example in order to allow verification scripts time to process + * the `sessionFinish` event. + * Once this process has completed, the web view may be torn down or reused for another instance of + * the service without any adverse effects. If there is no need to tear down or reuse the web view, this + * method is not required. + * @param completionBlock Invoked by OM SDK after the teardown process has completed, + * or one second, whichever comes sooner. + */ +- (void)tearDownWithCompletion:(void (^)(BOOL success, NSError *_Nullable error))completionBlock; + +/** + * The native view containing the ad. + * This property is readonly and must be set using `setAdView`. + * If `isHTMLAdView` was passed as true in `initWithPartner`, this will equal + * the web view by default. + */ +@property(readonly, nonatomic, weak) UIView *adView; + +/** + * Sets the native view that contains the ad and is used for viewability tracking. + * If `isHTMLAdView` was passed as true in `initWithPartner`, this method is + * not required since the ad view will be set to the web view by default. + * @param adView The native view. + * @return Whether the ad view was successfully set. + */ +- (BOOL)setAdView:(nullable UIView *)adView + error:(NSError **)error; + +/** + * Adds a friendly obstruction which should then be excluded from all ad session viewability + * calculations. While this instance of OMIDJavaScriptSessionService is running, this friendly + * obstruction will be added to each ad session started by the integrator via the JS Session Client + * until the obstruction is removed by calling `removeFriendlyObstruction` or + * `removeAllFriendlyObstructions`. + * + * @param friendlyObstruction The view to be excluded from all ad session viewability calculations. + * @param purpose The purpose of why this obstruction was necessary. + * @param detailedReason An explanation for why this obstruction is part of the ad experience if not + * already obvious from the purpose. Can be nil. If not nil, must be 50 characters or less and only + * contain characters `A-z`, `0-9`, or spaces. + * @return Whether this friendly obstruction was successfully added. If the friendlyObstruction has + * already been added for this session, this method will return NO with no associated error object. + * However, if one or more arguments are against requirements, it will return NO with an error + * object assigned. + */ +- (BOOL)addFriendlyObstruction:(UIView *)friendlyObstruction + purpose:(OMIDFriendlyObstructionType)purpose + detailedReason:(nullable NSString *)detailedReason + error:(NSError *_Nullable *_Nullable)error; + +/** + * Removes a registered friendly obstruction from any currently running and future ad sessions + * measured by this instance of OMIDJavaScriptSessionService. + */ +- (void)removeFriendlyObstruction:(UIView *)friendlyObstruction; + +/** + * Removes all registered friendly obstructions from any currently running and future ad sessions + * measured by this instance of OMIDJavaScriptSessionService. + */ +- (void)removeAllFriendlyObstructions; + +@end + +NS_ASSUME_NONNULL_END + +#endif diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDMediaEvents.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDMediaEvents.h new file mode 100644 index 00000000..76f3cca6 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDMediaEvents.h @@ -0,0 +1,155 @@ +// +// OMIDMediaEvents.h +// AppVerificationLibrary +// +// Created by Justin Hines on 6/13/19. +// + +#import +#import "OMIDAdSession.h" +#import "OMIDVASTProperties.h" + +/** + * List of supported media event player states. + */ +typedef NS_ENUM(NSUInteger, OMIDPlayerState) { + /** + * The player is collapsed in such a way that the video is hidden. + * The video may or may not still be progressing in this state, and sound may be audible. + * This refers specifically to the video player state on the page, and not the state of + * the browser window. + */ + OMIDPlayerStateMinimized, + /** + * The player has been reduced from its original size. + * The video is still potentially visible. + */ + OMIDPlayerStateCollapsed, + /** + * The player's default playback size. + */ + OMIDPlayerStateNormal, + /** + * The player has expanded from its original size. + */ + OMIDPlayerStateExpanded, + /** + * The player has entered fullscreen mode. + */ + OMIDPlayerStateFullscreen +}; + +/** + * List of supported media event user interaction types. + */ +typedef NS_ENUM(NSUInteger, OMIDInteractionType) { + /** + * The user clicked to load the ad's landing page. + */ + OMIDInteractionTypeClick, + /** + * The user engaged with ad content to load a separate experience. + */ + OMIDInteractionTypeAcceptInvitation +}; + +/** + * This provides a complete list of native media events supported by OMID. + * Using this event API assumes the media player is fully responsible for communicating all media events at the appropriate times. + * Only one media events implementation can be associated with the ad session and any attempt to create multiple instances will result in an error. + */ +@interface OMIDKontextsoMediaEvents : NSObject + +/** + * Initializes media events instance for the associated ad session. + * Any attempt to create a media events instance will fail if the supplied ad session has already started. + * + * @param session The ad session associated with the ad events. + * @return A new media events instance. Returns nil if the supplied ad session is nil or if a media events instance has already been registered with the ad session or if a media events instance has been created after the ad session has started. + * @see OMIDAdSession + */ +- (nullable instancetype)initWithAdSession:(nonnull OMIDKontextsoAdSession *)session error:(NSError *_Nullable *_Nullable)error; + +/** + * Notifies all media listeners that media content has started playing. + * + * @param duration The duration of the selected media (in seconds). + * @param mediaPlayerVolume The volume from the native media player with a range between 0 and 1. + */ +- (void)startWithDuration:(CGFloat)duration + mediaPlayerVolume:(CGFloat)mediaPlayerVolume; + +/** + * Notifies all media listeners that media playback has reached the first quartile. + */ +- (void)firstQuartile; + +/** + * Notifies all media listeners that media playback has reached the midpoint. + */ +- (void)midpoint; + +/** + * Notifies all media listeners that media playback has reached the third quartile. + */ +- (void)thirdQuartile; + +/** + * Notifies all media listeners that media playback is complete. + */ +- (void)complete; + +/** + * Notifies all media listeners that media playback has paused after a user interaction. + */ +- (void)pause; + +/** + * Notifies all media listeners that media playback has resumed after being paused. + */ +- (void)resume; + +/** + * Notifies all media listeners that media playback has stopped as a user skip interaction. + * Once skipped, it should not be possible for the media to resume playing content. + */ +- (void)skipped; + +/** + * Notifies all media listeners that media playback has stopped and started buffering. + */ +- (void)bufferStart; + +/** + * Notifies all media listeners that buffering has finished and media playback has resumed. + */ +- (void)bufferFinish; + +/** + * Notifies all media listeners that the media player volume has changed. + * + * @param playerVolume The volume from the native media player with a range between 0 and 1. + */ +- (void)volumeChangeTo:(CGFloat)playerVolume; + +/** + * Notifies all media listeners that media player state has changed. + * See `OMIDPlayerState` for list of supported states. + * + * @param playerState The latest media player state. + * @see OMIDPlayerState + */ +- (void)playerStateChangeTo:(OMIDPlayerState)playerState; + +/** + * Notifies all media listeners that the user has performed an ad interaction. + * See `OMIDInteractionType` for a list of supported types. + * + * @param interactionType The latest user integration. + * @see OMIDInteractionType + */ +- (void)adUserInteractionWithType:(OMIDInteractionType)interactionType +NS_SWIFT_NAME(adUserInteraction(withType:)); + +@end + diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDPartner.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDPartner.h new file mode 100644 index 00000000..b54556dc --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDPartner.h @@ -0,0 +1,32 @@ +// +// OMIDPartner.h +// AppVerificationLibrary +// +// Created by Daria on 06/06/2017. +// + +#import + +/** + * Details about the integration partner which will be supplied to the ad session. + */ +@interface OMIDKontextsoPartner : NSObject + +@property(nonatomic, readonly, nonnull) NSString *name; +@property(nonatomic, readonly, nonnull) NSString *versionString; + +/** + * Initializes new partner instance providing both name and versionString. + * + * Both name and version are mandatory. + * + * @param name It is used to uniquely identify the integration partner. + * @param versionString It is used to uniquely identify the integration partner. + * @return A new partner instance, or nil if any of the parameters are either null or blank + */ +- (nullable instancetype)initWithName:(nonnull NSString *)name + versionString:(nonnull NSString *)versionString; + +- (null_unspecified instancetype)init NS_UNAVAILABLE; + +@end diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDSDK.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDSDK.h new file mode 100644 index 00000000..daa9820b --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDSDK.h @@ -0,0 +1,58 @@ +// +// OMIDSDK.h +// AppVerificationLibrary +// +// Created by Daria on 05/06/2017. +// + +#import + +NS_ASSUME_NONNULL_BEGIN + +/** + * This application level class will be called by all integration partners to ensure OM SDK has been activated before calling any other API methods. + * Any attempt to use other API methods prior to activation will result in an error. + * + * Note that OM SDK may only be used on the main UI thread. + * Make sure you are on the main thread when you initialize the SDK, create its + * objects, and invoke its methods. + */ +@interface OMIDKontextsoSDK : NSObject + +/** + * The current semantic version of the integrated OMID library. + */ ++ (NSString *)versionString; + +/** + * Shared OMIDSDK instance. + */ +@property(class, readonly) OMIDKontextsoSDK *sharedInstance +NS_SWIFT_NAME(shared); + +/** + * A Boolean value indicating whether OM SDK has been activated. + * + * @discussion Check that OM SDK is active prior to creating any ad sessions. + */ +@property(atomic, readonly, getter=isActive) BOOL active; + +/** + * Activate OM SDK before calling other API methods. + * + * @discussion Activation sets up the OM SDK environment. In CTV apps (running tvOS), `activate` should be called on launch in + * order to capture a "last activity" timestamp on launch and each time the user foregrounds the app). + * + * @return Boolean indicating success. + */ +- (BOOL)activate; + +/** + * Update the last activity time + * After activating OM SDK in CTV apps, refresh the "last activity" timestamp in response to user input prior to starting an ad session. + */ +- (void)updateLastActivity; + +@end + +NS_ASSUME_NONNULL_END diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDScriptInjector.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDScriptInjector.h new file mode 100644 index 00000000..f6dd4572 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDScriptInjector.h @@ -0,0 +1,26 @@ +// +// OMIDScriptInjector.h +// AppVerificationLibrary +// +// Created by Daria on 21/06/2017. +// + +#import + +/** + * Utility class which enables integration partners to use a standard approach for injecting OM SDK JS into the served tag HTML content. + */ +@interface OMIDKontextsoScriptInjector : NSObject + +/* + Injects the downloaded OMID JS content into the served HTML. + @param scriptContent containing the OMID JS service content to be injected into the hidden tracking web view. + @param html of the tag content which should be modified to include the downloaded OMID JS content. + @param error If an error occurs, contains an NSError object. + @return modified HTML including OMID JS or nil if an error occurs. + */ ++ (nullable NSString *)injectScriptContent:(nonnull NSString *)scriptContent + intoHTML:(nonnull NSString *)html + error:(NSError *_Nullable *_Nullable)error; + +@end diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDUniversalAdID.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDUniversalAdID.h new file mode 100644 index 00000000..25fb50d5 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDUniversalAdID.h @@ -0,0 +1,40 @@ +// +// OMIDUniversalAdID.h +// AppVerificationLibrary +// +// Created by Teodor Cristea on 31.03.2025. +// Copyright © 2025 IAB Techlab. All rights reserved. +// + +#import + +NS_ASSUME_NONNULL_BEGIN + +/** + * Details about the UniversalAdID for the purpose of tracking ad creatives which will be supplied to the ad session. + */ +@interface OMIDKontextsoUniversalAdID : NSObject + +@property(nonatomic, readonly, nonnull) NSString *value; +@property(nonatomic, readonly, nonnull) NSString *idRegistry; + +/** + * Initializes new UniversalAdID instance providing both value and idRegistry. + * The UniversalAdID's purpose is to identify an ad creative across different platforms throughout the lifecycle of an advertising campaign. + * + * Both value and idRegistry are mandatory. + * + * @param value It is used to identify the unique creative identifier. + * @param idRegistry It is used to identify the URL for the registry website where the unique creative ID is cataloged. + * @return A new UniversalAdID instance, or nil if any of the parameters are either null or blank + */ +- (nullable instancetype)initWithValue:(nonnull NSString *)value + idRegistry:(nonnull NSString *)idRegistry + error:(NSError *_Nullable *_Nullable)error; + ++ (instancetype)new NS_UNAVAILABLE; +- (null_unspecified instancetype)init NS_UNAVAILABLE; + +@end + +NS_ASSUME_NONNULL_END diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDVASTProperties.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDVASTProperties.h new file mode 100644 index 00000000..5874fbd1 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDVASTProperties.h @@ -0,0 +1,71 @@ +// +// OMIDVASTProperties.h +// AppVerificationLibrary +// +// Created by Daria Sukhonosova on 30/06/2017. +// + +#import + +/** + * List of supported media player positions. + */ +typedef NS_ENUM(NSUInteger, OMIDPosition) { + /** + * The ad plays preceding video content. + */ + OMIDPositionPreroll, + /** + * The ad plays in the middle of video content, or between two separate content videos. + */ + OMIDPositionMidroll, + /** + * The ad plays following video content. + */ + OMIDPositionPostroll, + /** + * The ad plays independently of any video content. + */ + OMIDPositionStandalone +}; + +/** + * This object is used to capture key VAST properties so this can be shared with all registered verification providers. + */ +@interface OMIDKontextsoVASTProperties : NSObject + +@property(nonatomic, readonly, getter = isSkippable) BOOL skippable; +@property(nonatomic, readonly) CGFloat skipOffset; +@property(nonatomic, readonly, getter = isAutoPlay) BOOL autoPlay; +@property(nonatomic, readonly) OMIDPosition position; + +/** + * This method enables the media player to create a new VAST properties instance for skippable media ad placement. + * + * @param skipOffset The number of seconds before the skip button is presented. + * @param autoPlay Determines whether the media will auto-play content. + * @param position The position of the media in relation to other content. + * @return A new instance of VAST properties. + */ +- (nonnull instancetype)initWithSkipOffset:(CGFloat)skipOffset + autoPlay:(BOOL)autoPlay + position:(OMIDPosition)position; + +/** + * This method enables the media player to create a new VAST properties instance for non-skippable media ad placement. + * + * @param autoPlay Determines whether the media will auto-play content. + * @param position The position of the media in relation to other content. + * @return A new instance of VAST properties. + */ +- (nonnull instancetype)initWithAutoPlay:(BOOL)autoPlay + position:(OMIDPosition)position; + +- (null_unspecified instancetype)init NS_UNAVAILABLE; + +/** + * For OM SDK internal use only. + */ +- (NSDictionary *_Nonnull)toJSON; + +@end diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDVerificationScriptResource.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDVerificationScriptResource.h new file mode 100644 index 00000000..c43451a3 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMIDVerificationScriptResource.h @@ -0,0 +1,45 @@ +// +// OMIDVerificationScriptResource.h +// AppVerificationLibrary +// +// Created by Daria on 06/06/2017. +// + +#import + +/** + * Details about the verification provider which will be supplied to the ad session. + */ +@interface OMIDKontextsoVerificationScriptResource : NSObject + +@property(nonatomic, readonly, nonnull) NSURL *URL; +@property(nonatomic, readonly, nullable) NSString *vendorKey; +@property(nonatomic, readonly, nullable) NSString *parameters; + +/** + * Initializes new verification script resource instance which requires vendor specific verification parameters. + * + * When calling this method all arguments are mandatory. + * + * @param vendorKey It is used to uniquely identify the verification provider. + * @param URL The URL to be injected into the OMID managed JavaScript execution environment. + * @param parameters The parameters which the verification provider script is expecting for the ad session. + * @return A new verification script resource instance, or nil if any of the parameters are either null or blank. + */ +- (nullable instancetype)initWithURL:(nonnull NSURL *)URL + vendorKey:(nonnull NSString *)vendorKey + parameters:(nonnull NSString *)parameters; + +/** + * Initializes new verification script resource instance which does not require any vendor specific verification parameters. + * + * When calling this method all arguments are mandatory. + * + * @param URL The URL to be injected into the OMID managed JavaScript execution environment. + * @return A new verification script resource instance, or nil if URL is nil or blank. + */ +- (nullable instancetype)initWithURL:(nonnull NSURL *)URL; + +- (null_unspecified instancetype)init NS_UNAVAILABLE; + +@end diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMSDK.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMSDK.h new file mode 100644 index 00000000..bc3714ad --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Headers/OMSDK.h @@ -0,0 +1,18 @@ +// +// OMSDK.h +// OMSDK +// +// Created by Nathanael Hardy on 10/16/20. +// + +#import + +//! Project version number for OMSDK. +FOUNDATION_EXPORT double OMSDKVersionNumber; + +//! Project version string for OMSDK. +FOUNDATION_EXPORT const unsigned char OMSDKVersionString[]; + +// In this header, you should import all the public headers of your framework using statements like #import + +#import diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Info.plist b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Info.plist new file mode 100644 index 00000000..bf4daa72 Binary files /dev/null and b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Info.plist differ diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Modules/module.modulemap b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Modules/module.modulemap new file mode 100644 index 00000000..078b6857 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/Modules/module.modulemap @@ -0,0 +1,4 @@ +module OMSDK_Kontextso { + header "Headers/OMIDImports.h" + export * +} diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/OMSDK_Kontextso b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/OMSDK_Kontextso new file mode 100755 index 00000000..168dd32f Binary files /dev/null and b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/OMSDK_Kontextso differ diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/PrivacyInfo.xcprivacy b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/PrivacyInfo.xcprivacy new file mode 100644 index 00000000..5ab7e387 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64/OMSDK_Kontextso.framework/PrivacyInfo.xcprivacy @@ -0,0 +1,42 @@ + + + + + + NSPrivacyCollectedDataTypes + + + NSPrivacyCollectedDataType + NSPrivacyCollectedDataTypeProductInteraction + NSPrivacyCollectedDataTypeLinked + + NSPrivacyCollectedDataTypeTracking + + NSPrivacyCollectedDataTypePurposes + + NSPrivacyCollectedDataTypePurposeThirdPartyAdvertising + NSPrivacyCollectedDataTypePurposeDeveloperAdvertising + + + + NSPrivacyCollectedDataType + NSPrivacyCollectedDataTypeAdvertisingData + NSPrivacyCollectedDataTypeLinked + + NSPrivacyCollectedDataTypeTracking + + NSPrivacyCollectedDataTypePurposes + + NSPrivacyCollectedDataTypePurposeThirdPartyAdvertising + NSPrivacyCollectedDataTypePurposeDeveloperAdvertising + + + + + diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDAdEvents.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDAdEvents.h new file mode 100644 index 00000000..f54d6533 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDAdEvents.h @@ -0,0 +1,50 @@ +// +// OMIDAdEvents.h +// AppVerificationLibrary +// +// Created by Daria Sukhonosova on 22/06/2017. +// + +#import +#import "OMIDAdSession.h" +#import "OMIDVASTProperties.h" + +/** + * Ad event API enabling the integration partner to signal to all verification providers when key events have occurred. + * Only one ad events implementation can be associated with the ad session and any attempt to create multiple instances will result in an error. + */ +@interface OMIDKontextsoAdEvents : NSObject + +/** + * Initializes ad events instance associated with the supplied ad session. + * + * @param session The ad session associated with the ad events. + * @return A new ad events instance associated with the supplied ad session. Returns nil if the supplied ad session is nil or if an ad events instance has already been registered with the ad session. + */ +- (nullable instancetype)initWithAdSession:(nonnull OMIDKontextsoAdSession *)session error:(NSError * _Nullable * _Nullable)error; + +/** + * Notifies the ad session that an impression event has occurred. + * + * When triggered all registered verification providers will be notified of this event. + * + * NOTE: the ad session will be automatically started if this method has been called first. + */ +- (BOOL)impressionOccurredWithError:(NSError *_Nullable *_Nullable)error; + +/** + * Notifies the ad session that display loaded event has occurred. + * + * When triggered all registered verification providers will be notified of this event. + */ +- (BOOL)loadedWithError:(NSError *_Nullable *_Nullable)error; + +/** + * Notifies the ad session that video/audio loaded event has occurred. + * + * When triggered all registered verification providers will be notified of this event. + * @param vastProperties contains static information about the video/audio placement. + */ +- (BOOL)loadedWithVastProperties:(OMIDKontextsoVASTProperties *_Nonnull)vastProperties + error:(NSError *_Nullable *_Nullable)error; +@end diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDAdSession.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDAdSession.h new file mode 100644 index 00000000..27b540fe --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDAdSession.h @@ -0,0 +1,134 @@ +// +// OMIDAdSession.h +// AppVerificationLibrary +// +// Created by Daria on 06/06/2017. +// + +#import +#import "OMIDAdSessionContext.h" +#import "OMIDAdSessionConfiguration.h" +#import "OMIDFriendlyObstructionType.h" + +NS_ASSUME_NONNULL_BEGIN + +/** + * List of supported error types. + */ +typedef NS_ENUM(NSUInteger, OMIDErrorType) { + /** + * The integration is publishing a "generic" error to verification scripts. + */ + OMIDErrorGeneric = 1, + /** + * The integration is publishing a "video" error to verification scripts. + */ + OMIDErrorMedia = 2 +}; + +/** + * Ad session API enabling the integration partner to notify OMID of key state relating to viewability calculations. + * In addition to viewability this API will also notify all verification providers of key ad session lifecycle events. + */ +@interface OMIDKontextsoAdSession : NSObject + +/** + * The AdSession configuration is used for check owners. + */ +@property(nonatomic, readonly) OMIDKontextsoAdSessionConfiguration *configuration; +/** + * The native view which is used for viewability tracking. + */ +@property(nonatomic, weak, nullable) UIView *mainAdView; + +/** + * Initializes new ad session supplying the context. + * + * Note that creating an OMIDAdSession sends a message to the OM SDK JS Service running in the + * webview. If the OM SDK JS Service has not loaded before the ad session is created, the + * message is lost, and the verification scripts will not receive any events. + * + * To prevent this, the implementation must wait until the webview finishes loading OM SDK + * JavaScript before creating the OMIDAdSession. The easiest way is to create the OMIDAdSession + * in a webview delegate callback (-[WKNavigationDelegate webView:didFinishNavigation:]. Alternatively, + * if an implementation can receive an HTML5 DOMContentLoaded event from the webview, it can create + * the OMIDAdSession in a message handler for that event. + * + * @param context The context that provides the required information for initialising the ad session. + * @return A new OMIDAdSession instance, or nil if the supplied context is nil. + */ +- (nullable instancetype)initWithConfiguration:(OMIDKontextsoAdSessionConfiguration *)configuration + adSessionContext:(OMIDKontextsoAdSessionContext *)context + error:(NSError *_Nullable *_Nullable)error; + + +/** + * Notifies all verification providers that the ad session has started and ad view tracking will begin. + * + * This method will have no affect if called after the ad session has finished. + */ +- (void)start; + +/** + * Notifies all verification providers that the ad session has finished and all ad view tracking will stop. + * + * This method will have no affect if called after the ad session has finished. + * + * Note that ending an OMID ad session sends a message to the verification scripts running inside + * the webview supplied by the integration. So that the verification scripts have enough time to + * handle the 'sessionFinish' event, the integration must maintain a strong reference to the webview + * for at least 1.0 seconds after ending the session. + */ +- (void)finish; + +/** + * Adds friendly obstruction which should then be excluded from all ad session viewability calculations. + * It also provides a purpose and detailed reason string to pass forward to the measurement vendors. + * + * This method will have no affect if called after the ad session has finished. + * + * @param friendlyObstruction The view to be excluded from all ad session viewability calculations. + * @param purpose The purpose of why this obstruction was necessary. + * @param detailedReason An explanation for why this obstruction is part of the ad experience if not already + * obvious from the purpose. Can be nil. If not nil, must be 50 characters or less and only contain characers + * `A-z`, `0-9`, or spaces. + * @return Whether this friendly obstruction was successfully added. If the session has finished or the + * friendlyObstruction has already been added for this session, this method will return NO with no associated + * error object. However, if one or more arguments are against requirements, it will return NO with an error + * object assigned. + */ +- (BOOL)addFriendlyObstruction:(UIView *)friendlyObstruction + purpose:(OMIDFriendlyObstructionType)purpose + detailedReason:(nullable NSString *)detailedReason + error:(NSError *_Nullable *_Nullable)error; + +/** + * Removes registered friendly obstruction. + * + * This method will have no affect if called after the ad session has finished. + * + * @param friendlyObstruction The view to be removed from the list of registered friendly obstructions. + */ +- (void)removeFriendlyObstruction:(UIView *)friendlyObstruction; + +/** + * Utility method to remove all registered friendly obstructions. + * + * This method will have no affect if called after the ad session has finished. + */ +- (void)removeAllFriendlyObstructions; + +/** + * Notifies the ad session that an error has occurred. + * + * When triggered all registered verification providers will be notified of this event. + * + * @param errorType The type of error. + * @param message The message containing details of the error. + */ +- (void)logErrorWithType:(OMIDErrorType)errorType message:(NSString *)message +NS_SWIFT_NAME(logError(withType:message:)); + +@end + +NS_ASSUME_NONNULL_END diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDAdSessionConfiguration.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDAdSessionConfiguration.h new file mode 100644 index 00000000..099bf14a --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDAdSessionConfiguration.h @@ -0,0 +1,135 @@ +// +// OMIDAdSessionConfiguration.h +// AppVerificationLibrary +// +// Created by Saraev Vyacheslav on 15/09/2017. +// + +#import + +/** + * Identifies which integration layer is responsible for sending certain events. + */ +typedef NS_ENUM(NSUInteger, OMIDOwner) { + /** The integration will send the event from a JavaScript session script. */ + OMIDJavaScriptOwner = 1, + /** The integration will send the event from the native layer. */ + OMIDNativeOwner = 2, + /** The integration will not send the event. */ + OMIDNoneOwner = 3 +}; + + +/** + * List of supported creative types. + */ +typedef NS_ENUM(NSUInteger, OMIDCreativeType) { + /** + * Creative type will be set by JavaScript session script. + * Integrations must also pass `OMIDJavaScriptOwner` for `impressionOwner`. + */ + OMIDCreativeTypeDefinedByJavaScript = 1, + // Remaining values set creative type in native layer. + /** + * Rendered in webview, verification code can be inside creative or in metadata. + */ + OMIDCreativeTypeHtmlDisplay = 2, + /** + * Rendered by native, verification code provided in metadata only. + */ + OMIDCreativeTypeNativeDisplay = 3, + /** + * Rendered instream or as standalone video, verification code provided in metadata. + */ + OMIDCreativeTypeVideo = 4, + /** + * Similar to video but only contains audio media. + */ + OMIDCreativeTypeAudio = 5 +}; + +/** + * The criterion for an ad session's OMID impression event. + * Declaring an impression type makes it easier to understand discrepancies between measurers + * of the ad session, since many metrics depend on impressions. + */ +typedef NS_ENUM(NSUInteger, OMIDImpressionType) { + /** + * ImpressionType will be set by JavaScript session script. + * Integrations must also pass `OMIDJavaScriptOwner` for `impressionOwner`. + */ + OMIDImpressionTypeDefinedByJavaScript = 1, + // Remaining values set ImpressionType in native layer. + /** + * The integration is not declaring the criteria for the OMID impression. + */ + OMIDImpressionTypeUnspecified = 2, + /** + * The integration is using count-on-download criteria for the OMID impression. + */ + OMIDImpressionTypeLoaded = 3, + /** + * The integration is using begin-to-render criteria for the OMID impression. + */ + OMIDImpressionTypeBeginToRender = 4, + /** + * The integration is using one-pixel criteria (when the creative has at least 1 visible pixel on + * screen) for the OMID impression. + */ + OMIDImpressionTypeOnePixel = 5, + /** + * The integration is using viewable criteria (1 second for display, 2 seconds while playing for + * video, and at least 50% of the creative is visible) for the OMID impression. + */ + OMIDImpressionTypeViewable = 6, + /** + * The integration is using audible criteria (2 continuous second of media playback with non-zero + * volume) for the OMID impression. + */ + OMIDImpressionTypeAudible = 7, + /** + * The integration's criteria uses none of the above criteria for the OMID impression. + */ + OMIDImpressionTypeOther = 8 +}; + +/** + * The ad session configuration supplies the owner for both the impression and video events. + * The OM SDK JS service will use this information to help identify where the source of these + * events is expected to be received. + */ +@interface OMIDKontextsoAdSessionConfiguration : NSObject + +@property OMIDCreativeType creativeType; +@property OMIDImpressionType impressionType; +@property OMIDOwner impressionOwner; +@property OMIDOwner mediaEventsOwner; +@property BOOL isolateVerificationScripts; + +/** + * Create new ad session configuration supplying the owner for both the impression and media + * events along with the type of creative being rendered/measured. + * The OM SDK JS service will use this information to help identify where the source of these + * events is expected to be received. + * @param creativeType the type of creative to be rendered in this session. + * @param impressionType the type of impression to be triggered in this session. + * @param impressionOwner whether the native or JavaScript layer should be responsible for supplying + * the impression event. + * @param mediaEventsOwner whether the native or JavaScript layer should be responsible for + * supplying media events. This needs to be set only for non-display ad sessions and can be set to + * `OMIDNoneOwner` for display. When the creativeType is `OMIDCreativeTypeDefinedByJavaScript` then + * this should be set to `OMIDJavaScriptOwner` + * @param isolateVerificationScripts determines whether verification scripts will be placed in a + * sandboxed environment. This will not have any effect for native sessions. + * @return A new session configuration instance. Returns nil and sets error if OM SDK isn't active + * or arguments are invalid. + */ +- (nullable instancetype)initWithCreativeType:(OMIDCreativeType)creativeType + impressionType:(OMIDImpressionType)impressionType + impressionOwner:(OMIDOwner)impressionOwner + mediaEventsOwner:(OMIDOwner)mediaEventsOwner + isolateVerificationScripts:(BOOL)isolateVerificationScripts + error:(NSError *_Nullable *_Nullable)error; + +@end + diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDAdSessionContext.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDAdSessionContext.h new file mode 100644 index 00000000..e31cbf1c --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDAdSessionContext.h @@ -0,0 +1,126 @@ +// +// Created by Daria Sukhonosova on 19/04/16. +// + +#import + +#if !(TARGET_OS_TV) +#import +#endif + +#import "OMIDPartner.h" +#import "OMIDUniversalAdID.h" +#import "OMIDVerificationScriptResource.h" + +NS_ASSUME_NONNULL_BEGIN + +/** + * Provides the ad session with details of the partner and whether to an HTML, + * JavaScript, or native session. + */ +@interface OMIDKontextsoAdSessionContext : NSObject + +- (null_unspecified instancetype)init NS_UNAVAILABLE; + +#if !(TARGET_OS_TV) + +/** + * Initializes a new ad session context providing reference to partner and web view where + * the OM SDK JavaScript service has been injected. + * + * Calling this method will set the ad session type to `html`. + *

+ * NOTE: any attempt to create a new ad session will fail if OM SDK has not been + * activated (see {@link OMIDSDK} class for more information). + * + * @param partner Details of the integration partner responsible for the ad session. + * @param webView The WKWebView responsible for serving the ad content. The receiver holds a weak reference only. + * @param contentUrl contains the universal link to the ad's screen. + * @return A new HTML context instance. Returns nil if OM SDK has not been activated or if + * any of the parameters are nil. + * @see OMIDSDK + */ +- (nullable instancetype)initWithPartner:(OMIDKontextsoPartner *)partner + webView:(WKWebView *)webView + contentUrl:(nullable NSString *)contentUrl + customReferenceIdentifier:(nullable NSString *)customReferenceIdentifier + error:(NSError *_Nullable *_Nullable)error; +#endif + +/** + * Initializes a new ad session context providing reference to partner and a list of + * script resources which should be managed by OMID. + * + * Calling this method will set the ad session type to `native`. + *

+ * NOTE: any attempt to create a new ad session will fail if OMID has not been activated + * (see {@link OMIDSDK} class for more information). + * + * @param partner Details of the integration partner responsible for the ad session. + * @param resources The array of all verification providers who expect to receive OMID + * event data. Must contain at least one verification script. The receiver creates a + * deep copy of the array. + * @param contentUrl contains the universal link to the ad's screen. + * @return A new native context instance. Returns nil if OMID has not been activated or if any of the parameters are invalid. + * @see OMIDSDK + */ +- (nullable instancetype)initWithPartner:(OMIDKontextsoPartner *)partner + script:(NSString *)script + resources:(NSArray *)resources + contentUrl:(nullable NSString *)contentUrl + customReferenceIdentifier:(nullable NSString *)customReferenceIdentifier + error:(NSError *_Nullable *_Nullable)error; + +/** + * Initializes a new ad session context providing reference to partner, an optional universalAdID and a list of + * script resources which should be managed by OMID. + * + * Calling this method will set the ad session type to `native`. + *

+ * NOTE: any attempt to create a new ad session will fail if OMID has not been activated + * (see {@link OMIDSDK} class for more information). + * + * @param partner Details of the integration partner responsible for the ad session. + * @param resources The array of all verification providers who expect to receive OMID + * event data. Must contain at least one verification script. The receiver creates a + * deep copy of the array. + * @param contentUrl contains the universal link to the ad's screen. + * @param universalAdID optional identifier for an ad creative. See {@link OMIDUniversalAdID} class for more information. + * @return A new native context instance. Returns nil if OMID has not been activated or if any of the required parameters are invalid. + * @see OMIDSDK + */ +- (nullable instancetype)initWithPartner:(OMIDKontextsoPartner *)partner + script:(NSString *)script + resources:(NSArray *)resources + contentUrl:(nullable NSString *)contentUrl + customReferenceIdentifier:(nullable NSString *)customReferenceIdentifier + universalAdID:(nullable OMIDKontextsoUniversalAdID *)universalAdID + error:(NSError *_Nullable *_Nullable)error; + +#if !(TARGET_OS_TV) +/** + * Initializes a new ad session context providing reference to partner and web view where + * OM SDK JavaScript service has been injected. + * + * Calling this method will set the ad session type to `javascript`. + *

+ * NOTE: any attempt to create a new ad session will fail if OMID has not been activated + * (see {@link OMIDSDK} class for more information). + * + * @param partner Details of the integration partner responsible for the ad session. + * @param webView The WKWebView responsible for serving the ad content. The receiver holds a weak reference only. + * @param contentUrl contains the universal link to the ad's screen. + * @return A new JavaScript context instance. Returns nil if OM SDK has not been + * activated or if any of the parameters are invalid. + * @see OMIDSDK + */ +- (nullable instancetype)initWithPartner:(OMIDKontextsoPartner *)partner + javaScriptWebView:(WKWebView *)webView + contentUrl:(nullable NSString *)contentUrl + customReferenceIdentifier:(nullable NSString *)customReferenceIdentifier + error:(NSError *_Nullable *_Nullable)error; +#endif + +@end + +NS_ASSUME_NONNULL_END diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDFriendlyObstructionType.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDFriendlyObstructionType.h new file mode 100644 index 00000000..ee7bc6ac --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDFriendlyObstructionType.h @@ -0,0 +1,30 @@ +// +// OMIDFriendlyObstructionType.h +// AppVerificationLibrary +// +// Created by Andrew Whitcomb on 4/3/19. +// Copyright © 2019 Integral Ad Science, Inc. All rights reserved. +// + +/** + * List of allowed friendly obstruction purposes. + */ +typedef NS_ENUM(NSUInteger, OMIDFriendlyObstructionType) { + /** + * The friendly obstruction relates to interacting with a video (such as play/pause buttons). + */ + OMIDFriendlyObstructionMediaControls, + /** + * The friendly obstruction relates to closing an ad (such as a close button). + */ + OMIDFriendlyObstructionCloseAd, + /** + * The friendly obstruction is not visibly obstructing the ad but may seem so due to technical + * limitations. + */ + OMIDFriendlyObstructionNotVisible, + /** + * The friendly obstruction is obstructing for any purpose not already described. + */ + OMIDFriendlyObstructionOther +}; diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDImports.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDImports.h new file mode 100644 index 00000000..cec63730 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDImports.h @@ -0,0 +1,10 @@ +#import "OMIDSDK.h" +#import "OMIDScriptInjector.h" +#import "OMIDPartner.h" +#import "OMIDVerificationScriptResource.h" +#import "OMIDAdSessionContext.h" +#import "OMIDAdSession.h" +#import "OMIDAdEvents.h" +#import "OMIDVASTProperties.h" +#import "OMIDMediaEvents.h" +#import "OMIDJavaScriptSessionService.h" diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDJavaScriptSessionService.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDJavaScriptSessionService.h new file mode 100644 index 00000000..4bd74871 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDJavaScriptSessionService.h @@ -0,0 +1,109 @@ +#include +#if !(TARGET_OS_TV) + +#import +#import +#import "OMIDFriendlyObstructionType.h" +#import "OMIDPartner.h" + +NS_ASSUME_NONNULL_BEGIN + +/** + * Service supporting ad sessions managed (started/finished) via JavaScript Session Client APIs + * by providing native-layer measurement signals. + * If the JS Session Client is running in a web view, an instance of this service must be + * initialized with the web view before starting or finishing ad sessions using JS APIs. + * Only one instance of this service may be initialized at a time for a given web view; to reuse a + * web view the current instance must be torn down (see `tearDownWithCompletion`). + */ +@interface OMIDKontextsoJavaScriptSessionService : NSObject + +/** + * Initializes an instance of the service. + * + * @param partner Details of the integration partner responsible for ad sessions. + * @param webView The web view responsible for starting/finishing ad sessions via the JS Session + * Client. + * @param isHTMLAdView Whether the ad is rendered in HTML inside of the provided web view. + * If true, all ad sessions will be of type "html" and calling `setAdView` is + * not required. + * If false, all ad sessions will be of type "javascript" and `setAdView` must + * be called after initialization. + */ +- (nullable instancetype)initWithPartner:(OMIDKontextsoPartner *)partner + webView:(WKWebView *)webView + isHTMLAdView:(BOOL)isHTMLAdView + error:(NSError *_Nullable *_Nullable)error; + +/** + * Tears down this instance of the service. + * Calling this method will cause OM SDK to begin a teardown process including finishing all currently + * active ad sessions measured by this service instance and tearing down communication with the OM + * SDK's JavaScript layer running in the web view. + * This may require up to one second, for example in order to allow verification scripts time to process + * the `sessionFinish` event. + * Once this process has completed, the web view may be torn down or reused for another instance of + * the service without any adverse effects. If there is no need to tear down or reuse the web view, this + * method is not required. + * @param completionBlock Invoked by OM SDK after the teardown process has completed, + * or one second, whichever comes sooner. + */ +- (void)tearDownWithCompletion:(void (^)(BOOL success, NSError *_Nullable error))completionBlock; + +/** + * The native view containing the ad. + * This property is readonly and must be set using `setAdView`. + * If `isHTMLAdView` was passed as true in `initWithPartner`, this will equal + * the web view by default. + */ +@property(readonly, nonatomic, weak) UIView *adView; + +/** + * Sets the native view that contains the ad and is used for viewability tracking. + * If `isHTMLAdView` was passed as true in `initWithPartner`, this method is + * not required since the ad view will be set to the web view by default. + * @param adView The native view. + * @return Whether the ad view was successfully set. + */ +- (BOOL)setAdView:(nullable UIView *)adView + error:(NSError **)error; + +/** + * Adds a friendly obstruction which should then be excluded from all ad session viewability + * calculations. While this instance of OMIDJavaScriptSessionService is running, this friendly + * obstruction will be added to each ad session started by the integrator via the JS Session Client + * until the obstruction is removed by calling `removeFriendlyObstruction` or + * `removeAllFriendlyObstructions`. + * + * @param friendlyObstruction The view to be excluded from all ad session viewability calculations. + * @param purpose The purpose of why this obstruction was necessary. + * @param detailedReason An explanation for why this obstruction is part of the ad experience if not + * already obvious from the purpose. Can be nil. If not nil, must be 50 characters or less and only + * contain characters `A-z`, `0-9`, or spaces. + * @return Whether this friendly obstruction was successfully added. If the friendlyObstruction has + * already been added for this session, this method will return NO with no associated error object. + * However, if one or more arguments are against requirements, it will return NO with an error + * object assigned. + */ +- (BOOL)addFriendlyObstruction:(UIView *)friendlyObstruction + purpose:(OMIDFriendlyObstructionType)purpose + detailedReason:(nullable NSString *)detailedReason + error:(NSError *_Nullable *_Nullable)error; + +/** + * Removes a registered friendly obstruction from any currently running and future ad sessions + * measured by this instance of OMIDJavaScriptSessionService. + */ +- (void)removeFriendlyObstruction:(UIView *)friendlyObstruction; + +/** + * Removes all registered friendly obstructions from any currently running and future ad sessions + * measured by this instance of OMIDJavaScriptSessionService. + */ +- (void)removeAllFriendlyObstructions; + +@end + +NS_ASSUME_NONNULL_END + +#endif diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDMediaEvents.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDMediaEvents.h new file mode 100644 index 00000000..76f3cca6 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDMediaEvents.h @@ -0,0 +1,155 @@ +// +// OMIDMediaEvents.h +// AppVerificationLibrary +// +// Created by Justin Hines on 6/13/19. +// + +#import +#import "OMIDAdSession.h" +#import "OMIDVASTProperties.h" + +/** + * List of supported media event player states. + */ +typedef NS_ENUM(NSUInteger, OMIDPlayerState) { + /** + * The player is collapsed in such a way that the video is hidden. + * The video may or may not still be progressing in this state, and sound may be audible. + * This refers specifically to the video player state on the page, and not the state of + * the browser window. + */ + OMIDPlayerStateMinimized, + /** + * The player has been reduced from its original size. + * The video is still potentially visible. + */ + OMIDPlayerStateCollapsed, + /** + * The player's default playback size. + */ + OMIDPlayerStateNormal, + /** + * The player has expanded from its original size. + */ + OMIDPlayerStateExpanded, + /** + * The player has entered fullscreen mode. + */ + OMIDPlayerStateFullscreen +}; + +/** + * List of supported media event user interaction types. + */ +typedef NS_ENUM(NSUInteger, OMIDInteractionType) { + /** + * The user clicked to load the ad's landing page. + */ + OMIDInteractionTypeClick, + /** + * The user engaged with ad content to load a separate experience. + */ + OMIDInteractionTypeAcceptInvitation +}; + +/** + * This provides a complete list of native media events supported by OMID. + * Using this event API assumes the media player is fully responsible for communicating all media events at the appropriate times. + * Only one media events implementation can be associated with the ad session and any attempt to create multiple instances will result in an error. + */ +@interface OMIDKontextsoMediaEvents : NSObject + +/** + * Initializes media events instance for the associated ad session. + * Any attempt to create a media events instance will fail if the supplied ad session has already started. + * + * @param session The ad session associated with the ad events. + * @return A new media events instance. Returns nil if the supplied ad session is nil or if a media events instance has already been registered with the ad session or if a media events instance has been created after the ad session has started. + * @see OMIDAdSession + */ +- (nullable instancetype)initWithAdSession:(nonnull OMIDKontextsoAdSession *)session error:(NSError *_Nullable *_Nullable)error; + +/** + * Notifies all media listeners that media content has started playing. + * + * @param duration The duration of the selected media (in seconds). + * @param mediaPlayerVolume The volume from the native media player with a range between 0 and 1. + */ +- (void)startWithDuration:(CGFloat)duration + mediaPlayerVolume:(CGFloat)mediaPlayerVolume; + +/** + * Notifies all media listeners that media playback has reached the first quartile. + */ +- (void)firstQuartile; + +/** + * Notifies all media listeners that media playback has reached the midpoint. + */ +- (void)midpoint; + +/** + * Notifies all media listeners that media playback has reached the third quartile. + */ +- (void)thirdQuartile; + +/** + * Notifies all media listeners that media playback is complete. + */ +- (void)complete; + +/** + * Notifies all media listeners that media playback has paused after a user interaction. + */ +- (void)pause; + +/** + * Notifies all media listeners that media playback has resumed after being paused. + */ +- (void)resume; + +/** + * Notifies all media listeners that media playback has stopped as a user skip interaction. + * Once skipped, it should not be possible for the media to resume playing content. + */ +- (void)skipped; + +/** + * Notifies all media listeners that media playback has stopped and started buffering. + */ +- (void)bufferStart; + +/** + * Notifies all media listeners that buffering has finished and media playback has resumed. + */ +- (void)bufferFinish; + +/** + * Notifies all media listeners that the media player volume has changed. + * + * @param playerVolume The volume from the native media player with a range between 0 and 1. + */ +- (void)volumeChangeTo:(CGFloat)playerVolume; + +/** + * Notifies all media listeners that media player state has changed. + * See `OMIDPlayerState` for list of supported states. + * + * @param playerState The latest media player state. + * @see OMIDPlayerState + */ +- (void)playerStateChangeTo:(OMIDPlayerState)playerState; + +/** + * Notifies all media listeners that the user has performed an ad interaction. + * See `OMIDInteractionType` for a list of supported types. + * + * @param interactionType The latest user integration. + * @see OMIDInteractionType + */ +- (void)adUserInteractionWithType:(OMIDInteractionType)interactionType +NS_SWIFT_NAME(adUserInteraction(withType:)); + +@end + diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDPartner.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDPartner.h new file mode 100644 index 00000000..b54556dc --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDPartner.h @@ -0,0 +1,32 @@ +// +// OMIDPartner.h +// AppVerificationLibrary +// +// Created by Daria on 06/06/2017. +// + +#import + +/** + * Details about the integration partner which will be supplied to the ad session. + */ +@interface OMIDKontextsoPartner : NSObject + +@property(nonatomic, readonly, nonnull) NSString *name; +@property(nonatomic, readonly, nonnull) NSString *versionString; + +/** + * Initializes new partner instance providing both name and versionString. + * + * Both name and version are mandatory. + * + * @param name It is used to uniquely identify the integration partner. + * @param versionString It is used to uniquely identify the integration partner. + * @return A new partner instance, or nil if any of the parameters are either null or blank + */ +- (nullable instancetype)initWithName:(nonnull NSString *)name + versionString:(nonnull NSString *)versionString; + +- (null_unspecified instancetype)init NS_UNAVAILABLE; + +@end diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDSDK.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDSDK.h new file mode 100644 index 00000000..daa9820b --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDSDK.h @@ -0,0 +1,58 @@ +// +// OMIDSDK.h +// AppVerificationLibrary +// +// Created by Daria on 05/06/2017. +// + +#import + +NS_ASSUME_NONNULL_BEGIN + +/** + * This application level class will be called by all integration partners to ensure OM SDK has been activated before calling any other API methods. + * Any attempt to use other API methods prior to activation will result in an error. + * + * Note that OM SDK may only be used on the main UI thread. + * Make sure you are on the main thread when you initialize the SDK, create its + * objects, and invoke its methods. + */ +@interface OMIDKontextsoSDK : NSObject + +/** + * The current semantic version of the integrated OMID library. + */ ++ (NSString *)versionString; + +/** + * Shared OMIDSDK instance. + */ +@property(class, readonly) OMIDKontextsoSDK *sharedInstance +NS_SWIFT_NAME(shared); + +/** + * A Boolean value indicating whether OM SDK has been activated. + * + * @discussion Check that OM SDK is active prior to creating any ad sessions. + */ +@property(atomic, readonly, getter=isActive) BOOL active; + +/** + * Activate OM SDK before calling other API methods. + * + * @discussion Activation sets up the OM SDK environment. In CTV apps (running tvOS), `activate` should be called on launch in + * order to capture a "last activity" timestamp on launch and each time the user foregrounds the app). + * + * @return Boolean indicating success. + */ +- (BOOL)activate; + +/** + * Update the last activity time + * After activating OM SDK in CTV apps, refresh the "last activity" timestamp in response to user input prior to starting an ad session. + */ +- (void)updateLastActivity; + +@end + +NS_ASSUME_NONNULL_END diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDScriptInjector.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDScriptInjector.h new file mode 100644 index 00000000..f6dd4572 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDScriptInjector.h @@ -0,0 +1,26 @@ +// +// OMIDScriptInjector.h +// AppVerificationLibrary +// +// Created by Daria on 21/06/2017. +// + +#import + +/** + * Utility class which enables integration partners to use a standard approach for injecting OM SDK JS into the served tag HTML content. + */ +@interface OMIDKontextsoScriptInjector : NSObject + +/* + Injects the downloaded OMID JS content into the served HTML. + @param scriptContent containing the OMID JS service content to be injected into the hidden tracking web view. + @param html of the tag content which should be modified to include the downloaded OMID JS content. + @param error If an error occurs, contains an NSError object. + @return modified HTML including OMID JS or nil if an error occurs. + */ ++ (nullable NSString *)injectScriptContent:(nonnull NSString *)scriptContent + intoHTML:(nonnull NSString *)html + error:(NSError *_Nullable *_Nullable)error; + +@end diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDUniversalAdID.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDUniversalAdID.h new file mode 100644 index 00000000..25fb50d5 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDUniversalAdID.h @@ -0,0 +1,40 @@ +// +// OMIDUniversalAdID.h +// AppVerificationLibrary +// +// Created by Teodor Cristea on 31.03.2025. +// Copyright © 2025 IAB Techlab. All rights reserved. +// + +#import + +NS_ASSUME_NONNULL_BEGIN + +/** + * Details about the UniversalAdID for the purpose of tracking ad creatives which will be supplied to the ad session. + */ +@interface OMIDKontextsoUniversalAdID : NSObject + +@property(nonatomic, readonly, nonnull) NSString *value; +@property(nonatomic, readonly, nonnull) NSString *idRegistry; + +/** + * Initializes new UniversalAdID instance providing both value and idRegistry. + * The UniversalAdID's purpose is to identify an ad creative across different platforms throughout the lifecycle of an advertising campaign. + * + * Both value and idRegistry are mandatory. + * + * @param value It is used to identify the unique creative identifier. + * @param idRegistry It is used to identify the URL for the registry website where the unique creative ID is cataloged. + * @return A new UniversalAdID instance, or nil if any of the parameters are either null or blank + */ +- (nullable instancetype)initWithValue:(nonnull NSString *)value + idRegistry:(nonnull NSString *)idRegistry + error:(NSError *_Nullable *_Nullable)error; + ++ (instancetype)new NS_UNAVAILABLE; +- (null_unspecified instancetype)init NS_UNAVAILABLE; + +@end + +NS_ASSUME_NONNULL_END diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDVASTProperties.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDVASTProperties.h new file mode 100644 index 00000000..5874fbd1 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDVASTProperties.h @@ -0,0 +1,71 @@ +// +// OMIDVASTProperties.h +// AppVerificationLibrary +// +// Created by Daria Sukhonosova on 30/06/2017. +// + +#import + +/** + * List of supported media player positions. + */ +typedef NS_ENUM(NSUInteger, OMIDPosition) { + /** + * The ad plays preceding video content. + */ + OMIDPositionPreroll, + /** + * The ad plays in the middle of video content, or between two separate content videos. + */ + OMIDPositionMidroll, + /** + * The ad plays following video content. + */ + OMIDPositionPostroll, + /** + * The ad plays independently of any video content. + */ + OMIDPositionStandalone +}; + +/** + * This object is used to capture key VAST properties so this can be shared with all registered verification providers. + */ +@interface OMIDKontextsoVASTProperties : NSObject + +@property(nonatomic, readonly, getter = isSkippable) BOOL skippable; +@property(nonatomic, readonly) CGFloat skipOffset; +@property(nonatomic, readonly, getter = isAutoPlay) BOOL autoPlay; +@property(nonatomic, readonly) OMIDPosition position; + +/** + * This method enables the media player to create a new VAST properties instance for skippable media ad placement. + * + * @param skipOffset The number of seconds before the skip button is presented. + * @param autoPlay Determines whether the media will auto-play content. + * @param position The position of the media in relation to other content. + * @return A new instance of VAST properties. + */ +- (nonnull instancetype)initWithSkipOffset:(CGFloat)skipOffset + autoPlay:(BOOL)autoPlay + position:(OMIDPosition)position; + +/** + * This method enables the media player to create a new VAST properties instance for non-skippable media ad placement. + * + * @param autoPlay Determines whether the media will auto-play content. + * @param position The position of the media in relation to other content. + * @return A new instance of VAST properties. + */ +- (nonnull instancetype)initWithAutoPlay:(BOOL)autoPlay + position:(OMIDPosition)position; + +- (null_unspecified instancetype)init NS_UNAVAILABLE; + +/** + * For OM SDK internal use only. + */ +- (NSDictionary *_Nonnull)toJSON; + +@end diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDVerificationScriptResource.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDVerificationScriptResource.h new file mode 100644 index 00000000..c43451a3 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMIDVerificationScriptResource.h @@ -0,0 +1,45 @@ +// +// OMIDVerificationScriptResource.h +// AppVerificationLibrary +// +// Created by Daria on 06/06/2017. +// + +#import + +/** + * Details about the verification provider which will be supplied to the ad session. + */ +@interface OMIDKontextsoVerificationScriptResource : NSObject + +@property(nonatomic, readonly, nonnull) NSURL *URL; +@property(nonatomic, readonly, nullable) NSString *vendorKey; +@property(nonatomic, readonly, nullable) NSString *parameters; + +/** + * Initializes new verification script resource instance which requires vendor specific verification parameters. + * + * When calling this method all arguments are mandatory. + * + * @param vendorKey It is used to uniquely identify the verification provider. + * @param URL The URL to be injected into the OMID managed JavaScript execution environment. + * @param parameters The parameters which the verification provider script is expecting for the ad session. + * @return A new verification script resource instance, or nil if any of the parameters are either null or blank. + */ +- (nullable instancetype)initWithURL:(nonnull NSURL *)URL + vendorKey:(nonnull NSString *)vendorKey + parameters:(nonnull NSString *)parameters; + +/** + * Initializes new verification script resource instance which does not require any vendor specific verification parameters. + * + * When calling this method all arguments are mandatory. + * + * @param URL The URL to be injected into the OMID managed JavaScript execution environment. + * @return A new verification script resource instance, or nil if URL is nil or blank. + */ +- (nullable instancetype)initWithURL:(nonnull NSURL *)URL; + +- (null_unspecified instancetype)init NS_UNAVAILABLE; + +@end diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMSDK.h b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMSDK.h new file mode 100644 index 00000000..bc3714ad --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Headers/OMSDK.h @@ -0,0 +1,18 @@ +// +// OMSDK.h +// OMSDK +// +// Created by Nathanael Hardy on 10/16/20. +// + +#import + +//! Project version number for OMSDK. +FOUNDATION_EXPORT double OMSDKVersionNumber; + +//! Project version string for OMSDK. +FOUNDATION_EXPORT const unsigned char OMSDKVersionString[]; + +// In this header, you should import all the public headers of your framework using statements like #import + +#import diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Info.plist b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Info.plist new file mode 100644 index 00000000..3d61b403 Binary files /dev/null and b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Info.plist differ diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Modules/module.modulemap b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Modules/module.modulemap new file mode 100644 index 00000000..078b6857 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/Modules/module.modulemap @@ -0,0 +1,4 @@ +module OMSDK_Kontextso { + header "Headers/OMIDImports.h" + export * +} diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/OMSDK_Kontextso b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/OMSDK_Kontextso new file mode 100755 index 00000000..e4aa2e55 Binary files /dev/null and b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/OMSDK_Kontextso differ diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/PrivacyInfo.xcprivacy b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/PrivacyInfo.xcprivacy new file mode 100644 index 00000000..5ab7e387 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/PrivacyInfo.xcprivacy @@ -0,0 +1,42 @@ + + + + + + NSPrivacyCollectedDataTypes + + + NSPrivacyCollectedDataType + NSPrivacyCollectedDataTypeProductInteraction + NSPrivacyCollectedDataTypeLinked + + NSPrivacyCollectedDataTypeTracking + + NSPrivacyCollectedDataTypePurposes + + NSPrivacyCollectedDataTypePurposeThirdPartyAdvertising + NSPrivacyCollectedDataTypePurposeDeveloperAdvertising + + + + NSPrivacyCollectedDataType + NSPrivacyCollectedDataTypeAdvertisingData + NSPrivacyCollectedDataTypeLinked + + NSPrivacyCollectedDataTypeTracking + + NSPrivacyCollectedDataTypePurposes + + NSPrivacyCollectedDataTypePurposeThirdPartyAdvertising + NSPrivacyCollectedDataTypePurposeDeveloperAdvertising + + + + + diff --git a/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/_CodeSignature/CodeResources b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/_CodeSignature/CodeResources new file mode 100644 index 00000000..d7d6f3b8 --- /dev/null +++ b/ios/Frameworks/OMSDK_Kontextso.xcframework/tvos-arm64_x86_64-simulator/OMSDK_Kontextso.framework/_CodeSignature/CodeResources @@ -0,0 +1,289 @@ + + + + + files + + Headers/OMIDAdEvents.h + + am/yiZOXFWtpRJvhlFJlaWbUWOQ= + + Headers/OMIDAdSession.h + + fxqpQp6PpN5FhdpKtzp1m8pxakg= + + Headers/OMIDAdSessionConfiguration.h + + FaFKqWWZiE/UwFJptVcKf3+TC/8= + + Headers/OMIDAdSessionContext.h + + G3eoR7OHiMnEJWDGL11uI27M+w8= + + Headers/OMIDFriendlyObstructionType.h + + ymPA8TI4PL8pK0zhc5ilyQj/SsA= + + Headers/OMIDImports.h + + /ghw/vX0KUlF9SSq4LZhhZDpZb4= + + Headers/OMIDJavaScriptSessionService.h + + 1fiDz/ZFUv3vsIyROVepMB9RhNU= + + Headers/OMIDMediaEvents.h + + Gf3AkxkJ3Vx4DwCYAfQcOC21U60= + + Headers/OMIDPartner.h + + g/b45DUwpunphzi8Bb/s8MDv3/s= + + Headers/OMIDSDK.h + + 1bJmHENCgd81ADE2yJwQG63gYvM= + + Headers/OMIDScriptInjector.h + + Z6KYAHtDRU1RL+NxsVqVpbi1UIA= + + Headers/OMIDUniversalAdID.h + + HfpQibx5013NtmzEmU6YLsOU8wM= + + Headers/OMIDVASTProperties.h + + 9Oe9DoZD7Gu4m4djKpP3HW1wi8A= + + Headers/OMIDVerificationScriptResource.h + + nnh2Tmyp73GE4UB1EOH44da57VM= + + Headers/OMSDK.h + + SwK6aatAfFlLHnP2+J8eYoZyaqs= + + Info.plist + + mFELS7EHe9AbX8QAqNx89tLSLX4= + + Modules/module.modulemap + + jAuAbI2uLxH0F9SXvjWXNNBqYSQ= + + PrivacyInfo.xcprivacy + + 7BgfS40JHW2Znl7afTrGvxB58Ws= + + + files2 + + Headers/OMIDAdEvents.h + + hash2 + + Uon2BFlfaYu7xdPpGhhDoxrnTxS99d+vlwZibVTcNfM= + + + Headers/OMIDAdSession.h + + hash2 + + P2/SRxMST0KToCmq6laq5UfWM7C+/I80sFW5yN9y9IM= + + + Headers/OMIDAdSessionConfiguration.h + + hash2 + + TAjMbUayhPpau5aGanvcngASnJAKVaRBWBOVD6XcK8I= + + + Headers/OMIDAdSessionContext.h + + hash2 + + YG+Bk6tUe1Y3FpXI2FbPuKJ2uMZGn7l5LvaYvTw4K2E= + + + Headers/OMIDFriendlyObstructionType.h + + hash2 + + /ZmBFlTK7mS0fZy4WqxCTpfhwDAEA4qlDHoed4FawBg= + + + Headers/OMIDImports.h + + hash2 + + XQBgb62m3DEN2XBtnlS+hqca4MEIuBJjq6po9fIbZco= + + + Headers/OMIDJavaScriptSessionService.h + + hash2 + + ndvnaaz7rqwG/SOgTCBeDu13IivgmkDbd7/+TmRlgGA= + + + Headers/OMIDMediaEvents.h + + hash2 + + 2MLNvQSUEbX2iruhkH8EpcPD3hldsEnikylbssLYYvk= + + + Headers/OMIDPartner.h + + hash2 + + VP+tsHIL0YmzFVxea6F6Y94/dG9p42Ubmg9bgH8uIxc= + + + Headers/OMIDSDK.h + + hash2 + + ZkojrMZxmVBHkDQQA55ozX8Yid1Kw2c/s7NCvqOEA0E= + + + Headers/OMIDScriptInjector.h + + hash2 + + QdezzQmyENJeVAKI3VQ/WQO+XuVW9W19dZX6lnx6slQ= + + + Headers/OMIDUniversalAdID.h + + hash2 + + XC6x3TXPiqFy3yszzifKwq15Cghu8jSxT9gWoKgiQys= + + + Headers/OMIDVASTProperties.h + + hash2 + + DaMzQ26+i+oaRtWlRtfNFSiPCoS3pnXbR6trg9+ceIE= + + + Headers/OMIDVerificationScriptResource.h + + hash2 + + Kj8QOr3eZHuIfHylEUtC9/vvCUE78deUsyouMlODaRk= + + + Headers/OMSDK.h + + hash2 + + RMvQNEJLOImLem6a8DtHWs08tFMncdsWXtF/QfYUIvQ= + + + Modules/module.modulemap + + hash2 + + cNfPijMaVG/k/dYTmzOjFlnbppT8ERwBfRkuaJeCpZc= + + + PrivacyInfo.xcprivacy + + hash2 + + 5rdpDTW6MDoz1u2y0rCJB5ensp/KZWPv7EAq4o8GtfM= + + + + rules + + ^.* + + ^.*\.lproj/ + + optional + + weight + 1000 + + ^.*\.lproj/locversion.plist$ + + omit + + weight + 1100 + + ^Base\.lproj/ + + weight + 1010 + + ^version.plist$ + + + rules2 + + .*\.dSYM($|/) + + weight + 11 + + ^(.*/)?\.DS_Store$ + + omit + + weight + 2000 + + ^.* + + ^.*\.lproj/ + + optional + + weight + 1000 + + ^.*\.lproj/locversion.plist$ + + omit + + weight + 1100 + + ^Base\.lproj/ + + weight + 1010 + + ^Info\.plist$ + + omit + + weight + 20 + + ^PkgInfo$ + + omit + + weight + 20 + + ^embedded\.provisionprofile$ + + weight + 20 + + ^version\.plist$ + + weight + 20 + + + + diff --git a/ios/Resources/omsdk-v1.js b/ios/Resources/omsdk-v1.js new file mode 100644 index 00000000..07a4e200 --- /dev/null +++ b/ios/Resources/omsdk-v1.js @@ -0,0 +1,99 @@ +;(function(omidGlobal) { + var n;function aa(a){var b=0;return function(){return bc&&(c=Math.max(c+e,0));c>>0)+'_',e=0;return b}); +u('Symbol.iterator',function(a){if(a)return a;a=Symbol('Symbol.iterator');for(var b='Array Int8Array Uint8Array Uint8ClampedArray Int16Array Uint16Array Int32Array Uint32Array Float32Array Float64Array'.split(' '),c=0;cb||1342177279>>=1)c+=c;return d}}); +u('String.prototype.padStart',function(a){return a?a:function(b,c){var d=ma(this,null,'padStart');b-=d.length;c=void 0!==c?String(c):' ';return(0Math.abs(f-c))||(f=b.x,f=f>e||.01>Math.abs(f-e));(e=f)||(e=b.endY,e=eMath.abs(e-d));(d=e)||(b=b.y,d=b>a||.01>Math.abs(b-a));b=!d}return b}function F(a,b){for(var c=!1,d=0;dg&&J.yr){ca=!0;break}}ca&&(f+=Math.round(l)*Math.round(H))}}return c.call(b,0,d-f)};function Ka(){};function La(){} +function Ma(a,b,c,d,e,f){var h=new Ba;b=new z(b,!1);Ea(h,b);Na(a,b,h,d);if(!e)return h.i=['unmeasurable'],h.s=void 0,h.A=0,h.j=[],h.g&&(a=h.g,c={},a=new z((c.x=0,c.y=0,c.width=a.width,c.height=a.height,c),a.g),h.g=a),h.h=Fa(),h;'locked'===f&&F(h,'deviceLocked');if(b.noOutputDevice)F(h,'backgrounded'),F(h,'noOutputDevice');else if('backgrounded'===c)F(h,'backgrounded');else if(void 0!==h.g){for(a=0;ad.time&&(d=b[e]);c=d;a.m=Rb(c.rootBounds);a.g=Rb(c.boundingClientRect);a.C=Rb(c.intersectionRect);a.M=!!c.isIntersecting;Ib(a)}}catch(f){a.A(),ob(a.L,'generic','Problem handling IntersectionObserver callback: '+f.message)}},{root:null,rootMargin:'0px',threshold:[0,.1,.2,.3,.4,.5,.6,.7,.8,.9,1]})} +function Qb(a){a.j.ResizeObserver?a.u||(a.u=Sb(a,function(){return Tb(a)}),a.u.observe(a.h)):(a.v||(a.v=function(){return Tb(a)},(0,a.j.addEventListener)('resize',a.v)),a.s||(a.s=new MutationObserver(function(){return Tb(a)}),a.s.observe(a.h,{childList:!1,attributes:!0,subtree:!1})))}function Tb(a){a.h&&!Pb(a.h)&&(Ob(a),Mb(a))}function Sb(a,b){return new a.j.ResizeObserver(b)}function Rb(a){if(a&&null!==a.x&&null!==a.y&&null!==a.width&&null!==a.height)return new z(a,!1)};function Ub(a){if('object'===typeof a&&'object'===typeof a.webOSSystem)return a.webOSSystem}function Vb(a){if('object'===typeof a&&'object'===typeof a.tizen)return a.tizen}function Yb(a){return'object'===typeof Vb(a)};function Zb(a,b){this.h=a;this.g=b};function $b(){return'undefined'!==typeof crypto&&'function'===typeof crypto.getRandomValues}function ac(){var a=new Uint8Array(16);crypto.getRandomValues(a);a[6]=a[6]&15|64;a[8]=a[8]&63|128;for(var b=[],c=0;16>c;c++)b.push(a[c].toString(16).padStart(2,'0'));return b[0]+b[1]+b[2]+b[3]+'-'+b[4]+b[5]+'-'+b[6]+b[7]+'-'+b[8]+b[9]+'-'+b[10]+b[11]+b[12]+b[13]+b[14]+b[15]} +function bc(){return'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g,function(a){var b=16*Math.random()|0;return'y'===a?(b&3|8).toString(16):b.toString(16)})};function cc(a,b){var c=void 0===c?K:c;this.j=a;this.g=c;this.i=b;this.h=[]} +function dc(a){if(!a.g||!a.g.document)throw Error('OMID Service Script is not running within a window.');var b=a.h;a.h=[];b.forEach(function(c){try{var d=a.i.J?'limited':'full',e=R(c.accessMode,sa)?c.accessMode:null;var f=e?'full'==e&&'limited'==d?d:'domain'==e?'limited':e:d;c.accessMode=f;a:{var h=c.resourceUrl,k=a.g.location.origin;try{var g=new URL(h,k);break a}catch(H){}try{g=new URL(h);break a}catch(H){}g=null}if(d=g){var l=$b()?ac():bc();ec(a,l,d,f);var m=c.vendorKey,r=c.verificationParameters; +m=void 0===m?'':m;r=void 0===r?'':r;m&&'string'===typeof m&&''!==m&&r&&'string'===typeof r&&''!==r&&(a.j.o[m]=r);a.i.C.set(l,c)}}catch(H){Pa('OMID verification script '+c.resourceUrl+' failed to load: '+H)}})} +function ec(a,b,c,d){var e=a.g.document,f=e.createElement('iframe');f.id='omid-verification-script-frame-'+b;f.style.display='none';if('full'==d){var h=function(){var k=f.contentWindow;k.omidVerificationProperties={serviceWindow:a.g,injectionSource:'app',injectionId:b};k=k.document;var g=k.createElement('script');g.src=c.href;k.head.appendChild(g);f.removeEventListener('load',h)};f.addEventListener('load',h)}else'limited'==d&&(f.srcdoc="\n