adding defaultRates, a FAQ, and linking to setConfig documentation #973
Conversation
This file contains 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
jeanstemp
reviewed
Sep 25, 2018
dev-docs/modules/currency.md
Outdated
| @@ -49,14 +50,15 @@ For example, the default Prebid "low granularity" bucket is: | |||
| | USD$0.50 increments, capped at USD$5 | | |||
|
|
|||
| The following config translates the "low granularity" bucket with a conversion rate of | |||
| 108 yen to 1 US dollar. It also defines the current conversion rate as being 110 yen to the dollar, | |||
| 108 yen to 1 US dollar. It also defines the default conversion rate as being 110 yen to the dollar, | |||
There was a problem hiding this comment.
should end the sentence with a colon instead of a comma
| @@ -174,6 +176,7 @@ pbjs.setConfig({ | |||
| "currency": { | |||
| "adServerCurrency": "JPY", | |||
| "granularityMultiplier": 108 | |||
| "defaultRates": { "USD": { "JPY": 110 }} | |||
There was a problem hiding this comment.
Isn't defaultRates optional? In which case adding it wouldn't necessarily make this the "simplest integration".
dev-docs/modules/currency.md
Outdated
| @@ -241,7 +247,8 @@ a currency object that may contain several parameters: | |||
| | granularityMultiplier | `decimal` | How much to scale the price granularity calculations. Defaults to 1. | 108 | | |||
| | conversionRateFile | `URL` | Optional path to a file containing currency conversion data. See below for the format. Prebid.org hosts a file as described in the next section. | `http://example.com/rates.json` | | |||
| | rates | object | This optional argument allows you to specify the rates with a JSON object, subverting the need for the conversionRateFile parameter. If this argument is specified, the conversion rate file will not be loaded. | { 'USD': { 'CNY': 6.8842, 'GBP': 0.7798, 'JPY': 110.49 } } | | |||
| | bidderCurrencyDefault | `object` | This is an optional argument to provide publishers a way to define bid currency. This option is provided as a transition until such a time that most bidder adapters define currency on bid response. | { "bidderXYZ": "GBP" } | | |||
| | defaultRates | `object` | Optionally defines a default rate that can be used if the currency file cannot be loaded. This option isn't used when the `rates` parameter is supplied. | { 'USD': { 'GPB': 0.75 }} | | |||
There was a problem hiding this comment.
"An optional parameter that defines" rather than "Optionally defines"
dev-docs/modules/currency.md
Outdated
| @@ -299,4 +306,14 @@ If the timeout occurs while bids are still on the queue, they will be skipped ra | |||
|
|
|||
| Of course, use of Prebid currency feature is optional. | |||
|
|
|||
| **Why isn't my currency supported in Prebid's file?** | |||
|
|
|||
| The data in Prebid's hosted currency file comes from a reliable free source that doesn't contain all the countries in the world. | |||
There was a problem hiding this comment.
Suggest: The data in Prebid's hosted currency file comes from a free source. This source is reliable, but it doesn't contain currencies for all countries of the world.
dev-docs/modules/currency.md
Outdated
|
|
||
| The data in Prebid's hosted currency file comes from a reliable free source that doesn't contain all the countries in the world. | ||
|
|
||
| If there's a currency conversion you need, there are several options: |
There was a problem hiding this comment.
"If there's a currency conversion you need that's not included, ..."
dev-docs/modules/currency.md
Outdated
|
|
||
| 1. Use the 'defaultRates` feature | ||
| 1. Build and host a currency conversion file that includes the desired currencies | ||
| 1. Find a reliable, free, no-strings source of conversation data that we can integrate into our hosted file and post an issue on the github forum. |
There was a problem hiding this comment.
"...into our hosted file, then post..."
|
thanks @jeanstemp -- all comments covered. |
|
@mkendall07 - are you good with the link from the Pub API doc to the module-specific doc? Am assuming this is preferable to copying the setConfig args, but we could also implement as an include file. |
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.
@jeanstemp and @mkendall07 - please take a look at this modification to the publisher API doc ... thought it would be nice to have all the setConfig() options linked from the main API doc, and the currency options were over in the module-specific page.