Storyteller VAST Module Documentation/com.storyteller.modules.vast/UrlFormat

UrlFormat

enum UrlFormat : Enum<UrlFormat>

Controls how requestParameters are serialised into the final VAST request URL.

PathSegment — $baseUrl/k1=v1/k2=v2/... for VAST servers that encode request parameters as path segments.
QueryString — $baseUrl?k1=v1&k2=v2&... (most other IAB-compliant servers: GAM, FreeWheel, SpotX, Magnite, etc.).

Selected per StorytellerVastModule.init call. Default is PathSegment.

Entries

PathSegment

$baseUrl/k1=v1/k2=v2/... path-segment serialisation.

QueryString

$baseUrl?k1=v1&k2=v2&... — IAB-standard query-string format.

Properties

entries

val entries: EnumEntries<UrlFormat>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

ordinal

val ordinal: Int

Functions

valueOf

fun valueOf(value: String): UrlFormat

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<UrlFormat>

Returns an array containing the constants of this enum type, in the order they're declared.