Class IconDisplayInfo
-
- All Implemented Interfaces:
-
android.os.Parcelable,com.naver.ads.video.player.ClickTrackingProvider,com.naver.ads.video.player.ImpressionTrackingProvider,com.naver.ads.video.player.TrackingProvider,com.naver.ads.video.vast.ResolvedIcon,com.naver.ads.video.vast.ResourcesProvider
public final class IconDisplayInfo implements ResolvedIcon
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enumIconDisplayInfo.IconStaticResourcepublic classIconDisplayInfo.Companion
-
Field Summary
Fields Modifier and Type Field Description private final IconDisplayInfo.IconStaticResourcestaticResourceCodeprivate final Stringprogramprivate final Integerwidthprivate final Integerheightprivate final StringxPositionprivate final StringyPositionprivate final Longdurationprivate final Longoffsetprivate final StringapiFrameworkprivate final StringclickThroughUrlTemplateprivate final List<String>clickTrackingUrlTemplatesprivate final List<String>customClickUrlTemplatesprivate final List<String>impressionUrlTemplatesprivate final List<StaticResource>staticResourcesprivate final List<String>iFrameResourcesprivate final List<String>htmlResourcesprivate final StringresourceCodeprivate final StringresourceValuepublic final static IconDisplayInfo.CompanionCompanion
-
Constructor Summary
Constructors Constructor Description IconDisplayInfo(String resourceCode, String resourceValue, ResolvedIcon resolvedIcon)
-
Method Summary
Modifier and Type Method Description final IconDisplayInfo.IconStaticResourcegetStaticResourceCode()StringgetProgram()the program represented in the icon (e.g. IntegergetWidth()the pixel width of the icon asset. IntegergetHeight()the pixel height of the icon asset. StringgetXPosition()the x-coordinate of the top, left corner of the icon asset relative to the ad display area. StringgetYPosition()the y-coordinate of the top left corner of the icon asset relative to the ad display area. LonggetDuration()the duration the icon should be displayed unless clicked or ad is finished playing. LonggetOffset()the time of delay from when the associated linear creative begins playing to when the icon should be displayed. StringgetApiFramework()identifies the API needed to execute the icon resource file if applicable. StringgetClickThroughUrlTemplate()the uri to the advertiser's site that the media player opens when a viewer clicks the ad. List<String>getClickTrackingUrlTemplates()the list of uris that can be used in the case where multiple parties would like to track the Linear clickthrough. List<String>getCustomClickUrlTemplates()the list of uris used to track any interactions with the linear ad that do not include the clickthrough click and do not take the viewer away from the media player List<String>getImpressionUrlTemplates()a list of impression tracking url templates of video ads. List<StaticResource>getStaticResources()the list of StaticResource. List<String>getIFrameResources()the list of iFrameResourceList<String>getHtmlResources()the list of htmlResourcefinal StringgetResourceCode()final StringgetResourceValue()final BooleancanVisible(Long contentPosition)-
-
Constructor Detail
-
IconDisplayInfo
IconDisplayInfo(String resourceCode, String resourceValue, ResolvedIcon resolvedIcon)
-
-
Method Detail
-
getStaticResourceCode
final IconDisplayInfo.IconStaticResource getStaticResourceCode()
-
getProgram
String getProgram()
the program represented in the icon (e.g.
AdChoices).
-
getXPosition
String getXPosition()
the x-coordinate of the top, left corner of the icon asset relative to the ad display area. Values of
leftorrightalso accepted and indicate the leftmost or rightmost available position for the icon asset.
-
getYPosition
String getYPosition()
the y-coordinate of the top left corner of the icon asset relative to the ad display area. values of
toporbottomalso accepted and indicate the topmost or bottommost available position for the icon asset.
-
getDuration
Long getDuration()
the duration the icon should be displayed unless clicked or ad is finished playing.
-
getOffset
Long getOffset()
the time of delay from when the associated linear creative begins playing to when the icon should be displayed.
-
getApiFramework
String getApiFramework()
identifies the API needed to execute the icon resource file if applicable.
-
getClickThroughUrlTemplate
String getClickThroughUrlTemplate()
the uri to the advertiser's site that the media player opens when a viewer clicks the ad.
-
getClickTrackingUrlTemplates
List<String> getClickTrackingUrlTemplates()
the list of uris that can be used in the case where multiple parties would like to track the Linear clickthrough.
-
getCustomClickUrlTemplates
List<String> getCustomClickUrlTemplates()
the list of uris used to track any interactions with the linear ad that do not include the clickthrough click and do not take the viewer away from the media player
-
getImpressionUrlTemplates
List<String> getImpressionUrlTemplates()
a list of impression tracking url templates of video ads.
-
getStaticResources
List<StaticResource> getStaticResources()
the list of StaticResource.
-
getIFrameResources
List<String> getIFrameResources()
the list of
iFrameResource
-
getHtmlResources
List<String> getHtmlResources()
the list of
htmlResource
-
getResourceCode
final String getResourceCode()
-
getResourceValue
final String getResourceValue()
-
canVisible
final Boolean canVisible(Long contentPosition)
-
-
-
-