Skip to content

Commit 1519971

Browse files
docs: add info about global property 'auctionSettingsId'.
1 parent 7be2b6e commit 1519971

File tree

4 files changed

+39
-0
lines changed

4 files changed

+39
-0
lines changed

prebid-mobile/pbm-api/android/code-integration-android.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -306,6 +306,16 @@ To stop sending stored bid response signals use the following method:
306306
void clearStoredBidResponses()
307307
```
308308

309+
### AuctionSettingsId
310+
{:.no_toc}
311+
312+
String to separate out account from "auction settings". There is used to set `ext.prebid.storedrequest.id`, otherwise prebidServerAccountId is taken by default.
313+
314+
```kotlin
315+
PrebidMobile.setAuctionSettingsId(YOUR_AUCTION_SETTINGS_ID)
316+
var auctionSettingsId = PrebidMobile.getAuctionSettingsId()
317+
```
318+
309319
### Debug
310320
{:.no_toc}
311321

prebid-mobile/pbm-api/android/pbm-targeting-android.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,29 @@ void clearStoredBidResponses()
184184

185185
Parameters: none.
186186

187+
#### setAuctionSettingsId()
188+
189+
For the SDK to separate out account from "auction settings".
190+
191+
Signature:
192+
193+
```kotlin
194+
func setAuctionSettingsId(settingsId: String)
195+
```
196+
197+
Parameters:
198+
199+
{: .table .table-bordered .table-striped }
200+
| Parameter | Scope | Type | Description | Example |
201+
| --- | --- | --- | --- | --- |
202+
| settingsId | optional | string | Use the settingsId to separate out account from "auction settings". If specified, the settingsId is used to set `ext.prebid.storedrequest.id`, otherwise prebidServerAccountId is taken by default. | "abc321" |
203+
204+
Examples:
205+
206+
```kotlin
207+
PrebidMobile.setAuctionSettingsId("abc321")
208+
```
209+
187210
#### setLogLevel
188211

189212
Controls the level of logging output to the console.

prebid-mobile/pbm-api/ios/code-integration-ios.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -221,6 +221,8 @@ The `Prebid` class is a singleton that enables the user to apply global settings
221221

222222
`prebidServerHost`: String containing configuration your Prebid Server host with which Prebid SDK will communicate. Choose from the system-defined Prebid Server hosts or define your own custom Prebid Server host.
223223

224+
`auctionSettingsId`: String to separate out account from "auction settings". There is used to set `ext.prebid.storedrequest.id`, otherwise prebidServerAccountId is taken by default.
225+
224226
`shareGeoLocation`: Optional Bool, if this flag is True AND the app collects the user’s geographical location data, Prebid Mobile will send the user’s geographical location data to Prebid Server. If this flag is False OR the app does not collect the user’s geographical location data, Prebid Mobile will not populate any user geographical location information in the call to Prebid Server. The default setting is false.
225227

226228
`logLevel`: Optional level of logging to output in the console. Options are one of the following sorted by a verbosity of the log:
@@ -337,6 +339,9 @@ do {
337339
// Account Id
338340
Prebid.shared.prebidServerAccountId = "1234"
339341

342+
// Auction Settings Id (Optional)
343+
Prebid.shared.auctionSettingsId = "7890"
344+
340345
// Geolocation
341346
Prebid.shared.shareGeoLocation = true
342347

prebid-mobile/pbm-api/ios/pbm-targeting-ios.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ Prebid.shared.customStatusEndpoint="https://pbs.example.com/v2/status"
4848
| prebidServerAccountId | either | string | init | Your Prebid Server team will tell you whether this is required or not and if so, the value. | "abc123" |
4949
| prebidServerHost | optional | enum | init | This can take the values "Appnexus", "Rubicon", or "Custom". If "Custom", you need to use the setCustomPrebidServerUrl() method to set a URL. This is where the Prebid SDK will send the auction information. Your Prebid Server team will tell you which value to use. The default is "Custom". | "Custom" |
5050
| customStatusEndpoint | optional | string | init | Use this URL to check the status of Prebid Server. The default status endpoint is the PBS URL appended with '/status'. | `https://prebidserver`<wbr>`.example`<wbr>`.com/custom`<wbr>`/status` |
51+
| auctionSettingsId | optional | string | init | For the SDK to separate out account from "auction settings". If specified, the auctionSettingsId is used to set `ext.prebid.storedrequest.id`, otherwise prebidServerAccountId is populated by default. | "abc321" |
5152
| shareGeoLocation | optional | boolean | ORTB | If this flag is true AND the app collects the user’s geographical location data, Prebid Mobile will send the user’s lat/long geographical location data to the Prebid Server. The default is false. | `true` |
5253
| locationUpdatesEnabled | optional | boolean | ORTB | If true, the SDK will periodically try to listen for location updates. Default is `false`. | `true` |
5354
| logLevel | optional | enum | SDK control | This property controls the level of logging output to the console. The value can be .error, .info, .debug, .verbose, .warn, .severe, and .info. The default is `.debug`. | `.error` |

0 commit comments

Comments
 (0)