Package com.ooyala.pulse

Interface PulsePauseAd

  • All Superinterfaces:
    PulseAd
    public interface PulsePauseAd
extends PulseAd
    This interface is used to notify the owning PulseSession about events regarding a pause 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.

    • Method Detail

      • adClosed

        void adClosed()
        Notify the session that the pause ad has been closed by the user. Do not call if the ad was closed because the user resumed playback of the video content.

      • adClickThroughTriggered

        void adClickThroughTriggered()
        Notify the session that the user has opened the clickthrough link.

      • adFailed

        void adFailed​(PulseAdError error)
        Notify the session that, due to an error, the ad could not be displayed.
        Parameters:
        error - The PulseAdError that best describes the problem.

      • getResourceURL

        java.net.URL getResourceURL()
        Returns the URL where the ad's resource is located.
        Returns:
        the resource URL for this ad.

      • getResourceType

        java.lang.String getResourceType()
        Returns the MIME type of the resource for this ad.
        Returns:
        The resource type.

      • getClickThroughURL

        java.net.URL getClickThroughURL()
        Returns a URL for a web page that should be displayed to the user when they tap the ad.
        Returns:
        the URL to be displayed.

      • getCompanions

        java.util.List<PulseCompanionAd> getCompanions()
        The companions to show along with this ad. Bear in mind that only companion banners with resources of type StaticResource are returned.
        Returns:
        The companion(s) for this ad.

      • getTitle

        java.lang.String getTitle()
        The title of the ad.
        Returns:
        A string that provides a common name for the ad

      • getIdentifier

        java.lang.String getIdentifier()
        The ad identifier.
        Returns:
        The ad identifier.

      • getCustomIdentifier

        java.lang.String getCustomIdentifier()
        The custom ad identifier set in the Pulse UI.
        Returns:
        The custom ad identifier.

      • getCampaignIdentifier

        java.lang.String getCampaignIdentifier()
        The identifier of the campaign to which the ad belongs.
        Returns:
        The campaign identifier of the ad.

      • getAdvertiserIdentifier

        java.lang.String getAdvertiserIdentifier()
        The identifier of the advertiser to which the ad belongs.
        Returns:
        The identifier of advertiser.

      • getCustomCampaignIdentifier

        java.lang.String getCustomCampaignIdentifier()
        The custom identifier of the campaign to which the ad belongs; set in the Pulse UI.
        Returns:
        The custom campaign identifier of the ad.

      • getGoalIdentifier

        java.lang.String getGoalIdentifier()
        The identifier of the goal to which the ad belongs.
        Returns:
        The goal identifier of the ad.

      • getCustomGoalIdentifier

        java.lang.String getCustomGoalIdentifier()
        The custom identifier of the goal to which the ad belongs; set in the Pulse UI.
        Returns:
        The custom goal identifier of the ad.

      • isPartOfAnExclusiveCampaign

        boolean isPartOfAnExclusiveCampaign()
        Indicates whether the ad is part of an exclusive campaign.
        Returns:
        true if the ad is part of an exclusive campaign, otherwise false.

      • getCategories

        java.util.List<AdCategory> getCategories()
        The category labels identifying the ad's value.
        Returns:
        The List of AdCategory AdCategory containing the categories of the Ad and their responsible authorities.