Item Placement¶

The item.spec.placement object defines the details of the items on offer, this includes mechanical information such as sizes, supported mime types and other rendering options, along with placement and positioning details, and any restrictions which may also apply such as blocked advertiser domains or content categories.

Placement Object Properties¶
Value	Type	Description
tagid	string	Identifier for specific ad placement or ad tag; unique within a distribution channel.
sdk	string	Name of ad mediation partner, SDK technology, or player responsible for rendering the ad (typically video, audio, or mobile); used by some ad servers to customize ad code by partner.
sdkver	string	Version of the SDK specified in the `"sdk"` field.
reward	int	Indicates if this is a rewarded placement, where `0` = no, `1` = yes.
secure	int	Indicates if this is a rewarded placement, where `0` = no, `1` = yes.
admx	int	Indicates if including markup in the response is supported, i.e., the `adm` attribute in the applicable response object, where `0` = no, `1` = yes.
curlx	int	Indicates if retrieving markup via a URL reference is supported, i.e., the various `curl` attributes in the applicable response object, where `0` = no, `1` = yes.
display*	object	(Required) Defines a display placement and provides additional details related to it, see Display Placement
video*	object	(Required) Defines a video placement and provides additional details related to it, see Video Placement
audio*	object	(Required) Defines an audio placement and provides additional details related to it, see Audio Placement

Note

At least one of the fields marked with an asterisk (*) is required to be present.

Placement JSON Example¶

{
    "placement":{
        "tagid":"plc-ftr-123abc",
        "secure":1,
        "reward":1,
        "admx":1,
        "curlx":1,
        "display":{
            "ctype":[
                2,
                3
            ],
            "ampren":0,
            "instl":0,
            "displayfmt":[
                {
                    "w":320,
                    "h":50
                },
                {
                    "w":320,
                    "h":250
                }
            ],
            "event":[
                {
                    "type":1,
                    "method":[
                        1,
                        2
                    ]
                }
            ]
        }
    }
}