Package com.theoplayer.android.api.ads

Interface GoogleImaAd

  • All Implemented Interfaces:
    com.theoplayer.android.api.ads.Ad 
    
public interface GoogleImaAd
 implements Ad

    The GoogleImaAd API represents a Google IMA creative compliant to the VAST specification.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract Ad getImaAd() The Ad object from the Google IMA SDK.
      abstract String getAdSystem() The source ad server information included in the ad response.
      abstract String getCreativeId() The identifier of the selected creative for the ad.
      abstract List<String> getWrapperAdIds() The list of wrapper ad identifiers as specified in the VAST response.
      abstract List<String> getWrapperAdSystems() The list of wrapper ad systems as specified in the VAST response.
      abstract List<String> getWrapperCreativeIds() The list of wrapper creative identifiers.
      abstract int getVastMediaBitrate() The bitrate of the currently playing creative as listed in the VAST response.
      abstract List<UniversalAdId> getUniversalAdIds() The list of universal ad ID information of the selected creative for the ad.
      abstract String getTraffickingParameters() A string with custom parameters associated with the ad at the time of ad trafficking.

      • Methods inherited from class com.theoplayer.android.api.ads.Ad

        getAdBreak, getCompanions, getId, getIntegration, getSkipOffset, getType

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • getImaAd

        @NonNull() abstract Ad getImaAd()

        The Ad object from the Google IMA SDK.

        • Only available with the 'Unified Android' SDK.
        Returns:

        The Google IMA Ad object. (NonNull)

      • getAdSystem

        @Nullable() abstract String getAdSystem()

        The source ad server information included in the ad response.

        Returns:

        The source ad server information. (Nullable)

      • getCreativeId

        @Nullable() abstract String getCreativeId()

        The identifier of the selected creative for the ad.

        Returns:

        The identifier of the creative. (Nullable)

      • getWrapperAdIds

        @NonNull() abstract List<String> getWrapperAdIds()

        The list of wrapper ad identifiers as specified in the VAST response.

        Returns:

        List of wrapper ad identifiers. (NonNull)

      • getWrapperAdSystems

        @NonNull() abstract List<String> getWrapperAdSystems()

        The list of wrapper ad systems as specified in the VAST response.

        Returns:

        List of wrapper ad systems. (NonNull)

      • getWrapperCreativeIds

        @NonNull() abstract List<String> getWrapperCreativeIds()

        The list of wrapper creative identifiers.

        • Starts with the first wrapper ad.
        Returns:

        List of wrapper creative identifiers. (NonNull)

      • getVastMediaBitrate

         abstract int getVastMediaBitrate()

        The bitrate of the currently playing creative as listed in the VAST response.

        Returns:

        The bitrate of the creative.

      • getTraffickingParameters

        @NonNull() abstract String getTraffickingParameters()

        A string with custom parameters associated with the ad at the time of ad trafficking.

        • Empty string if this information is not available.
        Returns:

        The trafficking parameters. (NonNull)