Skip to content

add docs for Geolocation Module#4680

Merged
ChrisHuie merged 14 commits intoprebid:masterfrom
dariaboyko:geolocation_module
Jul 21, 2023
Merged

add docs for Geolocation Module#4680
ChrisHuie merged 14 commits intoprebid:masterfrom
dariaboyko:geolocation_module

Conversation

@dariaboyko
Copy link
Contributor

@dariaboyko dariaboyko commented Jun 26, 2023

🏷 Type of documentation

  • new bid adapter
  • update bid adapter
  • new feature
  • text edit only (wording, typos)
  • bugfix (code examples)
  • new examples

📋 Checklist

@netlify
Copy link

netlify bot commented Jun 26, 2023

Deploy Preview for prebid-docs-preview ready!

Name Link
🔨 Latest commit 2f822ff
🔍 Latest deploy log https://app.netlify.com/sites/prebid-docs-preview/deploys/64ac240b85d4b800083c97a5
😎 Deploy Preview https://deploy-preview-4680--prebid-docs-preview.netlify.app/dev-docs/modules/geolocationrtdprovider
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@dariaboyko dariaboyko changed the title add dos for Geolocation Module add docs for Geolocation Module Jun 27, 2023
@patmmccann
Copy link
Collaborator

how is this different than #4607

@dariaboyko
Copy link
Contributor Author

sorry, didn`t see it was already done

@dariaboyko dariaboyko closed this Jun 28, 2023
@dariaboyko dariaboyko reopened this Jun 28, 2023
@dariaboyko
Copy link
Contributor Author

Can you please close that one pull request and use this as a main

@bretg bretg mentioned this pull request Jun 29, 2023
2 tasks
|params | Object | | |
|params.requestPermission | Boolean | Customer permission |Required, always true |

The Geolocation is set in ortb2Fragments.global.device.geo in requestBidsObject and looks like this:
Copy link
Contributor

Choose a reason for hiding this comment

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

Sorry, I still don't fully understand how a bid adapter would make use of this data. I see a couple of adapters that do the following:

mergeDeep(reqBidsConfigObj.ortb2Fragments.global, _ortb2);

Is that all they need to do and the data will wind up in device.geo?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes, also they can get it while building request from function callback

Copy link
Contributor

Choose a reason for hiding this comment

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

Cool - can you update the doc with a specific reference for how bid adapters should consume this info?

@bretg bretg added the question label Jun 29, 2023
@dariaboyko
Copy link
Contributor Author

Hi! Can you check if everything allright?

}
```

It can be accessed from adapter with buildRequests` function callback of bidderRequest object. Also can be used something like mergeDeep(reqBidsConfigObj.ortb2Fragments.global, _ortb2).
Copy link
Contributor

@bretg bretg Jul 10, 2023

Choose a reason for hiding this comment

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

How about this:

This data can be accessed from a bid adapter in one of several ways:
1. Read reqBidsConfigObj.ortb2Fragments.global.device.geo directly
2. Just merge everything in ortb2Fragments
3. Start utilizing the [ortbConverter library](https://github.com/prebid/Prebid.js/blob/master/libraries/ortbConverter/README.md)

Can you confirm that usage of ortbConverter will pick up the module's output?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes it will

Copy link
Contributor

@bretg bretg left a comment

Choose a reason for hiding this comment

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

thanks for your patience here. looks good

@bretg bretg added LGTM and removed question labels Jul 10, 2023
@bretg
Copy link
Contributor

bretg commented Jul 10, 2023

FYI - this docs PR will be merged after the PBJS PR is merged and released

@ChrisHuie ChrisHuie merged commit 23199ca into prebid:master Jul 21, 2023
ecdrsvc pushed a commit to ecdrsvc/prebid.github.io that referenced this pull request Sep 6, 2023
* Geolocation Module

* markdownlint fixes

* javascript spec

* faq fix

* fixes

* fixes 2

* fixes 3

* Update activity-controls.md

* Update mspa-usnat.md

* Update geolocationRtdProvider.md

fixed formatting and alignment, general wordsmithing

* access

* access 2

* lint fixes

---------

Co-authored-by: bretg <bgorsline@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

Comments