google.ima. CompanionAdSelectionSettings
CompanionAdSelectionSettings object is used to define the selection criteria when calling the ima.Ad.getCompanionAds function.
Constructor
CompanionAdSelectionSettings
new CompanionAdSelectionSettings()
- Implements
- google.ima.CompanionAdSelectionSettingsInterface
Enumerations
CreativeType
string
Available choices for creative type of a companion ad. The user can specify any of these choices as a criterion for selecting companion ads.
Value |
|
---|---|
IMAGE |
Specifies image creatives (such as JPEG, PNG, GIF, etc). |
FLASH |
Specifies Flash creatives. |
ALL |
Specifies all creative types. |
ResourceType
string
Available choices for resource type of a companion ad. The user can specify any of these choices as a criterion for selecting companion ads.
Value |
|
---|---|
HTML |
Specifies that the resource should be an HTML snippet. |
IFRAME |
Specifies that the resource should be a URL that should be used as the
source of an |
STATIC |
Specifies that the resource should be a static file (usually the URL of an image of SWF). |
ALL |
Specifies that the resource can be any type of resource. |
SizeCriteria
string
Available choices for size selection criteria. The user can specify any of these choices for selecting companion ads.
Value |
|
---|---|
IGNORE |
Specifies that size should be ignored when choosing companions. |
SELECT_EXACT_MATCH |
Specifies that only companions that match the size of the companion ad slot exactly should be chosen. |
SELECT_NEAR_MATCH |
Specifies that any companion close to the size of the companion ad slot should be chosen. |
SELECT_FLUID |
Specifies that only special size, 'fluid', companions should be chosen. |
Properties
adSlotIds
non-null Array of string
The companion ad slot ids to be used for matching set by the user.
creativeType
non-null CreativeType
Creative type setting set by the user.
nearMatchPercent
number
The near fit percent set by the user.
resourceType
non-null ResourceType
Resource type setting set by the user.
sizeCriteria
non-null SizeCriteria
Size criteria setting set by the user.
CreativeType
string
Available choices for creative type of a companion ad. The user can specify any of these choices as a criterion for selecting companion ads.
Value |
|
---|---|
IMAGE |
Specifies image creatives (such as JPEG, PNG, GIF, etc). |
FLASH |
Specifies Flash creatives. |
ALL |
Specifies all creative types. |
ResourceType
string
Available choices for resource type of a companion ad. The user can specify any of these choices as a criterion for selecting companion ads.
Value |
|
---|---|
HTML |
Specifies that the resource should be an HTML snippet. |
IFRAME |
Specifies that the resource should be a URL that should be used as the
source of an |
STATIC |
Specifies that the resource should be a static file (usually the URL of an image of SWF). |
ALL |
Specifies that the resource can be any type of resource. |
SizeCriteria
string
Available choices for size selection criteria. The user can specify any of these choices for selecting companion ads.
Value |
|
---|---|
IGNORE |
Specifies that size should be ignored when choosing companions. |
SELECT_EXACT_MATCH |
Specifies that only companions that match the size of the companion ad slot exactly should be chosen. |
SELECT_NEAR_MATCH |
Specifies that any companion close to the size of the companion ad slot should be chosen. |
SELECT_FLUID |
Specifies that only special size, 'fluid', companions should be chosen. |