Skip to content

Commit d1235d9

Browse files
Kimara5Kimara5
authored
Added omid .xcframework and .podspec
1 parent 7b2562b commit d1235d9

35 files changed

Lines changed: 2058 additions & 0 deletions

‎OMSDK_Seedtag.podspec‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Pod::Spec.new do |s|
2+
s.name = "OMSDK_Seedtag"
3+
s.version = "1.0.0"
4+
s.summary = "OMID SDK for iOS."
5+
s.description = <<-DESC
6+
OMID SDK for iOS.
7+
DESC
8+
s.homepage = "https://github.com/seedtag/omid-podspec"
9+
s.license = { :type => 'Copyright', :text => <<-LICENSE
10+
Copyright 2021
11+
Permission is granted to Seedtag.
12+
LICENSE
13+
}
14+
s.author = { "Cristina Arias" => "cristinaarias@seedtag.com" }
15+
s.source = { :git => 'https://github.com/seedtag/omid-podspec.git', :tag => s.version }
16+
s.vendored_frameworks = OMSDK_Seedtag.xcframework"
17+
s.platform = :ios
18+
s.swift_version = "5"
19+
s.ios.deployment_target = '11'
20+
end

‎OMSDK_Seedtag.xcframework/Info.plist‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
3+
<plist version="1.0">
4+
<dict>
5+
<key>AvailableLibraries</key>
6+
<array>
7+
<dict>
8+
<key>LibraryIdentifier</key>
9+
<string>ios-arm64_armv7</string>
10+
<key>LibraryPath</key>
11+
<string>OMSDK_Seedtag.framework</string>
12+
<key>SupportedArchitectures</key>
13+
<array>
14+
<string>arm64</string>
15+
<string>armv7</string>
16+
</array>
17+
<key>SupportedPlatform</key>
18+
<string>ios</string>
19+
</dict>
20+
<dict>
21+
<key>LibraryIdentifier</key>
22+
<string>ios-arm64_i386_x86_64-simulator</string>
23+
<key>LibraryPath</key>
24+
<string>OMSDK_Seedtag.framework</string>
25+
<key>SupportedArchitectures</key>
26+
<array>
27+
<string>arm64</string>
28+
<string>i386</string>
29+
<string>x86_64</string>
30+
</array>
31+
<key>SupportedPlatform</key>
32+
<string>ios</string>
33+
<key>SupportedPlatformVariant</key>
34+
<string>simulator</string>
35+
</dict>
36+
</array>
37+
<key>CFBundlePackageType</key>
38+
<string>XFWK</string>
39+
<key>XCFrameworkFormatVersion</key>
40+
<string>1.0</string>
41+
</dict>
42+
</plist>

‎OMSDK_Seedtag.xcframework/ios-arm64_armv7/OMSDK_Seedtag.framework/Headers/OMIDAdEvents.h‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
//
2+
// OMIDAdEvents.h
3+
// AppVerificationLibrary
4+
//
5+
// Created by Daria Sukhonosova on 22/06/2017.
6+
//
7+
8+
#import <Foundation/Foundation.h>
9+
#import "OMIDAdSession.h"
10+
#import "OMIDVASTProperties.h"
11+
12+
/**
13+
* Ad event API enabling the integration partner to signal to all verification providers when key events have occurred.
14+
* Only one ad events implementation can be associated with the ad session and any attempt to create multiple instances will result in an error.
15+
*/
16+
@interface OMIDSeedtagAdEvents : NSObject
17+
18+
/**
19+
* Initializes ad events instance associated with the supplied ad session.
20+
*
21+
* @param session The ad session associated with the ad events.
22+
* @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.
23+
*/
24+
- (nullable instancetype)initWithAdSession:(nonnull OMIDSeedtagAdSession *)session error:(NSError * _Nullable * _Nullable)error;
25+
26+
/**
27+
* Notifies the ad session that an impression event has occurred.
28+
*
29+
* When triggered all registered verification providers will be notified of this event.
30+
*
31+
* NOTE: the ad session will be automatically started if this method has been called first.
32+
*/
33+
- (BOOL)impressionOccurredWithError:(NSError *_Nullable *_Nullable)error;
34+
35+
/**
36+
* Notifies the ad session that display loaded event has occurred.
37+
*
38+
* When triggered all registered verification providers will be notified of this event.
39+
*/
40+
- (BOOL)loadedWithError:(NSError *_Nullable *_Nullable)error;
41+
42+
/**
43+
* Notifies the ad session that video/audio loaded event has occurred.
44+
*
45+
* When triggered all registered verification providers will be notified of this event.
46+
* @param vastProperties contains static information about the video/audio placement.
47+
*/
48+
- (BOOL)loadedWithVastProperties:(OMIDSeedtagVASTProperties *_Nonnull)vastProperties
49+
error:(NSError *_Nullable *_Nullable)error;
50+
@end

‎OMSDK_Seedtag.xcframework/ios-arm64_armv7/OMSDK_Seedtag.framework/Headers/OMIDAdSession.h‎

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
//
2+
// OMIDAdSession.h
3+
// AppVerificationLibrary
4+
//
5+
// Created by Daria on 06/06/2017.
6+
//
7+
8+
#import <UIKit/UIKit.h>
9+
#import "OMIDAdSessionContext.h"
10+
#import "OMIDAdSessionConfiguration.h"
11+
#import "OMIDFriendlyObstructionType.h"
12+
13+
NS_ASSUME_NONNULL_BEGIN
14+
15+
/**
16+
* List of supported error types.
17+
*/
18+
typedef NS_ENUM(NSUInteger, OMIDErrorType) {
19+
/**
20+
* The integration is publishing a "generic" error to verification scripts.
21+
*/
22+
OMIDErrorGeneric = 1,
23+
/**
24+
* The integration is publishing a "video" error to verification scripts.
25+
*/
26+
OMIDErrorMedia = 2
27+
};
28+
29+
/**
30+
* Ad session API enabling the integration partner to notify OMID of key state relating to viewability calculations.
31+
* In addition to viewability this API will also notify all verification providers of key ad session lifecycle events.
32+
*/
33+
@interface OMIDSeedtagAdSession : NSObject
34+
35+
/**
36+
* The AdSession configuration is used for check owners.
37+
*/
38+
@property(nonatomic, readonly) OMIDSeedtagAdSessionConfiguration *configuration;
39+
/**
40+
* The native view which is used for viewability tracking.
41+
*/
42+
@property(nonatomic, weak, nullable) UIView *mainAdView;
43+
44+
/**
45+
* Initializes new ad session supplying the context.
46+
*
47+
* Note that creating an OMIDAdSession sends a message to the OM SDK JS Service running in the
48+
* webview. If the OM SDK JS Service has not loaded before the ad session is created, the
49+
* message is lost, and the verification scripts will not receive any events.
50+
*
51+
* To prevent this, the implementation must wait until the webview finishes loading OM SDK
52+
* JavaScript before creating the OMIDAdSession. The easiest way is to create the OMIDAdSession
53+
* in a webview delegate callback (-[WKNavigationDelegate webView:didFinishNavigation:]. Alternatively,
54+
* if an implementation can receive an HTML5 DOMContentLoaded event from the webview, it can create
55+
* the OMIDAdSession in a message handler for that event.
56+
*
57+
* @param context The context that provides the required information for initialising the ad session.
58+
* @return A new OMIDAdSession instance, or nil if the supplied context is nil.
59+
*/
60+
- (nullable instancetype)initWithConfiguration:(OMIDSeedtagAdSessionConfiguration *)configuration
61+
adSessionContext:(OMIDSeedtagAdSessionContext *)context
62+
error:(NSError *_Nullable *_Nullable)error;
63+
64+
65+
/**
66+
* Notifies all verification providers that the ad session has started and ad view tracking will begin.
67+
*
68+
* This method will have no affect if called after the ad session has finished.
69+
*/
70+
- (void)start;
71+
72+
/**
73+
* Notifies all verification providers that the ad session has finished and all ad view tracking will stop.
74+
*
75+
* This method will have no affect if called after the ad session has finished.
76+
*
77+
* Note that ending an OMID ad session sends a message to the verification scripts running inside
78+
* the webview supplied by the integration. So that the verification scripts have enough time to
79+
* handle the 'sessionFinish' event, the integration must maintain a strong reference to the webview
80+
* for at least 1.0 seconds after ending the session.
81+
*/
82+
- (void)finish;
83+
84+
/**
85+
* Adds friendly obstruction which should then be excluded from all ad session viewability calculations.
86+
* It also provides a purpose and detailed reason string to pass forward to the measurement vendors.
87+
*
88+
* This method will have no affect if called after the ad session has finished.
89+
*
90+
* @param friendlyObstruction The view to be excluded from all ad session viewability calculations.
91+
* @param purpose The purpose of why this obstruction was necessary.
92+
* @param detailedReason An explanation for why this obstruction is part of the ad experience if not already
93+
* obvious from the purpose. Can be nil. If not nil, must be 50 characters or less and only contain characers
94+
* `A-z`, `0-9`, or spaces.
95+
* @return Whether this friendly obstruction was successfully added. If the session has finished or the
96+
* friendlyObstruction has already been added for this session, this method will return NO with no associated
97+
* error object. However, if one or more arguments are against requirements, it will return NO with an error
98+
* object assigned.
99+
*/
100+
- (BOOL)addFriendlyObstruction:(UIView *)friendlyObstruction
101+
purpose:(OMIDFriendlyObstructionType)purpose
102+
detailedReason:(nullable NSString *)detailedReason
103+
error:(NSError *_Nullable *_Nullable)error;
104+
105+
/**
106+
* Removes registered friendly obstruction.
107+
*
108+
* This method will have no affect if called after the ad session has finished.
109+
*
110+
* @param friendlyObstruction The view to be removed from the list of registered friendly obstructions.
111+
*/
112+
- (void)removeFriendlyObstruction:(UIView *)friendlyObstruction;
113+
114+
/**
115+
* Utility method to remove all registered friendly obstructions.
116+
*
117+
* This method will have no affect if called after the ad session has finished.
118+
*/
119+
- (void)removeAllFriendlyObstructions;
120+
121+
/**
122+
* Notifies the ad session that an error has occurred.
123+
*
124+
* When triggered all registered verification providers will be notified of this event.
125+
*
126+
* @param errorType The type of error.
127+
* @param message The message containing details of the error.
128+
*/
129+
- (void)logErrorWithType:(OMIDErrorType)errorType message:(NSString *)message
130+
NS_SWIFT_NAME(logError(withType:message:));
131+
132+
@end
133+
134+
NS_ASSUME_NONNULL_END

‎OMSDK_Seedtag.xcframework/ios-arm64_armv7/OMSDK_Seedtag.framework/Headers/OMIDAdSessionConfiguration.h‎

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
//
2+
// OMIDAdSessionConfiguration.h
3+
// AppVerificationLibrary
4+
//
5+
// Created by Saraev Vyacheslav on 15/09/2017.
6+
//
7+
8+
#import <UIKit/UIKit.h>
9+
10+
/**
11+
* Identifies which integration layer is responsible for sending certain events.
12+
*/
13+
typedef NS_ENUM(NSUInteger, OMIDOwner) {
14+
/** The integration will send the event from a JavaScript session script. */
15+
OMIDJavaScriptOwner = 1,
16+
/** The integration will send the event from the native layer. */
17+
OMIDNativeOwner = 2,
18+
/** The integration will not send the event. */
19+
OMIDNoneOwner = 3
20+
};
21+
22+
23+
/**
24+
* List of supported creative types.
25+
*/
26+
typedef NS_ENUM(NSUInteger, OMIDCreativeType) {
27+
/**
28+
* Creative type will be set by JavaScript session script.
29+
* Integrations must also pass `OMIDJavaScriptOwner` for `impressionOwner`.
30+
*/
31+
OMIDCreativeTypeDefinedByJavaScript = 1,
32+
// Remaining values set creative type in native layer.
33+
/**
34+
* Rendered in webview, verification code can be inside creative or in metadata.
35+
*/
36+
OMIDCreativeTypeHtmlDisplay = 2,
37+
/**
38+
* Rendered by native, verification code provided in metadata only.
39+
*/
40+
OMIDCreativeTypeNativeDisplay = 3,
41+
/**
42+
* Rendered instream or as standalone video, verification code provided in metadata.
43+
*/
44+
OMIDCreativeTypeVideo = 4,
45+
/**
46+
* Similar to video but only contains audio media.
47+
*/
48+
OMIDCreativeTypeAudio = 5
49+
};
50+
51+
/**
52+
* The criterion for an ad session's OMID impression event.
53+
* Declaring an impression type makes it easier to understand discrepancies between measurers
54+
* of the ad session, since many metrics depend on impressions.
55+
*/
56+
typedef NS_ENUM(NSUInteger, OMIDImpressionType) {
57+
/**
58+
* ImpressionType will be set by JavaScript session script.
59+
* Integrations must also pass `OMIDJavaScriptOwner` for `impressionOwner`.
60+
*/
61+
OMIDImpressionTypeDefinedByJavaScript = 1,
62+
// Remaining values set ImpressionType in native layer.
63+
/**
64+
* The integration is not declaring the criteria for the OMID impression.
65+
*/
66+
OMIDImpressionTypeUnspecified = 2,
67+
/**
68+
* The integration is using count-on-download criteria for the OMID impression.
69+
*/
70+
OMIDImpressionTypeLoaded = 3,
71+
/**
72+
* The integration is using begin-to-render criteria for the OMID impression.
73+
*/
74+
OMIDImpressionTypeBeginToRender = 4,
75+
/**
76+
* The integration is using one-pixel criteria (when the creative has at least 1 visible pixel on
77+
* screen) for the OMID impression.
78+
*/
79+
OMIDImpressionTypeOnePixel = 5,
80+
/**
81+
* The integration is using viewable criteria (1 second for display, 2 seconds while playing for
82+
* video, and at least 50% of the creative is visible) for the OMID impression.
83+
*/
84+
OMIDImpressionTypeViewable = 6,
85+
/**
86+
* The integration is using audible criteria (2 continuous second of media playback with non-zero
87+
* volume) for the OMID impression.
88+
*/
89+
OMIDImpressionTypeAudible = 7,
90+
/**
91+
* The integration's criteria uses none of the above criteria for the OMID impression.
92+
*/
93+
OMIDImpressionTypeOther = 8
94+
};
95+
96+
/**
97+
* The ad session configuration supplies the owner for both the impression and video events.
98+
* The OM SDK JS service will use this information to help identify where the source of these
99+
* events is expected to be received.
100+
*/
101+
@interface OMIDSeedtagAdSessionConfiguration : NSObject
102+
103+
@property OMIDCreativeType creativeType;
104+
@property OMIDImpressionType impressionType;
105+
@property OMIDOwner impressionOwner;
106+
@property OMIDOwner mediaEventsOwner;
107+
@property BOOL isolateVerificationScripts;
108+
109+
/**
110+
* Create new ad session configuration supplying the owner for both the impression and media
111+
* events along with the type of creative being rendered/measured.
112+
* The OM SDK JS service will use this information to help identify where the source of these
113+
* events is expected to be received.
114+
* @param creativeType the type of creative to be rendered in this session.
115+
* @param impressionType the type of impression to be triggered in this session.
116+
* @param impressionOwner whether the native or JavaScript layer should be responsible for supplying
117+
* the impression event.
118+
* @param mediaEventsOwner whether the native or JavaScript layer should be responsible for
119+
* supplying media events. This needs to be set only for non-display ad sessions and can be set to
120+
* `OMIDNoneOwner` for display. When the creativeType is `OMIDCreativeTypeDefinedByJavaScript` then
121+
* this should be set to `OMIDJavaScriptOwner`
122+
* @param isolateVerificationScripts determines whether verification scripts will be placed in a
123+
* sandboxed environment. This will not have any effect for native sessions.
124+
* @return A new session configuration instance. Returns nil and sets error if OM SDK isn't active
125+
* or arguments are invalid.
126+
*/
127+
- (nullable instancetype)initWithCreativeType:(OMIDCreativeType)creativeType
128+
impressionType:(OMIDImpressionType)impressionType
129+
impressionOwner:(OMIDOwner)impressionOwner
130+
mediaEventsOwner:(OMIDOwner)mediaEventsOwner
131+
isolateVerificationScripts:(BOOL)isolateVerificationScripts
132+
error:(NSError *_Nullable *_Nullable)error;
133+
134+
@end
135+

0 commit comments

Comments
 (0)