IMAAd.h
1 //
2 // IMAAd.h
3 // GoogleIMA3
4 //
5 // Copyright (c) 2013 Google Inc. All rights reserved.
6 //
7 // Represents metadata of a single ad. The user can use this metadata for
8 // positioning nonlinear ads (isLinear, width, height), internal tracking
9 // (adId, adTitle) or custom behavior (traffickingParameters).
10 
11 #import <Foundation/Foundation.h>
12 
13 #import "IMAAdPodInfo.h"
14 
18 @interface IMAAd : NSObject
19 
23 @property(nonatomic, copy, readonly) NSString *adId;
24 
28 @property(nonatomic, copy, readonly) NSString *adTitle;
29 
33 @property(nonatomic, copy, readonly) NSString *adDescription;
34 
38 @property(nonatomic, copy, readonly) NSString *adSystem;
39 
45 @property(nonatomic, copy, readonly) NSString *contentType;
46 
50 @property(nonatomic, readonly) NSTimeInterval duration;
51 
57 @property(nonatomic, copy, readonly) NSArray *uiElements;
58 
63 @property(nonatomic, readonly, getter=isUiDisabled) BOOL uiDisabled;
64 
70 @property(nonatomic, readonly) NSInteger width;
71 
77 @property(nonatomic, readonly) NSInteger height;
78 
82 @property(nonatomic, readonly) NSInteger VASTMediaWidth;
83 
87 @property(nonatomic, readonly) NSInteger VASTMediaHeight;
88 
92 @property(nonatomic, readonly) NSInteger VASTMediaBitrate;
93 
97 @property(nonatomic, readonly, getter=isLinear) BOOL linear;
98 
102 @property(nonatomic, readonly, getter=isSkippable) BOOL skippable;
103 
108 @property(nonatomic, readonly) NSTimeInterval skipTimeOffset;
109 
113 @property(nonatomic, strong, readonly) IMAAdPodInfo *adPodInfo;
114 
118 @property(nonatomic, copy, readonly) NSString *traffickingParameters;
119 
123 @property(nonatomic, copy, readonly) NSString *creativeID;
124 
129 @property(nonatomic, copy, readonly) NSString *creativeAdID;
130 
135 @property(nonatomic, copy, readonly) NSString *universalAdIdValue;
136 
141 @property(nonatomic, copy, readonly) NSString *universalAdIdRegistry;
142 
146 @property(nonatomic, copy, readonly) NSString *advertiserName;
147 
151 @property(nonatomic, copy, readonly) NSString *surveyURL;
152 
157 @property(nonatomic, copy, readonly) NSString *dealID;
158 
162 @property(nonatomic, copy, readonly) NSArray<NSString *> *wrapperAdIDs;
163 
167 @property(nonatomic, copy, readonly) NSArray<NSString *> *wrapperCreativeIDs;
168 
173 @property(nonatomic, copy, readonly) NSArray<NSString *> *wrapperSystems;
174 
178 - (instancetype)init NS_UNAVAILABLE;
179 
180 @end
NSInteger width
The width of the ad asset.
Definition: IMAAd.h:70
NSTimeInterval skipTimeOffset
The number of seconds of playback before the ad becomes skippable.
Definition: IMAAd.h:108
IMAAdPodInfo * adPodInfo
Set of ad podding properties.
Definition: IMAAd.h:113
NSInteger height
The height of the ad asset.
Definition: IMAAd.h:77
NSTimeInterval duration
The duration of the ad from the VAST response.
Definition: IMAAd.h:50
NSString * contentType
Content type of the currently selected creative.
Definition: IMAAd.h:45
NSString * creativeAdID
Returns the ISCI (Industry Standard Commercial Identifier) code for an ad.
Definition: IMAAd.h:129
NSString * traffickingParameters
String representing custom trafficking parameters from the VAST response.
Definition: IMAAd.h:118
BOOL linear
Specifies whether the ad is linear or non-linear.
Definition: IMAAd.h:97
NSArray * uiElements
The UI elements that will be displayed during ad playback.
Definition: IMAAd.h:57
NSString * dealID
Returns the first deal ID present in the wrapper chain for the current ad, starting from the top...
Definition: IMAAd.h:157
NSString * advertiserName
The advertiser name as defined by the serving party.
Definition: IMAAd.h:146
NSArray< NSString * > * wrapperAdIDs
The IDs of the ads, starting with the first wrapper ad.
Definition: IMAAd.h:162
NSArray< NSString * > * wrapperSystems
Ad systems used for wrapper ads.
Definition: IMAAd.h:173
NSInteger VASTMediaBitrate
The bitrate of the selected creative as specified in the VAST response.
Definition: IMAAd.h:92
NSString * adDescription
The ad description.
Definition: IMAAd.h:33
NSInteger VASTMediaWidth
The width of the selected creative as specified in the VAST response.
Definition: IMAAd.h:82
NSString * surveyURL
Returns the URL associated with the survey for the given ad.
Definition: IMAAd.h:151
NSString * universalAdIdRegistry
The registry associated with cataloging the UniversalAdId of the selected creative for the ad...
Definition: IMAAd.h:141
NSString * adTitle
The ad title from the VAST response.
Definition: IMAAd.h:28
instancetype NS_UNAVAILABLE()
:nodoc:
NSString * universalAdIdValue
The UniversalAdId of the selected creative for the ad.
Definition: IMAAd.h:135
Data object representing a single ad.
Definition: IMAAd.h:18
NSString * adId
The ad ID as specified in the VAST response.
Definition: IMAAd.h:23
BOOL uiDisabled
Whether or not the ad UI will be disabled for this ad.
Definition: IMAAd.h:63
Simple data object containing podding metadata.
Definition: IMAAdPodInfo.h:14
BOOL skippable
Specifies whether the ad is skippable.
Definition: IMAAd.h:102
NSString * adSystem
The source ad server information included in the ad response.
Definition: IMAAd.h:38
NSString * creativeID
Returns the ID of the selected creative for the ad.
Definition: IMAAd.h:123
NSArray< NSString * > * wrapperCreativeIDs
The IDs of the ads&#39; creatives, starting with the first wrapper ad.
Definition: IMAAd.h:167
NSInteger VASTMediaHeight
The height of the selected creative as specified in the VAST response.
Definition: IMAAd.h:87