adswizz-core/com.adswizz.core.adFetcher/AdswizzAdRequest/Builder

Builder

Helper class to configure AdswizzAdRequest

Constructors

constructor()

Properties

analyticsCustomData

var analyticsCustomData: AnalyticsCustomData?

The analytics custom data used for analytics events

var companionZones: String?

The companion zone id

companionZonesAliases

var companionZonesAliases: String?

var customParam: String?

The additional custom parameters

var duration: Long?

The maximum total duration of ads to be selected, in seconds

enableExpectedAdsReporting

var enableExpectedAdsReporting: Boolean

Enable reporting of expected ads ( maximumAds requeste - ads returned ) missing from vast response

var httpProtocol: AdswizzAdRequest.HttpProtocol

Http protocol - default is "https" Possible values: "http", "https"

palNonceHandler

var palNonceHandler: PalNonceHandlerInterface?

The programmatic access library nonce handler

var referrer: String?

This is the an unique identifier of the application and should be a string like an http address.

var server: String?

The server url

var shimZone: AdswizzShimZone?

This zone is a special zones that contains shim ads used to fill ad break should be the last one in the serialized AdEvents url parameter

var tagsArray: String?

The tags used for requesting the ads. Optional

var tcfv2: String?

The TCFv2 string from Transparency and Consent Framework

var vastVersion: AdswizzAdRequest.VastVersion

Vast version - default is "4.1" Possible values: "4.0", "4.1"

var zoneAlias: String?

The zone alias referencing external zone

var zones: List<AdswizzAdZone>?

The zone on which the request will be made

Functions

fun build(completionBlock: (AdswizzAdRequest) -> Unit)

Builds an AdswizzAdRequest object

open override fun toString(): String

Prints current Builder values

withAnalyticsCustomData

fun withAnalyticsCustomData(analyticsCustomData: AnalyticsCustomData?): AdswizzAdRequest.Builder

Set custom analytics data used for analytics events. Optional.

withCompanionZoneAliases

fun withCompanionZoneAliases(companionZoneAliases: List<String>): AdswizzAdRequest.Builder

Set a companion zone aliases list. Optional.

withCompanionZoneIds

fun withCompanionZoneIds(companionZoneIds: List<Int>): AdswizzAdRequest.Builder

Set a companion zone ids list. Optional.

withCompanionZones

fun ~~withCompanionZones~~(companionZones: String?): AdswizzAdRequest.Builder

Set the companion zone id. Optional.

withCustomParameter

fun withCustomParameter(customParam: String): AdswizzAdRequest.Builder

Set additional custom parameters to AdswizzAdRequest. Optional. Note that it should be only used at the recommendation of AdsWizz. All parameters must be URL encoded.

fun withDuration(duration: Long?): AdswizzAdRequest.Builder

Set maximum total duration of ads to be selected (AdBreak duration) in milliseconds. Optional

withExpectedAdsReporting

fun withExpectedAdsReporting(enable: Boolean): AdswizzAdRequest.Builder

withHttpProtocol

fun withHttpProtocol(httpProtocol: AdswizzAdRequest.HttpProtocol): AdswizzAdRequest.Builder

Set the http protocol. Default is "https". Possible values: "http", "https".

withNonceHandler

fun withNonceHandler(palNonceHandler: PalNonceHandlerInterface): AdswizzAdRequest.Builder

Set the programmatic access library nonce handler. Optional.

fun withReferrer(referrer: String?): AdswizzAdRequest.Builder

Set a referrer. Optional.

fun withServer(server: String): AdswizzAdRequest.Builder

Set the Adswizz ad server. This info is mandatory.

fun withShimZone(zone: AdswizzShimZone): AdswizzAdRequest.Builder

Set the shim zone in case request should fill the ad break with shim ads

fun withTagsArray(tagsArray: String?): AdswizzAdRequest.Builder

Set the tags used for requesting the ads. Optional.

withUserConsentV2

fun withUserConsentV2(userConsentV2: String?): AdswizzAdRequest.Builder

Set a TCFv2 string as described by IAB’s Transparency and Consent Framework (TCF).Optional

withVastVersion

fun withVastVersion(vastVersion: AdswizzAdRequest.VastVersion): AdswizzAdRequest.Builder

Set vast protocol version. Default is "4.0". Possible values: "4.0", "4.1".

fun withZoneAlias(zoneAlias: String?): AdswizzAdRequest.Builder

Set the zone alias referencing external zone. Optional.

fun withZones(zones: List<AdswizzAdZone>): AdswizzAdRequest.Builder

Set the zones on which the request will be made. Mandatory.