Docs for native openRTB #3497
Docs for native openRTB #3497
Conversation
|
We should reflect these changes in the adunit-reference.md also. |
There was a problem hiding this comment.
Thank, but this doc approach isn't going to work. We can't delete the current way of doing things all at once because it's going to take time for bid adapters and publishers to conform to them.
I propose the following:
- have all of these changes be in a new doc. "The Shiny New ORTB-compatible Native" doc. Point back to the current doc. But this new doc is not very useful until all the bid adapters support the new format, right?
- The current doc gets a warning at the top suggesting that publishers watch the list of bid adapters and start using the new approach once the adapters they depend on for native support the new method.
- we should obsolete the really old docs at https://docs.prebid.org/dev-docs/show-native-ads.html. Remove the content in that file and point to the others.
I'll bring this up in the next PBJS meeting and will find someone to rewrite the docs.
@bretg, so should I close this PR or leave it? I already have enabled |
|
@FilipStamenkovic - we we discussed in today's PBJS meeting. Updated the code PR with the outcome. I'll take care of this doc PR. Appreciate your draft.
|
✅ Deploy Preview for prebid-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
Co-authored-by: Muki Seiler <[email protected]>
|
fixed conflicts caused by AdOps section updates |
|
|
||
| window.postRenderAd(bid) { | ||
| console.log('Native ad has been attached to the DOM'); | ||
| // again, the ortb is in bid.ortb |
prebid/native-implementation.md
Outdated
| The publisher doesn't need to implement anything for impression tracking to work, all that is needed is proper configuration of OpenRTB request on adUnit level. Prebid.js + Prebid Universal Creative will automatically take care of the impression tracking. | ||
|
|
||
| ### 6.2. Click Tracking | ||
| According to the OpenRTB spec, click trackers can be found in `link` objects. There is a 'master' `link` object for the entire native ad and also each asset in the response can have its own separate `link` object. |
There was a problem hiding this comment.
I'm all about linking stuff. "OpenRTB spec" is always a bit vague as there are so many.
In this case you are (probably) referencing the OpenRTB Native Ads 1.2 Spec 😉
| According to the OpenRTB spec, click trackers can be found in `link` objects. There is a 'master' `link` object for the entire native ad and also each asset in the response can have its own separate `link` object. | |
| According to the [OpenRTB spec](https://www.iab.com/wp-content/uploads/2018/03/OpenRTB-Native-Ads-Specification-Final-1.2.pdf], click trackers can be found in `link` objects. There is a 'master' `link` object for the entire native ad and also each asset in the response can have its own separate `link` object. |
prebid/native-implementation.md
Outdated
| By default, only the 'master' `link` URLs will be fired, but, the Prebid Universal Creative can also fire click tracking for specific assets. To enable this, publisher assigns a custom attribute to the associated DOM element. | ||
|
|
||
| ```html | ||
| <div class="pb-click" hb_native_asset_id = "5"> |
There was a problem hiding this comment.
| <div class="pb-click" hb_native_asset_id = "5"> | |
| <div class="pb-click" hb_native_asset_id="5"> |
prebid/native-implementation.md
Outdated
| To minimize needed work on the publisher side, we recommend using the [Prebid.js Viewability module](https://github.com/prebid/Prebid.js/blob/master/modules/viewability.md). | ||
|
|
||
| Enabling viewability tracking for native ads: | ||
| - Build your Prebid.js bundle with the `viewability` module |
There was a problem hiding this comment.
The viewability module is IIRC not part of prebid.js at this time
- Viewability Module: remove viewability module functionality Prebid.js#8945
- Update cross-frame interface for viewability messages Prebid.js#8928
You may link to the module page
| - Build your Prebid.js bundle with the `viewability` module | |
| - Build your Prebid.js bundle with the [viewability module](/dev-docs/modules/viewability) |
There was a problem hiding this comment.
This paragraph has been completely removed, because the viewability module has been removed too. This is because the module had a security issue and needs to be fixed; until it happens, it is better not to link it to discurage bad, unsecure practices.
|
Ok - thanks for the reviews. Merging. |
* more details about ortb native * added a section for bid adapters * move paragraph up * wordsmithing * added link to ortb spec Co-authored-by: Muki Seiler <[email protected]> * fixed link * Fix ad-unit-define creative link * fix native-implementation link * add clickUrlUnesc; add openrtb spec links * fixes Co-authored-by: Michele Nasti <[email protected]> Co-authored-by: bretg <[email protected]> Co-authored-by: Muki Seiler <[email protected]>
In this PR there are described changes how publisher can utilize native openRTB specification.
This PR is linked to: