Release 4.8.0

Author: J. Doe (https://devcenter.bitrise.io/builds/setting-your-git-credentials-on-build-machines/)

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+### v4.8.0
+_2020-11-17_
+- Latest OM SDK version
+- SmartAd adapter support
+- ValidationTool: validate resize implementation (direct and mediation)
+- Remove UIWebView iOS
+
 ### v4.7.8
 _2020-09-21_
 - Ensuring ratio update is made on main thread \n - Fixing player to have a better creative rendering \n - Improving memory footprint and performance

README.md

@@ -15,7 +15,7 @@ Teads SDK is currently distributed through CocoaPods. It include everything you
 
 ```
 target 'YourProject' do
-    pod 'TeadsSDK', '4.7.8'
+    pod 'TeadsSDK', '4.8.0'
 end
 ```
 
@@ -30,7 +30,7 @@ $ pod install --repo-update
 [Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks. To integrate TeadsSDK into your Xcode project using Carthage, specify it in your `Cartfile`:
 
 ```ogdl
-github "teads/TeadsSDK-iOS" "4.7.8"
+github "teads/TeadsSDK-iOS" "4.8.0"
 ```
 
 ## Integration Documentation

TeadsSDK.framework/Assets.car

@@ -7,6 +7,7 @@
 
 #import <Foundation/Foundation.h>
 #import "OMIDAdSession.h"
+#import "OMIDVASTProperties.h"
 
 /**
  *  Ad event API enabling the integration partner to signal to all verification providers when key events have occurred.
@@ -31,4 +32,19 @@
  */
 - (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:(OMIDTeadstvVASTProperties *_Nonnull)vastProperties
+                           error:(NSError *_Nullable *_Nullable)error;
 @end

TeadsSDK.framework/25B50ADB-5BD4-3566-A355-7A72A1516818.bcsymbolmap renamed to TeadsSDK.framework/E936605F-4721-33CC-9403-EA0F4D4C6133.bcsymbolmap

@@ -8,10 +8,22 @@
 #import <UIKit/UIKit.h>
 #import "OMIDAdSessionContext.h"
 #import "OMIDAdSessionConfiguration.h"
+#import "OMIDFriendlyObstructionType.h"
 
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ * List of supported error types.
+ */
 typedef NS_ENUM(NSUInteger, OMIDErrorType) {
-    OMIDErrorGeneric = 1, // will translate into "GENERIC" when published to the OMID JS service.
-    OMIDErrorVideo = 2 // will translate into "VIDEO" when published to the OMID JS service.
+    /**
+     * The integration is publishing a "generic" error to verification scripts.
+     */
+    OMIDErrorGeneric = 1,
+    /**
+     * The integration is publishing a "video" error to verification scripts.
+     */
+    OMIDErrorMedia = 2
 };
 
 /**
@@ -23,7 +35,7 @@ typedef NS_ENUM(NSUInteger, OMIDErrorType) {
 /**
  *  The AdSession configuration is used for check owners.
  */
-@property(nonatomic, readonly, nonnull) OMIDTeadstvAdSessionConfiguration *configuration;
+@property(nonatomic, readonly) OMIDTeadstvAdSessionConfiguration *configuration;
 /**
  *  The native view which is used for viewability tracking.
  */
@@ -38,16 +50,15 @@ typedef NS_ENUM(NSUInteger, OMIDErrorType) {
  *
  * 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:] or
- * -[UIWebViewDelegate webViewDidFinishLoad:]).  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.
+ * 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:(nonnull OMIDTeadstvAdSessionConfiguration *)configuration
-                              adSessionContext:(nonnull OMIDTeadstvAdSessionContext *)context
+- (nullable instancetype)initWithConfiguration:(OMIDTeadstvAdSessionConfiguration *)configuration
+                              adSessionContext:(OMIDTeadstvAdSessionContext *)context
                                          error:(NSError *_Nullable *_Nullable)error;
 
 
@@ -72,12 +83,24 @@ typedef NS_ENUM(NSUInteger, OMIDErrorType) {
 
 /**
  *  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.
  */
-- (void)addFriendlyObstruction:(nonnull UIView *)friendlyObstruction;
+- (BOOL)addFriendlyObstruction:(UIView *)friendlyObstruction
+                       purpose:(OMIDFriendlyObstructionType)purpose
+                detailedReason:(nullable NSString *)detailedReason
+                         error:(NSError *_Nullable *_Nullable)error;
 
 /**
  *  Removes registered friendly obstruction.
@@ -86,7 +109,7 @@ typedef NS_ENUM(NSUInteger, OMIDErrorType) {
  *
  * @param friendlyObstruction The view to be removed from the list of registered friendly obstructions.
  */
-- (void)removeFriendlyObstruction:(nonnull UIView *)friendlyObstruction;
+- (void)removeFriendlyObstruction:(UIView *)friendlyObstruction;
 
 /**
  *  Utility method to remove all registered friendly obstructions.
@@ -103,8 +126,9 @@ typedef NS_ENUM(NSUInteger, OMIDErrorType) {
  * @param errorType The type of error.
  * @param message The message containing details of the error.
  */
-- (void)logErrorWithType:(OMIDErrorType)errorType message:(nonnull NSString *)message
+- (void)logErrorWithType:(OMIDErrorType)errorType message:(NSString *)message
 NS_SWIFT_NAME(logError(withType:message:));
 
 @end
 
+NS_ASSUME_NONNULL_END

TeadsSDK.framework/DCA72F74-4AB1-3481-BDE1-2747C30EFCB8.bcsymbolmap renamed to TeadsSDK.framework/F447533D-4483-3F85-B305-2E8F6DFA1B07.bcsymbolmap

@@ -19,33 +19,117 @@ typedef NS_ENUM(NSUInteger, OMIDOwner) {
     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 OMID JS service will use this information to help identify where the source of these
+ * The OM SDK JS service will use this information to help identify where the source of these
  * events is expected to be received.
  */
 @interface OMIDTeadstvAdSessionConfiguration : NSObject
 
+@property OMIDCreativeType creativeType;
+@property OMIDImpressionType impressionType;
 @property OMIDOwner impressionOwner;
-@property OMIDOwner videoEventsOwner;
+@property OMIDOwner mediaEventsOwner;
 @property BOOL isolateVerificationScripts;
 
 /**
- * Returns nil and sets error if OMID isn't active or arguments are invalid.
- * @param impressionOwner providing details of who is responsible for triggering the impression event.
- * @param videoEventsOwner providing details of who is responsible for triggering video events. This is only required for video ad sessions and should be set to videoEventsOwner:OMIDNoneOwner for display ad sessions.
- * @param isolateVerificationScripts determines whether verification scripts will be placed in a sandboxed environment. This will not have any effect for native sessions.
+ * 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)initWithImpressionOwner:(OMIDOwner)impressionOwner
-                                videoEventsOwner:(OMIDOwner)videoEventsOwner
-                      isolateVerificationScripts:(BOOL)isolateVerificationScripts
-                                           error:(NSError *_Nullable *_Nullable)error;
-
-#pragma mark - Deprecated Methods
-
-- (nullable instancetype)initWithImpressionOwner:(OMIDOwner)impressionOwner
-                                videoEventsOwner:(OMIDOwner)videoEventsOwner
-                                           error:(NSError *_Nullable *_Nullable)error __deprecated_msg("Use -initWithImpressionOwner:videoEventsOwner:isolateVerificationScripts:error: instead.");
+- (nullable instancetype)initWithCreativeType:(OMIDCreativeType)creativeType
+                               impressionType:(OMIDImpressionType)impressionType
+                              impressionOwner:(OMIDOwner)impressionOwner
+                             mediaEventsOwner:(OMIDOwner)mediaEventsOwner
+                   isolateVerificationScripts:(BOOL)isolateVerificationScripts
+                                        error:(NSError *_Nullable *_Nullable)error;
 
 @end
 

TeadsSDK.framework/Headers/OMIDAdEvents.h

@@ -3,49 +3,87 @@
 //
 
 #import <UIKit/UIKit.h>
+#import <WebKit/WebKit.h>
 #import "OMIDPartner.h"
 #import "OMIDVerificationScriptResource.h"
 
+NS_ASSUME_NONNULL_BEGIN
+
 /**
- *  This class will provide the ad session both details of the partner and whether this is considered HTML or native.
+ *  Provides the ad session with details of the partner and whether to an HTML,
+ *  JavaScript, or native session.
  */
 @interface OMIDTeadstvAdSessionContext : NSObject
 
 - (null_unspecified instancetype)init NS_UNAVAILABLE;
 
 /**
- *  Initializes a new ad session context providing reference to partner and web view where OMID JS has been injected.
+ * 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”.
+ * Calling this method will set the ad session type to `html`.
  * <p>
- * NOTE: any attempt to create a new ad session will fail if OMID has not been activated (see {@link OMIDSDK} class for more information).
+ * 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 webView responsible for serving the ad content. Must be a UIWebView or WKWebView instance. The receiver holds a weak reference only.
- * @return A new HTML context instance. Returns nil if OMID has not been activated or if any of the parameters are nil.
+ * @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:(nonnull OMIDTeadstvPartner *)partner
-                                 webView:(nonnull UIView *)webView
+- (nullable instancetype)initWithPartner:(OMIDTeadstvPartner *)partner
+                                 webView:(WKWebView *)webView
+                              contentUrl:(nullable NSString *)contentUrl
                customReferenceIdentifier:(nullable NSString *)customReferenceIdentifier
                                    error:(NSError *_Nullable *_Nullable)error;
-
 /**
- *  Initializes a new ad session context providing reference to partner and a list of script resources which should be managed by OMID.
+ * 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”.
+ * Calling this method will set the ad session type to `native`.
  * <p>
- * NOTE: any attempt to create a new ad session will fail if OMID has not been activated (see {@link OMIDSDK} class for more information).
+ * 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 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:(nonnull OMIDTeadstvPartner *)partner
-                                  script:(nonnull NSString *)script
-                               resources:(nonnull NSArray<OMIDTeadstvVerificationScriptResource *> *)resources
+- (nullable instancetype)initWithPartner:(OMIDTeadstvPartner *)partner
+                                  script:(NSString *)script
+                               resources:(NSArray<OMIDTeadstvVerificationScriptResource *> *)resources
+                              contentUrl:(nullable NSString *)contentUrl
+               customReferenceIdentifier:(nullable NSString *)customReferenceIdentifier
+                                   error:(NSError *_Nullable *_Nullable)error;
+
+/**
+ * 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`.
+ * <p>
+ * 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:(OMIDTeadstvPartner *)partner
+                       javaScriptWebView:(WKWebView *)webView
+                              contentUrl:(nullable NSString *)contentUrl
                customReferenceIdentifier:(nullable NSString *)customReferenceIdentifier
                                    error:(NSError *_Nullable *_Nullable)error;
 
 @end
+
+NS_ASSUME_NONNULL_END