Request Bids
Request bids. When adUnits or adUnitCodes are not specified, request bids for all ad units added.
  • requestObj: object

    Object with parameters indicating which bid to request.

    Request Object Parameters
    Parameter Scope Type Description
    requestObj Optional Object
    requestObj.adUnitCodes Optional Object adUnit codes to request. Use this or requestObj.adUnits. Default to all adUnitCodes if empty.
    requestObj.adUnits Optional Array of objects AdUnitObjects to request. Use this or requestObj.adUnitCodes. Default to all adUnits if empty.
    requestObj.timeout Optional Integer Timeout, in milliseconds for requesting the bids specified.
    requestObj.bidsBackHandler Optional Function Callback to execute when all the bid responses are back or the timeout hits. Callback will be passed two parameters, the bids themselves and timedOut, which will be true if any bidders timed out.
    requestObj.labels Optional Array of strings Defines labels that may be matched on ad unit targeting conditions.
    requestObj.auctionId Optional String Defines an auction ID to be used rather than having the system generate one. This can be useful if there are multiple wrappers on a page and a single auction ID is desired to tie them together in analytics.
Response Description
{ response: example }
  • param1: string

    String indicating some value that has to be passed as a string type.

  • param2: number

    Number indicating some value that has to be passed as a number type.

    Note: This number should be between 0 and infinity.