Support collecting arbitrary ORTB parameters

[bretg]

Describe the solution you'd like

Adding Arbitrary ORTB Request Fields

We're building a separate GPID feature in issue #925, but it would be great to be able to pass arbitrary ORTB fields into the request. The SDK could support flexible ORTB entry. e.g.

   addOrtbGlobal('{"ext":{"prebid":{"debug":1,"trace":"verbose"}}}');
   adUnit = BannerAdUnit(configId: CONFIG_ID, size: adSize, ORTB_OBJECT)

Where ORTB_OBJECT is an imp-specific block of JSON that can get merged into the PBS request under that imp object as a last step. e.g. in the case of GPID, it would be {ext: {gpid: "blah"}}

We have to decide the merge precedence for when a JSON block is supplied by both the API and the generic interface. Based on PBS experience, I would suggest something simple like:

• Shallow merge: stop at the first array
• API-specified fields take precedence

Additional context

Prebid.js has supported accepting arbitrary ORTB for a year now and it's worked quite well to handle new use cases.

[bretg]

Expanded the request to add the response side of the ORTB.

[bretg]

After discussion, this has been broken into separate issue

• This issue tracks the general ORTB request portion
• The GPID part is spun out to Support impression-level GPID parameter #925
• The win event URL is spun out to Surface win URL via SDK #926
• The arbitrary ORTB response part of the feature is spun out to Receive Arbitrary ORTB Response Fields #927

[jsligh]

@bretg It looks like under the ext there is prebid/dlp, skadn, data, keywords, and GPID. Does the object with the arbitrary fields only need to go through if these don't exist or how does it need to go through in the json with things like GPID?

[bretg]

Not sure I understand the question so let me give a pseudo-code example:

   adUnit = BannerAdUnit(configId: "my-stored-request", size: adSize, "{instl:1, ext:{ gpid: "222", data: { foo: "bar" }})

What should get sent in the Prebid Server imp object is:

{
   "imp":[{
      "banner" {
          ... existing logic to write out the sizes ...
      },
      "instl":1,
      "ext": {
        "gpid": "222",
        "data": {
          "foo": "bar"
        },
        "prebid": {
          "storedrequest": {
            "id": "my-stored-request"
          }
        }
      }
   }]
}

[jsligh]

Not sure I understand the question so let me give a pseudo-code example:

   adUnit = BannerAdUnit(configId: "my-stored-request", size: adSize, "{instl:1, ext:{ gpid: "222", data: { foo: "bar" }})

What should get sent in the Prebid Server imp object is:

{
   "imp":[{
      "banner" {
          ... existing logic to write out the sizes ...
      },
      "instl":1,
      "ext": {
        "gpid": "222",
        "data": {
          "foo": "bar"
        },
        "prebid": {
          "storedrequest": {
            "id": "my-stored-request"
          }
        }
      }
   }]
}

Ah okay, so it just needs to be added under the "data" section in "ext". That answers my question, thanks!

[bretg]

What I'm saying is that the object supplied on BannerAdUnit needs to be merged at the imp level.

• Some of the fields there go directly under imp
• Others are sub-objects

Does the object with the arbitrary fields only need to go through if these don't exist

Really anything under "ext" is arbitrary and might change over time. The code that does the merging should be simple and not assume or validate anything other than valid JSON.

[bretg]

@jsligh - was there a docs PR opened?

[jsligh]

@bretg There’s about to be. The Android PR hasn’t been pushed and there hasn’t been a new build with this in it yet.

…

On Mon, Mar 11, 2024 at 8:41 AM bretg ***@***.***> wrote: @jsligh <https://github.com/jsligh> - was there a docs PR opened? — Reply to this email directly, view it on GitHub <#877 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/BBFUGSOC7235PALEKCRWYHLYXW7A3AVCNFSM6AAAAAA2FB4JD6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSOBYGQ3TAMBRGY> . You are receiving this because you were mentioned.Message ID: ***@***.***>