<FWAdInstance > Protocol Reference

Protocol for ad instance. More...

#import <FWProtocols.h>

+ Inheritance diagram for <FWAdInstance >:

Instance Methods

(NSUInteger) - adId
 Get the ad ID of the ad instance. More...
 
(NSString *) - adUniqueId
 
(NSUInteger) - creativeId
 Get the creative ID of the ad instance This is the creative ID associated with this ad. More...
 
(id< FWCreativeRendition >) - primaryCreativeRendition
 Get the primary rendition of the ad instance. More...
 
(NSArray *) - getEventCallbackUrls::
 
(NSArray *) - getEventCallbackUrlsByEventName:eventType:
 Get the callback urls for the specified event. More...
 
(void) - setEventCallbackUrls:::
 
(void) - setEventCallbackUrls:forEventName:eventType:
 Set callback urls for the specified event. More...
 
(id< FWCreativeRendition >) - addCreativeRendition
 Add a creative rendition to the ad instance. More...
 
(id< FWRendererController >) - rendererController
 Get the renderer controller of the ad instance. More...
 
(id) - getParameter:
 Retrieve the parameter from the ad instance. More...
 
(NSArray *) - companionSlots
 Get the companion slots of the ad instance. More...
 
(NSArray *) - companionAdInstances
 Get the playable companion ad instances. More...
 
(BOOL) - isRequiredToShow
 Whether the ad is required to be shown by law, usually the ad is a companion ad. More...
 
(NSArray */*id< FWCreativeRendition > */) - creativeRenditions
 Get all creative renditions of the ad instance. More...
 
(void) - setPrimaryCreativeRendition:
 Set the primary creative rendition. More...
 
(id< FWSlot >) - slot
 Get the slot that contains this ad instance. More...
 
(void) - play2
 
(NSTimeInterval) - duration
 Get duration of the ad instance. More...
 
(NSTimeInterval) - playheadTime
 Get the ad instance's playhead. More...
 

Detailed Description

Protocol for ad instance.

Method Documentation

- (id<FWCreativeRendition> FWAdInstance) addCreativeRendition

Add a creative rendition to the ad instance.

Returns
the FWCreativeRendition object added to the ad instance
- (NSUInteger FWAdInstance) adId

Get the ad ID of the ad instance.

This value can also be found in the advertising module of the FreeWheel MRM UI.

Returns
ID of the ad instance
- (NSString * FWAdInstance) adUniqueId
- (NSArray * FWAdInstance) companionAdInstances

Get the playable companion ad instances.

Returns
an array of id<FWAdInstance>
- (NSArray * FWAdInstance) companionSlots

Get the companion slots of the ad instance.

Returns
an array of id<FWSlot>
- (NSUInteger FWAdInstance) creativeId

Get the creative ID of the ad instance This is the creative ID associated with this ad.

The value can also be found in the advertising module of the FreeWheel MRM UI.

Returns
Creative ID as an unsigned int
- (NSArray* /*id<FWCreativeRendition>*/ FWAdInstance) creativeRenditions

Get all creative renditions of the ad instance.

- (NSTimeInterval FWAdInstance) duration

Get duration of the ad instance.

Returns
Duration in seconds
- (NSArray * FWAdInstance) getEventCallbackUrls: (NSString *)  eventName
: (NSString *)  DEPRECATED_ATTRIBUTE 
- (NSArray * FWAdInstance) getEventCallbackUrlsByEventName: (NSString *)  eventName
eventType: (NSString *)  eventType 

Get the callback urls for the specified event.

Parameters
eventNamename of the event, FW_EVENT_AD_*
eventTypetype of the event, FW_EVENT_TYPE_* Valid eventName/eventType pairs:
  • (FW_EVENT_AD_IMPRESSION, FW_EVENT_TYPE_IMPRESSION) - ad impression
  • (FW_EVENT_AD_FIRST_QUARTILE, FW_EVENT_TYPE_IMPRESSION) - firstQuartile
  • (FW_EVENT_AD_MIDPOINT, FW_EVENT_TYPE_IMPRESSION) - midPoint
  • (FW_EVENT_AD_THIRD_QUARTILE, FW_EVENT_TYPE_IMPRESSION) - thirdQuartile
  • (FW_EVENT_AD_COMPLETE, FW_EVENT_TYPE_IMPRESSION) - complete
  • (FW_EVENT_AD_CLICK, FW_EVENT_TYPE_CLICK) - click through
  • (FW_EVENT_AD_CLICK, FW_EVENT_TYPE_CLICKTRACKING) - click tracking
  • ("custom_click_name", FW_EVENT_TYPE_CLICK) - custom click
  • ("custom_click_tracking_name", FW_EVENT_TYPE_CLICKTRACKING) - custom click tracking
  • (FW_EVENT_AD_PAUSE, FW_EVENT_TYPE_STANDARD) - IAB metric, pause
  • (FW_EVENT_AD_RESUME, FW_EVENT_TYPE_STANDARD) - IAB metric, resume
  • (FW_EVENT_AD_REWIND, FW_EVENT_TYPE_STANDARD) - IAB metric, rewind
  • (FW_EVENT_AD_MUTE, FW_EVENT_TYPE_STANDARD) - IAB metric, mute
  • (FW_EVENT_AD_UNMUTE, FW_EVENT_TYPE_STANDARD) - IAB metric, unmute
  • (FW_EVENT_AD_COLLAPSE, FW_EVENT_TYPE_STANDARD) - IAB metric, collapse
  • (FW_EVENT_AD_EXPAND, FW_EVENT_TYPE_STANDARD) - IAB metric, expand
  • (FW_EVENT_AD_MINIMIZE, FW_EVENT_TYPE_STANDARD) - IAB metric, minimize
  • (FW_EVENT_AD_CLOSE, FW_EVENT_TYPE_STANDARD) - IAB metric, close
  • (FW_EVENT_AD_ACCEPT_INVITATION, FW_EVENT_TYPE_STANDARD) - IAB metric, accept invitation
Returns
: Array of urls in NSString
- (id FWAdInstance) getParameter: (NSString *)  name

Retrieve the parameter from the ad instance.

The parameter value will be retrieved from levels in the following order: override, creative rendition, creative, slot, profile, global.

Parameters
nameparameter name
Returns
the value of the parameter
- (BOOL FWAdInstance) isRequiredToShow

Whether the ad is required to be shown by law, usually the ad is a companion ad.

Returns
a Bool true if this ad is required to be shown, otherwise false
- (void FWAdInstance) play2
- (NSTimeInterval FWAdInstance) playheadTime

Get the ad instance's playhead.

Returns
the playhead time in seconds, greater than or equal to 0
- (id<FWCreativeRendition> FWAdInstance) primaryCreativeRendition

Get the primary rendition of the ad instance.

Returns
An id<FWCreativeRendition>
- (id<FWRendererController> FWAdInstance) rendererController

Get the renderer controller of the ad instance.

Returns
An id<FWRendererController>
- (void FWAdInstance) setEventCallbackUrls: (NSString *)  eventName
: (NSString *)  eventType
: (NSArray *)  DEPRECATED_ATTRIBUTE 
- (void FWAdInstance) setEventCallbackUrls: (NSArray *)  urls
forEventName: (NSString *)  eventName
eventType: (NSString *)  eventType 

Set callback urls for the specified event.

Parameters
eventNamename of event, FW_EVENT_AD_*
eventTypetype of event, FW_EVENT_TYPE_*
urlsexternal urls to ping Valid eventName/eventType pairs:
  • (FW_EVENT_AD_IMPRESSION, FW_EVENT_TYPE_IMPRESSION) - ad impression
  • (FW_EVENT_AD_FIRST_QUARTILE, FW_EVENT_TYPE_IMPRESSION) - 1st quartile
  • (FW_EVENT_AD_MIDPOINT, FW_EVENT_TYPE_IMPRESSION) - midpoint
  • (FW_EVENT_AD_THIRD_QUARTILE, FW_EVENT_TYPE_IMPRESSION) - 3rd quartile
  • (FW_EVENT_AD_COMPLETE, FW_EVENT_TYPE_IMPRESSION) - complete
  • (FW_EVENT_AD_CLICK, FW_EVENT_TYPE_CLICK) - click through
  • (FW_EVENT_AD_CLICK, FW_EVENT_TYPE_CLICK_TRACKING) - click tracking
  • ("custom_click_name", FW_EVENT_TYPE_CLICK) - custom click through
  • ("custom_click_name", FW_EVENT_TYPE_CLICK_TRACKING) - custom click tracking
  • (FW_EVENT_AD_PAUSE, FW_EVENT_TYPE_STANDARD) - IAB metric, pause
  • (FW_EVENT_AD_RESUME, FW_EVENT_TYPE_STANDARD) - IAB metric, resume
  • (FW_EVENT_AD_REWIND, FW_EVENT_TYPE_STANDARD) - IAB metric, rewind
  • (FW_EVENT_AD_MUTE, FW_EVENT_TYPE_STANDARD) - IAB metric, mute
  • (FW_EVENT_AD_UNMUTE, FW_EVENT_TYPE_STANDARD) - IAB metric, unmute
  • (FW_EVENT_AD_COLLAPSE, FW_EVENT_TYPE_STANDARD) - IAB metric, collapse
  • (FW_EVENT_AD_EXPAND, FW_EVENT_TYPE_STANDARD) - IAB metric, expand
  • (FW_EVENT_AD_MINIMIZE, FW_EVENT_TYPE_STANDARD) - IAB metric, minimize
  • (FW_EVENT_AD_CLOSE, FW_EVENT_TYPE_STANDARD) - IAB metric, close
  • (FW_EVENT_AD_ACCEPT_INVITATION, FW_EVENT_TYPE_STANDARD) - IAB metric, accept invitation
- (void FWAdInstance) setPrimaryCreativeRendition: (id< FWCreativeRendition >)  primaryCreativeRendition

Set the primary creative rendition.

Parameters
primaryCreativeRenditiona pointer to the primary creative rendition
- (id<FWSlot> FWAdInstance) slot

Get the slot that contains this ad instance.


The documentation for this protocol was generated from the following file: