Request Builder

The Request Builder helps you build Bid Requests for Banners, Videos, and Native Ads. Bid Requests are in the OpenRTB 2.6 format, so they can be someone verbose. The Request Builder helps you build these requests in a more concise way. For example, a simple request for a 2x1 banner looks like this:

const request = new RequestBuilder()
    .withBanner(2, 1)
    .build();

Other options will help you define information useful for targeting. For example, to add a custom user ID to the request:

const request = new RequestBuilder()
    .withBanner(2, 1)
    .withUser({
        id: 'my-custom-id'
    })
    .build();

Or to add device info to the request:

const request = new RequestBuilder()
    .withBanner(2, 1)
    .withDevice({
        geo: {
            lat: 37.53595575805609,
            lon: -77.47507461328786
        }
    })
    .build();

Video requests can similarly be built with some extra options

const request = new RequestBuilder()
    .withVideo(
        1, 1, // width, height
        0, 30 // min duration, max duration
    )
    .withDevice({
        ua: navigator.userAgent
    })
    .build();

Native requests use the OpenRTB Native 1.2 Specification, which requires another builder to create:

const request = new RequestBuilder() /* Use regular request builder to wrap bid request */
    .withNative(
        JSON.stringify( /* The details of native requests are JSON strings */
            new NativeRequestBuilder()
                .withTitle()
                .withPrice()
                .withDescription()
                .build()
        )
    )
    .build();