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

Default Endpoints, minor revisions #477

Merged
merged 2 commits into from
Dec 14, 2017
Merged

Default Endpoints, minor revisions #477

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4e96a7b
Default Endpoints, minor revisions
bretg Dec 6, 2017
32ea379
Update prebid-1.0-API.md
bretg Dec 12, 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
63 changes: 38 additions & 25 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 @@ -40,21 +40,17 @@ For a complete list of methods that will be removed, see the [Publisher API Refe

<a name="pbjs.setConfig" />

## New API - `pbjs.setConfig`
## Legacy APIs replaced by `pbjs.setConfig`

For 1.0, the following APIs will be removed in favor of a generic "options" param object passed to [`pbjs.setConfig`]({{site.baseurl}}/dev-docs/publisher-api-reference.html#module_pbjs.setConfig):

- `pbjs.bidderTimeout`
- `pbjs.logging` (renamed to `debug`)
- `pbjs.publisherDomain`
- `pbjs.cookieSyncDelay`
- `pbjs.setPriceGranularity`
- `pbjs.enableSendAllBids` (behavior will default to `true`)
- `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.
- `pbjs.bidderTimeout` - use `pbjs.setConfig({bidderTimeout})` instead
- `pbjs.logging` - use `pbjs.setConfig({debug})` instead
- `pbjs.publisherDomain` - use `pbjs.setConfig({publisherDomain})` instead
- `pbjs.setPriceGranularity` - use `pbjs.setConfig({priceGranularity})` instead
- `pbjs.enableSendAllBids`- use `pbjs.setConfig({enableSendAllBids})` instead. Now defaults to `true`.
- `pbjs.setBidderSequence` - use `pbjs.setConfig({bidderSequence})` instead
- `pbjs.setS2SConfig` - use `pbjs.setConfig({s2sConfig})` instead

### `pbjs.setConfig` Example
{:.no_toc}
Expand All @@ -65,21 +61,38 @@ The input to `pbjs.setConfig` must be JSON (no JavaScript functions are allowed)
{% highlight js %}

pbjs.setConfig({
"currency": {
// Enables currency feature -- loads the rate file
currency: {
"adServerCurrency": "JPY",
// Allows the publisher to override the default rate file
"conversionRateFile": "url"
"conversionRateFile": "<url>"
},
"debug": true, // Previously `logging`
"s2sConfig": { ... },
"priceGranularity": "medium",
"enableSendAllBids": false, // Default will be `true` as of 1.0
"bidderSequence": "random",
"bidderTimeout": 700, // Default for all requests.
"publisherDomain": "abc.com", // Used for SafeFrame creative.
"pageOptions": { ... },
"sizeConfig": { ... }
debug: true, // Previously `logging`
s2sConfig: { ... },
priceGranularit": "medium",
Copy link
Contributor

Choose a reason for hiding this comment

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

typo.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed

enableSendAllBids: false, // Default will be `true` as of 1.0
bidderSequence: "random", // Default is random
bidderTimeout: 700, // Default for all requests.
publisherDomain: "abc.com", // Used for SafeFrame creative.
pageOptions: { ... },
sizeConfig: { ... },
cache: {url: "<prebid cache url>"}
});

{% endhighlight %}

## No More Default Endpoints
Copy link
Contributor

Choose a reason for hiding this comment

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

Does this mean the following no longer works as of the 1.0 release?

pbjs.setConfig({
        usePrebidCache: true
});

If so there are a lot of video docs that need updating as a result of this change. Looks like this is a result of prebid/Prebid.js#1904 yes?

Copy link
Contributor

Choose a reason for hiding this comment

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

Captured in #482

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Right - now it would to be:

pbjs.setConfig({
        usePrebidCache: true,
        cache: {url: ""}
});


In Prebid 0.x there were defaults for the Prebid Server endpoints and the video cache URL. With 1.0, these defaults have been removed to be vendor neutral, so all publisher pages must define them via pbjs.setConfig(). The same functionality as 0.x may be achieved with this setConfig:
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd revise the last phrase to "may be achieved as shown below" to avoid using the method name in prose right before just showing a code sample anyway.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

updated


{% highlight js %}

pbjs.setConfig({
cache: {url: "https://prebid.adnxs.com/pbc/v1/cache"},
s2sConfig: {
...
endpoint: "https://prebid.adnxs.com/pbs/v1/auction",
syncEndpoint: "https://prebid.adnxs.com/pbs/v1/cookie_sync",
...
}
});

{% endhighlight %}
Expand Down