Repository navigation
Insticator Bid Adapter: document audio and native media types, and correct the existing params - #4
Open
shubhamc-ins wants to merge 4 commits into
Open
shubhamc-ins wants to merge 4 commits into
shubhamc-ins wants to merge 4 commits into
Conversation
The adapter accepts audio, but the page listed only banner and video under media_types, so a publisher had no documented way to configure an audio ad unit. Add audio to media_types and an Audio parameters table covering the OpenRTB 2.6 Audio object (section 3.2.8) in spec order, following the style of the video table above it.
The video table was short of the ORTB 2.6 pod fields the adapter accepts, and of ext. Add podid, podseq, poddur, slotinpod, mincpmpersec, maxseq, rqddurs and ext. Four bid param entries named something the adapter does not read. yob and gender come from params.user, so a publisher following the table was setting a field nothing reads; they become user.yob and user.gender. instl and pos are not bid params at all and are dropped from that table. instl is read from ortb2Imp and is listed with the first party data alongside rwdd; pos already has its own rows in the banner and video tables. banner.ext had no row of its own though the adapter reads it, so the banner table gains one and is realigned to its header. fpd_supported is added to the front matter. The adapter reads first party data throughout and the body already carries the section describing which fields, which is what the flag requires. That list omitted site.mobile and said nothing about ext; each object's ext now sits in the list beside the object it belongs to. The section opened by pinning first party data support to release 8.45. The list now spans fields added well after that, so the qualifier is dropped rather than moved to a release this has not landed in. yob was typed as a string with a quoted example. The adapter forwards it untouched and the exchange requires an int64, so a publisher following the table got a 400 that dropped the whole bid request rather than the one field. The module documentation in the adapter repo already typed it as an integer; both now agree. params.user.keywords, params.user.data and params.user.ext were undocumented, and the first party data list omitted the ortb2Imp media type ext paths the adapter now reads in preference to mediaTypes.
Align every table so each pipe sits in the same column as its header (MD060 table-column-style, which the repo config leaves enabled and which infers the "aligned" style from the first table in the file), and promote the opening "Bid Params" heading to h2 so it increments by one from the front-matter title (MD001 heading-increment). Formatting only -- no table cell content changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Rebuilt on the current upstream master (
87783089) so the diff is exactly the documentation change and nothing else. Replaces #3, which sat on the fork's staleprebid/mastersnapshot.Documents the audio and native media types, and corrects documentation that no longer matches the adapter.
Both media types are documented together because
media_typesis a single front-matter line: documenting them separately would mean whichever landed second silently removed the other from the bidder feature matrix. It is nowmedia_types: banner, video, audio, native.Audio
New
Audio parameterstable and a worked ad unit, following the structure of the existing video section. Covers the full set the adapter accepts undermediaTypes.audioandparams.audio— mimes, durations, protocols, bitrates, delivery, the pod fields (poddur,podid,podseq,slotinpod,maxseq,mincpmpersec,rqddurs), companion ads, and the audio-specificfeed,stitched,nvolanddurfloors.Native
New
Native parameterstable and a worked ad unit requesting a title, main image, sponsored-by, description and CTA.Native is declared with the ORTB-style config on
mediaTypes.native.ortb, per the OpenRTB Dynamic Native Ads 1.2 specification. The section states that Prebid validates and normalizes that config before the adapter sends it, so a config Prebid rejects is not sent at all — worth being explicit about, since it determines whether a malformed ad unit fails loudly or silently.Documents
assets,ver,plcmttype,plcmtcnt,context,contextsubtype,eventtrackersandprivacy, plus theimp.native-levelapi,battrandextthe adapter forwards frommediaTypes.native.Corrections to the existing documentation
Independent of the two new media types, the page had drifted from the adapter:
fpd_supported: trueadded to the front matter. The adapter reads first party data from the standard Prebid locations; the page did not say so.yobandgenderwere documented at the top level ofparams, but the adapter reads them fromparams.user. They are nowuser.yobanduser.gender, with correct types —yobis an integer, previously documented as a string.user.keywords,user.dataanduser.extwere undocumented. Added, including their precedence:user.datais concatenated afterortb2.user.data, anduser.extis merged overortb2.user.ext.video.podidandvideo.extadded — both supported, neither documented.extadded to the banner table, andinstlandposmoved out of the general params table into the objects they apply to.