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

StorytellerGamVastModule

@Singleton
class StorytellerGamVastModule : StorytellerModule

Storyteller GAM VAST Module - Google Ad Manager VAST tag setup for Storyteller VAST ads.

The module builds GAM VAST tag URLs from host callbacks, then delegates loading, parsing, tracking, wrapper resolution, media selection, and playback payload mapping to the same VAST pipeline used by StorytellerVastModule. It does not integrate the Google IMA SDK.

SDK-owned GAM defaults are added before host overrides. customParams are serialized into GAM cust_params. tagParameters are merged last as top-level GAM tag parameters so host apps can override SDK-provided defaults.

See also

StorytellerModule

Types

Link copied to clipboard
object Companion

Factory for StorytellerGamVastModule instances.

Properties

Link copied to clipboard
open override val googleAdSource: StorytellerGoogleAdSource? = null

GAM VAST uses GAM tag URLs but is not backed by Google Mobile Ads or IMA.

Functions

Link copied to clipboard
fun diagnostics(): SharedFlow<VastObservabilityEvent>

Live stream of diagnostics events emitted by this module's shared VAST pipeline.

Link copied to clipboard
open override fun getAd(adContext: AdContext, adRequestInfo: StorytellerAdRequestInfo, onComplete: (StorytellerAd) -> Unit, onAdFallbackRequest: (StorytellerAdLoadError) -> Unit, onError: (StorytellerAdLoadError) -> Unit)

Legacy SDK module entry point without slot context.

open override fun getAd(adContext: AdContext, slot: AdSlot, adRequestInfo: StorytellerAdRequestInfo, onComplete: (StorytellerAd) -> Unit, onAdFallbackRequest: (StorytellerAdLoadError) -> Unit, onError: (StorytellerAdLoadError) -> Unit)

Loads a GAM VAST-backed StorytellerAd for the supplied slot.

Link copied to clipboard
open override fun getBottomBannerAd(adContext: AdContext, adRequestInfo: StorytellerAdRequestInfo, onComplete: (StorytellerAd) -> Unit, onError: (StorytellerAdLoadError) -> Unit)

Bottom banner ads are not part of the VAST protocol surface. Always fails the request so the SDK fallback chain can try the next module.

Link copied to clipboard
fun init(adUnit: (StorytellerAdRequestInfo) -> String, descriptionUrl: (StorytellerAdRequestInfo) -> String, contentUrl: (StorytellerAdRequestInfo) -> String? = { null }, customParams: (StorytellerAdRequestInfo) -> Map<String, String> = { emptyMap() }, tagParameters: (StorytellerAdRequestInfo) -> Map<String, String> = { emptyMap() })

Configures the GAM VAST module. Must be called before the module is registered with com.storyteller.Storyteller.modules.

Link copied to clipboard
open override fun onUserActivityOccurred(type: StorytellerUserActivity.EventType, data: UserActivityData)

GAM VAST modules do not consume SDK user-activity events.