Placement

Returns information about active placements, such as name, status, percent and priority.

Response values

An array of objects is returned with the following properties:

Parameter

Type

Description

placementID

integer

Provides the ID of the placement.

userid

integer

Provides the ID of the user associated with the placement.

name

string

Provides the name of the placement.

status

string

Provides the status of the placement, which can only be A (active).

percent

integer

Provides the percent of coverage the placement has.

entireSite

integer

Specifies a binary that returns whether the main domain must be matched (partially or in full) for the advertisement to serve, where:
0 = a full or partial URL match is required
1 = a URL match is not required

dynamicAdTag

integer

Specifies whether a dynamic ad tag is enabled, where:
1 = enabled
0 = not enabled

isMasterPlacement

integer

Specifies the placement, where:
0 = parent placement
1 = master placement

priority

integer

Provides the priority of the placement in the hierarchy of placements.

siteID

array of integers

Provides an array that displays sites associated with the placement.

frequencyRestrictions

array of integers

Provides any frequency restrictions by ID.

audienceRestrictions

array of integers

Provides any audience restrictions by ID.

countryRestrictions

array of integers

Provides any country restrictions by ID.

adUnitRestrictions

array of integers

Provides any ad unit restrictions by ID.

matches

array of objects

Specifies an array of match objects. The array should contain one or more values if the entireSite parameter is set to 0. Each object contains a URL and match type. The matchType parameter specifies the match type, where:
1 = full match type
2 = partial match type

Language