adswizz-common/com.adswizz.common.macro/AdMacroProvider

AdMacroProvider

The AdMacroProvider interface is used to provide various macros that cannot be automatically computed by the SDK. The methods can be selectively overridden depending on the integration scenario.

Functions

getContentId

open fun getContentId(): String?

This method is used to provide values for the CONTENTID macro.
CONTENTID is content identifier for the content asset into which the ad is being loaded or inserted.
Applicable to ad request & all tracking pixels.
default value is null

getContentUri

open fun getContentUri(): String?

This method is used to provide values for the CONTENTURI macro.
CONTENTURI is the URI of the main media content asset into which the ad is being loaded or inserted
Applicable to ad request & all tracking pixels.
default value is null

getLinearMediaPlayheadEpochMillis

open fun getLinearMediaPlayheadEpochMillis(): Long?

This method is used to provide values for the LINEAR_MEDIAPLAYHEAD_UTC macro. LINEAR_MEDIAPLAYHEAD_UTC is the absolute UTC playback position on a linear feed derived by the host app from the linear feed's ad-break play point. Unlike the standard VAST MEDIAPLAYHEAD, this value carries a full date and is emitted in ISO-8601 YYYY-MM-DDTHH:MM:SS.mmmZ (UTC). The value is provided as epoch milliseconds (UTC); the SDK is responsible for formatting. Applicable to all tracking pixels. Negative values are considered invalid. default value is null

getMediaPlayhead

open fun getMediaPlayhead(): Duration?

This method is used to provide values for the MEDIAPLAYHEAD macro.
MEDIAPLAYHEAD is playhead position of the video or audio content (NOT the ad creative).
Applicable to ad request & all tracking pixels.
default value is null