Update Prebid.js documentation #327
Conversation
|
@mcollins-ttd please add the documentation from this discussion |
docs/guides/summary-guides.md
Outdated
|
|
||
| ### Web Integrations | ||
|
|
||
| The following resources are available for publisher web integrations. | ||
|
|
||
| | Integration Guide | Content Description | | ||
| | :--- | :--- | | ||
| | [Prebid.js Integration Guide](./integration-prebid.md) | An integration guide for publishers who want to integrate with UID2 and generate identity tokens to be passed by Prebid in the RTB bid stream. | | ||
| | [Prebid.js Advanced Integration Guide](./integration-prebid-advanced.md) | An integration guide for publishers who want to integrate with UID2 and generate identity tokens to be passed by Prebid in the RTB bid stream. | |
There was a problem hiding this comment.
nit: The same summaries between the two guides make me confused. I think Advanced integration needs server-side changes, could we emphasise this in summary?
|
|
||
| When you configure the module to use Client Refresh mode, you must choose **one** of the following options for storing the API response information. | ||
| The following sections demonstrate the different ways to configure the UID2 module and list the requirements for the DII passed to the module. |
There was a problem hiding this comment.
should we highlight in bold or add a ":::note" section here to tell pub to pass 1 and only 1 DII (not multiple) in a single setConfig call to UID2 module?
docs/guides/integration-prebid.md
Outdated
| Information about how to integrate Prebid with UID2 is also in these locations: | ||
| - On the [Unified ID 2.0](https://docs.prebid.org/dev-docs/modules/userid-submodules/unified2.html) page for the Prebid User ID submodule on the Prebid site. | ||
| - In the [UID2 User ID Submodule](https://github.com/prebid/Prebid.js/blob/master/modules/uid2IdSystem.md) page in the Prebid GitHub repository. | ||
| Complete the UID2 account setup by following the steps described in the [Account Setup](../getting-started/gs-account-setup.md) page. You will need to provide a list of domain names for the sites that you will be using with Prebid.js. |
There was a problem hiding this comment.
Can we add "You will need to provide a list of domain names for the sites that you will be using with Prebid.js." to after when the account setup is complete? Feels like the domain names is part of the actual account setup.
Complete the UID2 account setup by following the steps described in the [Account Setup] page.
When account setup is complete you will be provided with a public key and subscription ID. These will be used to configure the UID2 module. You will also need to provide a list of domain names for the sites that you will be using with Prebid.js.
There was a problem hiding this comment.
Pubs will have to provide domain names as part of the account setup, otherwise the public key and subscription ID they receive won't be usable
There was a problem hiding this comment.
Added some clarification
You will need to provide a list of domain names for the sites that you will be using with Prebid.js as part of the account setup process.
|
|
||
| You must provide the Prebid module with the full JSON response body from the applicable endpoint: | ||
| Once configured, the UID2 module will generate a UID2 token for the user and store it in the user's browser. The module will automatically refresh the token as required while your site is open in the user's browser. |
There was a problem hiding this comment.
Is it stored in a cookie or local storage or is this an option of prebid? Feel like we might get a question based on dailyvoice.
There was a problem hiding this comment.
Added a section on how the module stores data
docs/guides/integration-prebid.md
Outdated
|
|
||
| ### Response Storage Options | ||
| :::note | ||
| The examples assume you are using the UID2 production environment. During integration testing use the UID2 integration environment by setting `params.uid2ApiBase` to `"https://operator-integ.uidapi.com"`. You will have a different **subscription ID** and **public key** for the integration environment. |
There was a problem hiding this comment.
Agreed with Andrei in that we should not be putting integ data into the bid stream, can we call that out here please?
|
|
||
| In this example, the cookie is called `uid2_pub_cookie`. | ||
| No normalization or hashing is required by the publisher. |
There was a problem hiding this comment.
Okay so after reading the full doc, I now understand what we are doing here :)
Can we maybe put in a list or table above here to state which integration route options you have? -- Email, Hashed Email, Phone...
There was a problem hiding this comment.
Added a list of the options
|
work done and merged in other PR |
No description provided.