@JsonClass(true) data class SxMacros
<init> |
SxMacros(context: Context, config: SxConfiguration)SxMacros(adCategories: List<String>? = null, appName: String? = null, appBundle: String? = null, apiFrameworks: List<Int>? = null, blockedCategories: List<String>? = null, breakPosition: SxBreakPosition? = null, clickType: SxClickType? = null, contentId: String? = null, contentPlayhead: String? = null, contentUri: String? = null, deviceIp: String? = null, domain: String? = null, extension: List<String>? = null, ifa: String? = null, ifaType: String? = null, inventoryState: List<String>? = null, latLong: String? = null, limitAdTracking: Int? = null, mediaMime: List<String>? = null, mediaPlayhead: String? = null, pageUrl: String = "", placementType: Int? = null, playerCapabilities: List<SxPlayerCapabilities>? = null, regulations: List<String>? = null, verificationVendors: List<String>? = null, gdprConsent: String? = null) |
adCategories |
List of desired ad categories. Encoded with IABN-N values. val adCategories: List<String>? |
apiFrameworks |
List of desired ad categories. Encoded with IABN-N values. val apiFrameworks: List<Int>? |
appBundle |
For app ads, a platform-specific application identifier, bundle or package name and should not be an app store ID such as iTunes store ID. val appBundle: String? |
appName |
Provides a proprietary macro for an App Name val appName: String? |
blockedCategories |
List of blocked ad categories. Encoded with IABN-N values. val blockedCategories: List<String>? |
breakPosition |
Position of the ad break within the underlying video/audio content. 1 for preroll, 2 for first midroll, ... val breakPosition: SxBreakPosition? |
clickType |
Identifier of the ClickType in val clickType: SxClickType? |
contentId |
Publisher-specific content identifier for the content asset into which the ad is being loaded or inserted. Only applicable to in-stream ads. val contentId: String? |
contentPlayhead |
val contentPlayhead: String? |
contentUri |
Publisher-specific content identifier for the content asset into which the ad is being loaded or inserted. Only applicable to in-stream ads. val contentUri: String? |
deviceIp |
IP address of the device that is rendering the ad to the end user. Only relevant when another device (server) is making the request on behalf of that client. val deviceIp: String? |
domain |
IP address/domain of the device that is rendering the ad to the end user. Only relevant when another device (server) is making the request on behalf of that client. val domain: String? |
extension |
List of VAST Extensions type attribute valuesdeviceScreenSize that the player / client supports. Can be used to indicate support for the OMID AdVerifications extension, proprietary extensions, or future standardized extensions. val extension: List<String>? |
gdprConsent |
val gdprConsent: String? |
ifa |
A resettable advertising ID from a device-specific advertising ID scheme, such as Apple’s ID for Advertisers or Android’s Advertising ID in UUID format or based on the IAB Tech Lab’s Guidelines for IFA on OTT platforms. val ifa: String? |
ifaType |
< String value indicating the type of IFA included in the IFA macro. val ifaType: String? |
inventoryState |
Attributes of the inventory. val inventoryState: List<String>? |
latLong |
Mobile detected geolocation info of the end user. val latLong: String? |
limitAdTracking |
The limit ad tracking setting of a device-specific advertising ID scheme. This value is a boolean, with true indicating that a user has opted for limited ad tracking, and false indicating that they have not. val limitAdTracking: Int? |
mediaMime |
List of media MIME types supported by the player. val mediaMime: List<String>? |
mediaPlayhead |
Deprecated: Playhead for the video or audio content (NOT the ad creative). val mediaPlayhead: String? |
pageUrl |
Needed to override JS default val pageUrl: String |
placementType |
Indicates the type of ad placement. Refer to the PlacementType list in AdCOM val placementType: Int? |
playerCapabilities |
List of capabilities supported by the player. val playerCapabilities: List<SxPlayerCapabilities>? |
regulations |
List of applicable regulations (possible: gdpr, coppa). val regulations: List<String>? |
verificationVendors |
List of VAST Verification vendor attribute values that the player / client supports. val verificationVendors: List<String>? |