Tier

Returns information about active placement tiers.

Response values

An array of objects is returned with the following information:

Parameter

Type

Description

tierID

integer

Provides the ID of the placement tier.

name

string

Provides the name of the placement tier.

status

string

Specifies the status of the placement tier, where:
A = active
D = deactivated or deleted
N = new

placementID

integer

Provides the ID of the placement.

userID

integer

Provides the user account that can access the information.

timeout

integer

Provides the timeout in milliseconds.

access

string

Provides whether the tier is public or private.

transparency

string

Specifies the tier transparency, where:
T = transparent
S = semi-transparent

rollupDomain

string

Provides the URL that is visible to DSPs.

adUnit

integer

Provides an ad unit ID. Only returned if the associated placement has dynamicAdTag set to 1.

accessOverride

array of integers

Provides any access override set to public for specific DSP IDs.

transparencyOverride

array of objects

Specifies any transparency overrides. Each array element contains the following parameters:
dspID (integer):** Returns the relevant DSP.
transparency (string): Returns the tier transparency, where:
T = transparent
S = semi-transparent
rollupDomain (string): This is only returned if the transparency parameter is set to S (semi-transparent). The string returns the URL that is visible to DSPs.

Language