IMAAd Class Reference

IMAAd Class Reference

Overview

Data object representing a single ad.

Inherits NSObject.

Instance Methods

(instancetype) - NS_UNAVAILABLE
 :nodoc: More...
 

Properties

NSString * adId
 The ad ID as specified in the VAST response. More...
 
NSString * adTitle
 The ad title from the VAST response. More...
 
NSString * adDescription
 The ad description. More...
 
NSString * adSystem
 The source ad server information included in the ad response. More...
 
NSString * contentType
 Content type of the currently selected creative. More...
 
NSTimeInterval duration
 The duration of the ad from the VAST response. More...
 
int width
 The width of the ad asset. More...
 
int height
 The height of the ad asset. More...
 
BOOL linear
 Specifies whether the ad is linear or non-linear. More...
 
BOOL skippable
 Specifies whether the ad is skippable. More...
 
NSTimeInterval skipTimeOffset
 The number of seconds of playback before the ad becomes skippable. More...
 
IMAAdPodInfoadPodInfo
 Set of ad podding properties. More...
 
NSString * traffickingParameters
 String representing custom trafficking parameters from the VAST response. More...
 
NSString * creativeID
 Returns the ID of the selected creative for the ad. More...
 
NSString * creativeAdID
 Returns the ISCI (Industry Standard Commercial Identifier) code for an ad. More...
 
NSString * universalAdIdValue
 The UniversalAdId of the selected creative for the ad. More...
 
NSString * universalAdIdRegistry
 The registry associated with cataloging the UniversalAdId of the selected creative for the ad. More...
 
NSString * advertiserName
 The advertiser name as defined by the serving party. More...
 
NSString * dealID
 Returns the first deal ID present in the wrapper chain for the current ad, starting from the top. More...
 
NSArray< NSString * > * wrapperAdIDs
 The IDs of the ads, starting with the first wrapper ad. More...
 
NSArray< NSString * > * wrapperCreativeIDs
 The IDs of the ads' creatives, starting with the first wrapper ad. More...
 
NSArray< NSString * > * wrapperSystems
 Ad systems used for wrapper ads. More...
 

Method Documentation

- (instancetype) NS_UNAVAILABLE

:nodoc:

Property Documentation

- (NSString*) adId
readnonatomiccopy

The ad ID as specified in the VAST response.

- (NSString*) adTitle
readnonatomiccopy

The ad title from the VAST response.

- (NSString*) adDescription
readnonatomiccopy

The ad description.

- (NSString*) adSystem
readnonatomiccopy

The source ad server information included in the ad response.

- (NSString*) contentType
readnonatomiccopy

Content type of the currently selected creative.

For linear creatives returns the content type of the currently selected media file. Returns empty string if no creative or media file is selected on this ad.

- (NSTimeInterval) duration
readnonatomicassign

The duration of the ad from the VAST response.

- (int) width
readnonatomicassign

The width of the ad asset.

For non-linear ads, this is the actual width of the ad representation. For linear ads, since they scale seamlessly, we currently return 0 for the width.

- (int) height
readnonatomicassign

The height of the ad asset.

For non-linear ads, this is the actual height of the ad representation. For linear ads, since they scale seamlessly, we currently return 0 for height.

- (BOOL) linear
readnonatomicassign

Specifies whether the ad is linear or non-linear.

- (BOOL) skippable
readnonatomicassign

Specifies whether the ad is skippable.

- (NSTimeInterval) skipTimeOffset
readnonatomicassign

The number of seconds of playback before the ad becomes skippable.

-1 is returned for non skippable ads or if this is unavailable.

- (IMAAdPodInfo*) adPodInfo
readnonatomicstrong

Set of ad podding properties.

- (NSString*) traffickingParameters
readnonatomiccopy

String representing custom trafficking parameters from the VAST response.

- (NSString*) creativeID
readnonatomiccopy

Returns the ID of the selected creative for the ad.

- (NSString*) creativeAdID
readnonatomiccopy

Returns the ISCI (Industry Standard Commercial Identifier) code for an ad.

This is the Ad-ID of the selected creative in the VAST response.

- (NSString*) universalAdIdValue
readnonatomiccopy

The UniversalAdId of the selected creative for the ad.

Returns the id value or "unknown" if unavailable.

- (NSString*) universalAdIdRegistry
readnonatomiccopy

The registry associated with cataloging the UniversalAdId of the selected creative for the ad.

Returns the registry value, or "unknown" if unavailable.

- (NSString*) advertiserName
readnonatomiccopy

The advertiser name as defined by the serving party.

- (NSString*) dealID
readnonatomiccopy

Returns the first deal ID present in the wrapper chain for the current ad, starting from the top.

- (NSArray<NSString *>*) wrapperAdIDs
readnonatomiccopy

The IDs of the ads, starting with the first wrapper ad.

- (NSArray<NSString *>*) wrapperCreativeIDs
readnonatomiccopy

The IDs of the ads' creatives, starting with the first wrapper ad.

- (NSArray<NSString *>*) wrapperSystems
readnonatomiccopy

Ad systems used for wrapper ads.

The ad systems returned begin with the first wrapper ad and continue to each wrapper ad recursively.

Send feedback about...

IMA Client-Side SDK for tvOS
Need help? Visit our support page.