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 |
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: |
dynamicAdTag | integer | Specifies whether a dynamic ad tag is enabled, where: |
isMasterPlacement | integer | Specifies the placement, where: |
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 |