OOPulseCompanionAd

Objective-C

@protocol OOPulseCompanionAd <OOPulseAd>

Swift

protocol OOPulseCompanionAd : OOPulseAd

This protocol is used to handle companion banners, and notify the OOPulseSession about events regarding the companion banner.

As a minimum, the session object must be notified that the companion banner was displayed: -[OOPulseCompanionAd adDisplayed].

Depending on your application, you may also need the clickthrough URL (-[OOPulseAd clickthroughURL]) to respond to viewers tapping a companion banner.

  • Notify the session that the ad has been displayed

    Declaration

    Objective-C

    - (void)adDisplayed;

    Swift

    func adDisplayed()

  • The URL where the ad’s resource is located.

    Declaration

    Objective-C

    - (NSURL *)resourceURL;

    Swift

    func resourceURL() -> URL!

  • The MIME type of the resource to be displayed.

    Declaration

    Objective-C

    - (NSString *)resourceType;

    Swift

    func resourceType() -> String!

  • Returns the zone identifier assigned to this companion ad.

    Declaration

    Objective-C

    - (NSString *)zoneIdentifier;

    Swift

    func zoneIdentifier() -> String!

  • The companion ad id assigned by Ooyala Pulse.

    Declaration

    Objective-C

    - (NSString *)identifier;

    Swift

    func identifier() -> String!

  • The custom companion ad id set in the Ooyala Pulse UI.

    Declaration

    Objective-C

    - (NSString *)customIdentifier;

    Swift

    func customIdentifier() -> String!

  • The companion’s width.

    Declaration

    Objective-C

    - (NSInteger)width;

    Swift

    func width() -> Int

  • The companion’s height.

    Declaration

    Objective-C

    - (NSInteger)height;

    Swift

    func height() -> Int