Skip to content

[DRAFT] Unified BidRequest API #1206

Description

@YuriyVelichkoPI

Motivation

Implement the single approach of bid request configuration for all kinds of Prebid SDK APIs.

Background

Currently, the Prebid SDK supports distinct APIs for different kinds of integration

  • Bidding Only (or Original API)
  • Rendering API
  • Mediation API (used in adapters for AdMob and MAX)

In the scope of these APIs Probid SDK provides numerous classes to implement respecting ad format integration

  • Banner
  • Video
  • Native
  • Interstitial
  • Rewarded
  • Multiformat
  • ... with subcategories.

The classes implementing these formats encapsulate the logic of creating the respective bid requests, which makes them less customizable and leads to code duplication, when we need to support a request feature.

To avoid it and have the ability to implement other features, like:

  • support multiple hosts
  • multiimpression requests

The SDK should use the common approach for configuring the bid requests among all APIs. It will make the SDK more flexible for changes and more cohesive in integration.

Specification

The core design of the new approach was introduced in the scope of Multiformat ad unit for Original API.

In the current scope, it should be adopted for all integration APIs, and the current API should be deprecated to force publishers to adopt the new one. Release 4.0 can totally remove redundant classes.

The following diagram is in draft mode and still in progress. It is here to collect the feedback on the earlier design stage. Please comment anytime.

Image

Objectives

// TODO: Create subtasks once the specification is ready and approved for implementation.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Status
    Clarify Request

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions