Builder

The analytics custom data used for analytics events

The companion zone id

The additional custom parameters

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

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

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

The programmatic access library nonce handler

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

The server url

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

The tags used for requesting the ads. Optional

The TCFv2 string from Transparency and Consent Framework

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

The zone alias referencing external zone

The zone on which the request will be made

Builds an AdswizzAdRequest object.
return a valid AdswizzAdRequest object
throws SDKError: a missing zone id error if it was not provided or a missing server address

Prints current Builder values

Set custom analytics data used for analytics events. Optional.
analyticsCustomData: custom parameters to add to AnalyticsEvent
return same builder object

Set a companion zone aliases list. Optional.
companionZoneAliases: List containing companion zones aliases
return same builder object

Set a companion zone ids list. Optional.
companionZoneIds: List containing companion zones ids
return same builder object

Set the companion zone id. Optional.
companionZones: companionZones description
return same builder object

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.
customParam: custom parameters with a suggested format of key1=value1&key2=value2
return same builder object

Set maximum total duration of ads to be selected (AdBreak duration) in milliseconds. Optional
duration: Long
return same builder object

Set the http protocol. Default is "https". Possible values: "http", "https".
httpProtocol: http or https
return same builder object

Set the programmatic access library nonce handler. Optional.
palNonceHandler: object that is a mirror of pal sdk's NonceManager
return same builder object

Set a referrer. Optional.
referrer: referrer description
return same builder object

Set the Adswizz ad server. This info is mandatory.
server: Adswizz server
return same builder object

Set the shim zone in case request should fill the ad break with shim ads
zone: The AdswizzShimZone to be used by request
return same builder object

Set the tags used for requesting the ads. Optional.
tagsArray: string with tags separated by comma
return same builder object

Set a TCFv2 string as described by IAB’s Transparency and Consent Framework (TCF).Optional
userConsentV2: tcfv2 string
return same builder object

Set vast protocol version. Default is "4.0". Possible values: "4.0", "4.1".
vastVersion: as described above
return same builder object

Set the zone alias referencing external zone. Optional.
zoneAlias: zoneAlias description< /br>return same builder object

Set the zones on which the request will be made. Mandatory.
zones: List of AdswizzAdZone. The set should contain at least one element
return same builder object