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

Interface CompanionAd

AI-generated Key Takeaways

This documentation details the CompanionAd interface, which represents a companion ad in the Interactive Media Ads SDK.
The CompanionAd interface offers methods to retrieve information about a companion ad, including its ad slot ID, HTML content, and content type.
You can determine the dimensions of the companion ad using the getHeight and getWidth methods, both returning values in pixels.
The getAdSlotId function returns the corresponding id for the companion ad, which can be a string or null.
The getContent function returns the HTML content of the ad, and the getContentType function returns the content type, which can also be null.

Represents a companion ad.

Methods
`getAdSlotId`	Returns the ad slot id for this companion.
`getContent`	Returns the HTML content for the companion ad that can be added to the publisher page.
`getContentType`	Returns the content type of the Companion Ad.
`getHeight`	Returns the height of the companion in pixels.
`getWidth`	Returns the width of the companion in pixels.

getAdSlotId(): string

Returns the ad slot id for this companion.

Returns
`string`	The ad slot id for this companion.

getContent(): string

Returns the HTML content for the companion ad that can be added to the publisher page.

Returns
`string`	The HTML content.

getContentType(): string

Returns the content type of the Companion Ad.

Returns
`string`	The content type of the Companion Ad. This may return null if the content type is not known (such as in the case of a VAST HTMLResource or IFrameResource).

getHeight(): number

Returns the height of the companion in pixels.

Returns
`number`	The height of the companion in pixels.

getWidth(): number

Returns the width of the companion in pixels.

Returns
`number`	The width of the companion in pixels.