# Class AdsLoader

*** ** * ** ***

AdsLoader allows clients to request ads from ad servers. To do so, users must register for the AdsManagerLoadedEvent event and then request ads.

| Constructors ||
|---|---|
| `https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/class/google.ima.AdsLoader#google.ima.AdsLoader.constructor` | Constructor. |

| Methods ||
|---|---|
| `https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/class/google.ima.AdsLoader#google.ima.AdsLoader.addEventListener` | Adds a listener for ads manager loaded events. |
| `https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/class/google.ima.AdsLoader#google.ima.AdsLoader.contentComplete` | Signals to the SDK that the content is finished. |
| `https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/class/google.ima.AdsLoader#google.ima.AdsLoader.destroy` | Cleans up the internal state. |
| `https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/class/google.ima.AdsLoader#google.ima.AdsLoader.getSettings` | Returns the IMA SDK settings instance. |
| `https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/class/google.ima.AdsLoader#google.ima.AdsLoader.getVersion` | Returns the version of the current SDK. |
| `https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/class/google.ima.AdsLoader#google.ima.AdsLoader.removeEventListener` | Removes a listener for ads manager loaded events. |
| `https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/class/google.ima.AdsLoader#google.ima.AdsLoader.requestAds` | Request ads from a server. |

## Constructors

*** ** * ** ***

### constructor

`new AdsLoader(container: https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/class/google.ima.AdDisplayContainer): https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/class/google.ima.AdsLoader` Constructor.

| Parameters ||
|---|---|
| `container: https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/class/google.ima.AdDisplayContainer` | The display container for ads. |

| Returns ||
|---|---|
| `https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/class/google.ima.AdsLoader` |   |

## Methods

*** ** * ** ***

### addEventListener

`addEventListener(type: https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/namespace/google.ima.AdsManagerLoadedEvent#google.ima.AdsManagerLoadedEvent.Type.ADS_MANAGER_LOADED, listener: ((event: https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.AdsManagerLoadedEvent) => void),
optCapture?: boolean,
optHandlerScope?: object): void` Adds a listener for ads manager loaded events.

| Parameters ||
|---|---|
| `type: https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/namespace/google.ima.AdsManagerLoadedEvent#google.ima.AdsManagerLoadedEvent.Type.ADS_MANAGER_LOADED` | The type of event to listen for. |
| `listener: ((event: https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.AdsManagerLoadedEvent) => void)` | A function called each time an event of this type occurs. |
| `` `Optional` optCapture: boolean `` | Deprecated and a no-op; retained for backward compatibility. |
| `` `Optional` optHandlerScope: object `` | Deprecated: Listener scope object. Use arrow functions or bind listener instead. |

`addEventListener(type: https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/namespace/google.https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/namespace/google.ima.https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/namespace/google.ima.AdEvent.https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/namespace/google.ima.AdEvent#google.ima.AdEvent.Type, listener: ((event: https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.AdEvent) => void),
optCapture?: boolean,
optHandlerScope?: object): void` Adds a listener for ad events.

| Parameters ||
|---|---|
| `type: https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/namespace/google.https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/namespace/google.ima.https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/namespace/google.ima.AdEvent.https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/namespace/google.ima.AdEvent#google.ima.AdEvent.Type` | The type of event to listen for. |
| `listener: ((event: https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.AdEvent) => void)` | A function called each time an event of this type occurs. |
| `` `Optional` optCapture: boolean `` | Deprecated and a no-op; retained for backward compatibility. |
| `` `Optional` optHandlerScope: object `` | Deprecated: Listener scope object. Use arrow functions or bind listener instead. |

`addEventListener(type: https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/namespace/google.ima.AdErrorEvent#google.ima.AdErrorEvent.Type.AD_ERROR, listener: ((event: https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.AdErrorEvent) => void),
optCapture?: boolean,
optHandlerScope?: object): void` Adds a listener for ad error events.

| Parameters ||
|---|---|
| `type: https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/namespace/google.ima.AdErrorEvent#google.ima.AdErrorEvent.Type.AD_ERROR` | The type of event to listen for. |
| `listener: ((event: https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.AdErrorEvent) => void)` | A function called each time an event of this type occurs. |
| `` `Optional` optCapture: boolean `` | Deprecated and a no-op; retained for backward compatibility. |
| `` `Optional` optHandlerScope: object `` | Deprecated: Listener scope object. Use arrow functions or bind listener instead. |

*** ** * ** ***

### contentComplete

`contentComplete(): void` Signals to the SDK that the content is finished. This will allow the SDK to play post-roll ads, if any are loaded through ad rules.

*** ** * ** ***

### destroy

`destroy(): void` Cleans up the internal state.

*** ** * ** ***

### getSettings

`getSettings(): https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.ImaSdkSettings` Returns the IMA SDK settings instance. To change the settings, just call the methods on the instance. The changes will apply for all the ad requests made with this ads loader.

| Returns ||
|---|---|
| `https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.ImaSdkSettings` | The settings instance. |

*** ** * ** ***

### getVersion

`getVersion(): string` Returns the version of the current SDK.

| Returns ||
|---|---|
| `string` |   |

*** ** * ** ***

### removeEventListener

`removeEventListener(type: https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/namespace/google.ima.AdsManagerLoadedEvent#google.ima.AdsManagerLoadedEvent.Type.ADS_MANAGER_LOADED, listener: ((event: https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.AdsManagerLoadedEvent) => void),
optCapture?: boolean,
optHandlerScope?: object): void` Removes a listener for ads manager loaded events. The listener must be equal by reference to the one previously passed to `addEventListener`.

| Parameters ||
|---|---|
| `type: https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/namespace/google.ima.AdsManagerLoadedEvent#google.ima.AdsManagerLoadedEvent.Type.ADS_MANAGER_LOADED` | The type of event for which to remove the listener. |
| `listener: ((event: https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.AdsManagerLoadedEvent) => void)` | The function to remove as a listener. |
| `` `Optional` optCapture: boolean `` | Deprecated and a no-op; retained for backward compatibility. |
| `` `Optional` optHandlerScope: object `` | Deprecated: Listener scope object. Use arrow functions or bind listener instead. |

`removeEventListener(type: https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/namespace/google.https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/namespace/google.ima.https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/namespace/google.ima.AdEvent.https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/namespace/google.ima.AdEvent#google.ima.AdEvent.Type, listener: ((event: https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.AdEvent) => void),
optCapture?: boolean,
optHandlerScope?: object): void` Removes a listener for ad events. The listener must be equal by reference to the one previously passed to `addEventListener`.

| Parameters ||
|---|---|
| `type: https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/namespace/google.https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/namespace/google.ima.https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/namespace/google.ima.AdEvent.https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/namespace/google.ima.AdEvent#google.ima.AdEvent.Type` | The type of event for which to remove the listener. |
| `listener: ((event: https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.AdEvent) => void)` | The function to remove as a listener. |
| `` `Optional` optCapture: boolean `` | Deprecated and a no-op; retained for backward compatibility. |
| `` `Optional` optHandlerScope: object `` | Deprecated: Listener scope object. Use arrow functions or bind listener instead. |

`removeEventListener(type: https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/namespace/google.ima.AdErrorEvent#google.ima.AdErrorEvent.Type.AD_ERROR, listener: ((event: https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.AdErrorEvent) => void),
optCapture?: boolean,
optHandlerScope?: object): void` Removes a listener for ad error events. The listener function must be equal by reference to the one previously passed to `addEventListener`.

| Parameters ||
|---|---|
| `type: https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/namespace/google.ima.AdErrorEvent#google.ima.AdErrorEvent.Type.AD_ERROR` | The type of event for which to remove the listener. |
| `listener: ((event: https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.AdErrorEvent) => void)` | The function to remove as a listener. |
| `` `Optional` optCapture: boolean `` | Deprecated and a no-op; retained for backward compatibility. |
| `` `Optional` optHandlerScope: object `` | Deprecated: Listener scope object. Use arrow functions or bind listener instead. |

*** ** * ** ***

### requestAds

`requestAds(adsRequest: https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/class/google.ima.AdsRequest, userRequestContext?: object): void` Request ads from a server.

| Parameters ||
|---|---|
| `adsRequest: https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/class/google.ima.AdsRequest` | AdsRequest instance containing data for the ads request. |
| `` `Optional` userRequestContext: object `` | User-provided object that is associated with the ads request. It can be retrieved when the ads are loaded. |