Namespace ImaSdkSettings

AI-generated Key Takeaways

• The documentation defines two key enumerations: CompanionBackfillMode and VpaidMode, both related to ad settings.

• CompanionBackfillMode controls whether companion ads are backfilled, offering options for ALWAYS backfilling or only ON_MASTER_AD when there are missing companion ads compared to slots.

• VpaidMode determines how VPAID ads are handled, with options for DISABLED, ENABLED using a cross-domain iframe, or INSECURE with a friendly iframe that provides the ad with access to the site.

• Client-side companion backfill requires specific Google Publisher Tag (GPT) setup, including enabling googletag.companionAds() and setting setRefreshUnfilledSlots(true).

Note: This reference page follows TypeScript documentation structure. If you have suggestions for or see issues with the reference documentation, open a thread with your feedback on the IMA technical forum.

---

Enumerations
CompanionBackfillMode	Defines a set of constants for the companion backfill setting.
VpaidMode	A set of constants for enabling VPAID functionality.

Enumerations

---

CompanionBackfillMode

CompanionBackfillMode

Defines a set of constants for the companion backfill setting. This setting indicates whether companions should be backfilled in various scenarios.

If the value is ALWAYS, companion backfill will be attempted in all situations, even when there is no main ad returned.

If the value is ON_MASTER_AD, companion backfill will be attempted if there is a main ad with fewer companions than there are companion slots. The missing companions will be backfilled.

The default value is ALWAYS.

Note that client-side companion backfill requires tagging your companions properly with a Google Publisher Tag (GPT). To enable backfill, the following changes to standard GPT setup are necessary:

 ... let slot1 = googletag.defineSlot('/1234/adunit', [300, 250], 'slot-div'); slot1.addService(googletag.companionAds()).addService(googletag.pubads()); ... googletag.companionAds().setRefreshUnfilledSlots(true); ... googletag.enableServices(); 

For autoplay videos, the following additional change is recommended to prevent companion slots from being preloaded and then immediately replaced with companions.

 googletag.pubads().disableInitialLoad(); ... googletag.enableServices(); 

Enumeration Members
ALWAYS
ON_MASTER_AD

---

VpaidMode

VpaidMode

A set of constants for enabling VPAID functionality.

Enumeration Members
DISABLED	VPAID ads will not play and an error will be returned.
ENABLED	VPAID ads are enabled using a cross domain iframe. The VPAID ad cannot access the site. VPAID ads that depend on friendly iframe access may error. This is the default.
INSECURE	VPAID ads are enabled using a friendly iframe. This allows the ad access to the site through JavaScript.