Defines parameters for an ad placement. Note that no more than 12 placements should be specified per page. Returns a
object that can be used later after defining.
|number||The member ID for the placement (overrides global setting from |
The placement code for this placement.
|number||The placement ID for the placement|
|array of numbers|
One or more placement sizes in the format
If more than one size is specified, the first is the placement size and the rest are promo sizes.
Only 1 of
|array of objects|
Specifies a set of sizes based on a minimum viewport size. This allows a seller to set which sizes should be used based on the size of the viewport. If the viewport size is smaller than the smallest
Each object in the array contains two parameters :
Only 1 of
The unique identifier of a specific ad slot, created by the publisher/seller. Corresponds to a
Specifies the ID of a creative that should be forced to appear in this placement. Forcing a creative allows you to preview an ad on a site, perform testing or certification, and create tear sheets.
Creatives can also be forced in the query string of the website URL in the format
You may choose one of the following options for the
The querystring parameters listed above will override any value specified in the
Indicates whether smaller ad sizes than defined on
|array of strings||Indicates the desired formats. Options include |
|object||Specifies one or more options that can be passed into the renderer for custom rendering.|
|string||Identify the placement as above or below the fold. Possible values: |
|Boolean||Indicates whether this placement should disable PSAs from being shown.|
Indicates that a blank ad should be returned if the placement is not sold rather than a default ad or PSA.
A set of key/value pairs applicable to this placement. Querystring segments are defined by key/value pairs in this object. Keywords that contain hyphens must be surrounded by single quote marks. Best practice is to always enclose keywords in single quotes. A maximum of 100 key/value pairs can be defined per tag.
|string||Specifies the third-party source of this impression.|
This is deprecated in favor of enableSafeFrame
Indicates whether the ad creative should be loaded into a cross-domain iframe. This will prevent data leakage and does not allow the creative to access the parent page directly.
|array of numbers|
COMING SOON! The additional sizes that allowed to serve only for custom deals or packages (when private sizes are allowed by the deal or package). In the format
|string||Indicate the type of supply for this placement. Possible values are |
Specifies a publisher-supplied URL for third-party click tracking. This is just a placeholder into which the publisher can insert their own click tracker. This parameter should be used for an unencoded tracker. This parameter is expected to be the last parameter in the URL. Please note that the click tracker placed in this parameter will only fire if the creative winning the auction is using AppNexus click tracking properly.
Specifies the reserve price for this inventory. This parameter will override a preset price and will set both the hard floor AND soft floor if Yield Management is not being used.
Price is assumed to be in the publisher's currency.
Note: This option is not available from the UI and must be appended to the placement tag manually.
Specifies predefined value passed on the query string that can be used in reporting. The value must be entered into the system before it is logged. For more information, see External Inventory Code Service.
This is optional. You do not need to specify this in
A native ad is a collection of individual assets. These could be a title, a description, or an image, for example.
Any field in the
Possible Native Assets:
The format for this is:
Specifies the unique identifier of an externally generated auction.
Specifies whether this placement will be served in a SafeFrame container. Here is more information on the SafeFrame API Reference .
Allows configuration of SafeFrame, a managed iframe that provides additional consumer protection and publisher control beyond that provided by a standard iframe. Here is more information on the SafeFrame API Reference .
This initializes the ad iframe at zero size. The only option for the
|Boolean||Flag that indicates the tag being requested is for a headerbidding or prebid auction. This will return the cpm on the adObj `adObj.cpm`, however, the ad will not be renderered. It is assumed that another ad server will render the ad if this bid wins.|
Flag that indicates whether payment rules should be applied to a bid before sending the bid to the ad server.
Default is false.