OOPulsePauseAd Protocol Reference

Conforms to OOPulseAd
Declared in OOPulsePauseAd.h

Overview

This is the protocol for pause ads owned by a OOPulseSession.

This protocol is used to notify the session about events regarding this ad, and provides access to relevant properties.

You must notify this object of the following events:

Depending on your application some of the other methods may need to be called in response to user interaction.

Ad event notifications

– adDisplayed required method

Notify the session that the ad has been displayed

- (void)adDisplayed

Discussion

This should only be called after your delegate has been instructed to show the ad through [OOPulseSessionDelegate showPauseAd:].

Declared In

OOPulsePauseAd.h

– adClosed required method

Notify the session that the pause ad has been closed by the user.

- (void)adClosed

Discussion

Do not call if the ad was closed because the user resumed playback of the video content.

Declared In

OOPulsePauseAd.h

– adFailedWithError: required method

Notify the session that, due to an error, the ad could not be played or that playback could not continue.

- (void)adFailedWithError:(OOPulseAdError)error

Parameters

error

The OOPulseAdError that best describes the problem.

Declared In

OOPulsePauseAd.h

Ad properties

– resourceType required method

The MIME-type of the resource to display.

- (NSString *)resourceType

Declared In

OOPulsePauseAd.h

– resourceURL required method

The URL where the ad’s resource is located.

- (NSURL *)resourceURL

Declared In

OOPulsePauseAd.h

– identifier required method

The ad id.

- (NSString *)identifier

Declared In

OOPulsePauseAd.h

– customIdentifier required method

The custom ad identifier set in the Ooyala Pulse UI.

- (NSString *)customIdentifier

Declared In

OOPulsePauseAd.h

– campaignIdentifier required method

The Identifier of the campaign to which the ad belongs; supplied by Ooyala Pulse.

- (NSString *)campaignIdentifier

Declared In

OOPulsePauseAd.h

– customCampaignIdentifier required method

The custom Identifier of the campaign to which the ad belongs; set in the Ooyala Pulse UI.

- (NSString *)customCampaignIdentifier

Declared In

OOPulsePauseAd.h

– goalIdentifier required method

The Identifier of the goal to which the ad belongs; supplied by Ooyala Pulse.

- (NSString *)goalIdentifier

Declared In

OOPulsePauseAd.h

– customGoalIdentifier required method

The custom Identifier of the goal to which the ad belongs; set in the Ooyala Pulse UI.

- (NSString *)customGoalIdentifier

Declared In

OOPulsePauseAd.h

– partOfAnExclusiveCampaign required method

Whether or not the ad is part of an exclusive campaign.

- (BOOL)partOfAnExclusiveCampaign

Declared In

OOPulsePauseAd.h

– title required method

A string that provides a common name for the ad.

- (NSString *)title

Declared In

OOPulsePauseAd.h

– categories required method

An array of OOAdCategory objects containing the categories of the Ad and their responsible authorities.

- (NSArray *)categories

Declared In

OOPulsePauseAd.h

– companions required method

Returns an array of companion banners for this ad.

- (NSArray<id<OOPulseCompanionAd> > *)companions

Return Value

A NSArray of objects conforming to the OOPulseCompanionAd protocol.

Discussion

Your application should choose the proper companion banner to display based on their zone identifier.

Declared In

OOPulsePauseAd.h