Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add some missing deprecations for 1.0 #383

Merged
merged 2 commits into from
Sep 28, 2017
Merged

Add some missing deprecations for 1.0 #383

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
915218c
Add some missing deprecations
Sep 28, 2017
906f49d
Added pbjs.timeoutBuffer
Sep 28, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions dev-docs/prebid-1.0-API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,23 @@ This document describes the changes to the Publisher API for version 1.0.
* TOC
{:toc}

## Deprecations
The following functions/variables are removed as part of 1.0.

- All `pbjs._*` varaibles will be depracated as part of 1.0. This includes the following
- `pbjs._winningBids`
- `pbjs._bidsReceived`
- `pbjs._bidsRequested`
- `pbjs._adUnitCodes`
- `pbjs._adsReceived`
- `pbjs.cbTimeout`
- `pbjs.addCallback` & `pbjs.removeCallback` in favor of [onEvent API](http://prebid.org/dev-docs/publisher-api-reference.html#module_pbjs.onEvent).
- `pbjs.allBidsAvailable`
- `pbjs.buildMasterVideoTagFromAdserverTag` in favor of `pbjs.adServers.dfp.buildVideoUrl`
- `adUnit.sizeMapping` - see below for [details on sizeConfig]({{site.baseurl}}/dev-docs/prebid-1.0-API.html#size-mapping-changes)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

$$PREBID_GLOBAL$$.bidderTimeout - Moved to config

prebid/Prebid.js#1633 PR is not merged but it removes
$$PREBID_GLOBAL$$._adsReceived (You already added that)
$$PREBID_GLOBAL$$.timeoutBuffer - Moved to config
$$PREBID_GLOBAL$$.logging - Moved to config
$$PREBID_GLOBAL$$.publisherDomain - Moved to config
$$PREBID_GLOBAL$$.setBidderSequence - Moved to config
$$PREBID_GLOBAL$$.setS2SConfig - Moved to config

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jaiminpanchal27 what is $$PREBID_GLOBAL$$.bidderTimeout used for? Shouldn't this just be set in requestBids?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added pbjs.timeoutBuffer but the rest are covered in the pbjs.setConfig section below this.

Other methods are removed as part of the `setConfig` API - see below `pbjs.setConfig` for details.

## New API - `pbjs.setConfig`

For 1.0, we're **deprecating** the following APIs in favor of a generic "options" param object passed to the [`pbjs.setConfig`]({{site.baseurl}}/dev-docs/publisher-api-reference.html#module_pbjs.setConfig) method:
Expand All @@ -29,6 +46,7 @@ For 1.0, we're **deprecating** the following APIs in favor of a generic "options
- `pbjs.enableSendAllBids` (* [2](#options-footnotes))
- `pbjs.setBidderSequence`
- `pbjs.setS2SConfig`
- `pbjs.timeoutBuffer`

Mapping will be straightforward with the name of the param being the same, except dropping the `set` prefix where appropriate.

Expand Down