To discuss and provide feedback on our products, join the official Ad Manager Discord channel in the Google Advertising and Measurement Community server.

Namespace ima

AI-generated Key Takeaways

The google.ima namespace provides access to the SDK's classes, interfaces, enumerations, and properties.
The documentation includes references for namespaces, enumerations, classes, interfaces, and variables within the SDK.
Enumerations like OmidAccessMode, OmidVerificationVendor, and UiElements control various SDK behaviors and settings.
The settings variable holds the SDK-wide configuration in an ImaSdkSettings object.

The google.ima namespace provides access to the SDK's classes, interfaces, enumerations, and properties.

Namespaces
`AdCuePoints`
`AdError`
`AdErrorEvent`	Types of AdErrorEvents.
`AdEvent`
`AdsManagerLoadedEvent`
`CompanionAdSelectionSettings`
`ImaSdkSettings`
`secureSignals`	Utility functions for Secure Signals.

Enumerations
`OmidAccessMode`	Available access modes for OMID for Web, which control how much the verification script can access.
`OmidVerificationVendor`	Identifies an OMID verification vendor.
`UiElements`	Enum specifying different UI elements that can be configured to be displayed or hidden.

Classes
`AdDisplayContainer`	This class represents a container for displaying ads.
`AdsLoader`	AdsLoader allows clients to request ads from ad servers.
`AdsRenderingSettings`	Defines parameters that control the rendering of ads.
`AdsRequest`	A class for specifying properties of the ad request.
`CompanionAdSelectionSettings`	CompanionAdSelectionSettings object is used to define the selection criteria when calling the `google.ima.Ad.getCompanionAds` function.

Interfaces
`Ad`	An ad class that's extended by classes representing different ad types.
`AdCuePoints`	The cue point list represents a time-schedule of ad breaks.
`AdError`	AdError surfaces information to the user about whether a failure occurred during ad loading or playing.
`AdErrorEvent`	This event is raised when an error occurs when loading an ad from the Google or DoubleClick servers.
`AdEvent`	This event type is raised by the ad as a notification when the ad state changes and when users interact with the ad.
`AdPodInfo`	An ad may be part of a pod of ads.
`AdProgressData`	This object exposes information about the current progress as an ad is playing.
`AdsManager`	Provides the outer public API to the publisher and communicates with the inner instance of ads manager.
`AdsManagerLoadedEvent`	This event is raised when ads are successfully loaded from the Google or DoubleClick ad servers through an AdsLoader.
`AdsRenderingSettingsInterface`
`AdsRequestInterface`
`CompanionAd`	Represents a companion ad.
`CompanionAdSelectionSettingsInterface`
`ImaEvent`	An event raised by the IMA SDK.
`ImaSdkSettings`	This class contains SDK-wide settings.
`UniversalAdIdInfo`	This object exposes information about the universal ad ID associated with the creative, including the ad ID value and the ad ID registry.

Variables
`settings`	Object holding the SDK-wide settings.

OmidAccessMode

Available access modes for OMID for Web, which control how much the verification script can access.

Enumeration Members
`DOMAIN`	Deprecated. No longer supported. Access mode rules selecting DOMAIN are ignored and default to LIMITED.
`FULL`	The verification script has direct access to the creative and the publisher page.
`LIMITED`	The verification script is sandboxed and cannot access the creative or publisher page, and cannot directly confirm what publisher domain it is on.

OmidVerificationVendor

Identifies an OMID verification vendor. Vendors are listed in alphabetical order.

Enumeration Members
`COMSCORE`
`DOUBLEVERIFY`
`GOOGLE`
`INTEGRAL_AD_SCIENCE`
`MEETRICS`
`MOAT`
`NIELSEN`
`OTHER`	The default vendor to use when the script URL doesn't match any other vendor.
`PIXELATE`

UiElements

Enum specifying different UI elements that can be configured to be displayed or hidden. These settings may be ignored for AdSense and ADX ads.

Enumeration Members
`AD_ATTRIBUTION`	Displays the "Ad" text in the ad UI. Must be present to show the countdown timer.
`COUNTDOWN`	Ad attribution is required for a countdown timer to be displayed. Both `google.ima.UiElements.COUNTDOWN` and `google.ima.UiElements.AD_ATTRIBUTION` must be present in `AdsRenderingSettings.uiElements`.

settings:
                ImaSdkSettings

Object holding the SDK-wide settings.