Macros

A banner is embedded on the page using an HTML snippet called a wrapper. The wrapper can include macros, which are textual placeholders that the RTB host replaces with actual values.

In the wrapper, a macro starts with a dollar sign followed by its name in curly braces. The example below shows the AUCTION_ID macro.

http://www.admaster.com/landing${AUCTION_ID}

RTB host macros

The RTB host replaces the following macros with its own values.

Macro

Value

AUCTION_ID

ID of the auction (the id from the RTB host's request).

AUCTION_IMP_ID

ID of the ad unit (the id of the Impression object in the RTB host's request).

AUCTION_BID_ID

ID of the auction bid (bidid from the DSP's response).

AUCTION_PRICE

The cost of an impression package. The DSP specifies the package currency in the cur parameter of its response.

AUCTION_PAGE_URL

URL of the page where the ad is served.

AUCTION_LOSS

Loss reason for the auction, which corresponds to the status described on the Loss reason notifications page.

AUCTION_CURRENCY

Currency used to specify the bid.

AUCTION_MINIMUM_BID_TO_WIN
AUCTION_MIN_TO_WIN
MIN_BID_TO_WIN

Bid that won the auction. Only supported for lurl.

Alert

The names of these macros are case-sensitive. The RTB host recognizes only uppercase names.

Auction ID assigned by the RTB host. The DSP returns this ID in its response.

ID of the ad unit on the HTML page.

The unique ID assigned to the bid within the DSP.

Currency used to specify the bid (price parameter). Supported options:

  • RUB: Russian ruble.
  • USD: US dollar.
  • EUR: Euro.
  • CHF: Swiss franc.
  • TRY: Turkish lira.
  • UAH: Ukrainian hryvnia.
  • KZT: Kazakhstani tenge.