Class CompanionAdSelectionSettings

AI-generated Key Takeaways

• The CompanionAdSelectionSettings object defines the criteria for selecting companion ads using the google.ima.Ad.getCompanionAds function.

• This object inherits properties for defining selection criteria from the CompanionAdSelectionSettingsInterface.

• Key properties include adSlotIds, creativeType, nearMatchPercent, resourceType, and sizeCriteria.

• A new CompanionAdSelectionSettings object is created using its constructor.

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.

---

Extends CompanionAdSelectionSettingsInterface

CompanionAdSelectionSettings object is used to define the selection criteria when calling the google.ima.Ad.getCompanionAds function.

Constructors
constructor	Constructor.

Properties
adSlotIds	The companion ad slot ids to be used for matching set by the user. Inherited from CompanionAdSelectionSettingsInterface.adSlotIds
creativeType	Creative type setting set by the user. Inherited from CompanionAdSelectionSettingsInterface.creativeType
nearMatchPercent	The near fit percent set by the user. Inherited from CompanionAdSelectionSettingsInterface.nearMatchPercent
resourceType	Resource type setting set by the user. Inherited from CompanionAdSelectionSettingsInterface.resourceType
sizeCriteria	Size criteria setting set by the user. Inherited from CompanionAdSelectionSettingsInterface.sizeCriteria

Constructors

---

constructor

new CompanionAdSelectionSettings(): CompanionAdSelectionSettings

Constructor.

Returns
CompanionAdSelectionSettings

Properties

---

adSlotIds

adSlotIds: string[]

The companion ad slot ids to be used for matching set by the user.

---

creativeType

creativeType: string

Creative type setting set by the user.

---

nearMatchPercent

nearMatchPercent: number

The near fit percent set by the user.

---

resourceType

resourceType: string

Resource type setting set by the user.

---

sizeCriteria

sizeCriteria: string

Size criteria setting set by the user.