Update SharedId docs with Conversant content #3137

jdwieland8282 · 2021-07-21T20:22:53Z

updating the table and text of Sharedid (FKA pubcommon's) entry in the user id section.

adding docs from Conversant's site as requested in #2525

patmmccann · 2021-07-22T16:46:14Z

identity/sharedid.md

+| --- | --- | --- | --- | --- | --- |
+| 3rd Party Cookie Only | No first party cookie solution. | Some Blocked | Blocked | None | Low |
+| Prebid User Id | Including User Id Module in your Prebid installation. | 365 days | 7 days | Basic | Good |
+| PubCID Script | Adding the PubCID script to work with our ad code or a custom integration. | 365 days | 7 days | Basic | Good |


This is legacy method one might use without prebid, no longer recommended.

I would change Description to
'Adding the legacy PubCID script; not maintained by Prebid.org'
Technical Difficulty to 'High' and Revenue to 'Varies'

patmmccann · 2021-07-22T16:46:22Z

identity/sharedid.md

+| Implementation | Description | Cookie Lifetime | SAFARI COOKIE LIFETIME | TECHNICAL DIFFICULTY | REVENUE BENEFIT |
+| --- | --- | --- | --- | --- | --- |
+| 3rd Party Cookie Only | No first party cookie solution. | Some Blocked | Blocked | None | Low |
+| Prebid User Id | Including User Id Module in your Prebid installation. | 365 days | 7 days | Basic | Good |


User Id Submodule | 'Prebid.js installation' not Prebid

patmmccann · 2021-07-22T16:47:31Z

identity/sharedid.md

+| 3rd Party Cookie Only | No first party cookie solution. | Some Blocked | Blocked | None | Low |
+| Prebid User Id | Including User Id Module in your Prebid installation. | 365 days | 7 days | Basic | Good |
+| PubCID Script | Adding the PubCID script to work with our ad code or a custom integration. | 365 days | 7 days | Basic | Good |
+| PubCID Server | Writing cookie from your web server code directly. | 365 days | 365 days | Intermediate | Best |


SharedId Server

patmmccann · 2021-07-22T16:47:50Z

dev-docs/modules/userId.md

@@ -1366,6 +1370,9 @@ pbjs.setConfig({
    userSync: {
        userIds: [{
            name: "pubCommonId",
+            params: {
+                pixelUrl: "/wp-json/pubcid/v1/extend/"


pixelUrl should be specified when the server plugin, so I would make this a no. 3 in the examples list and say something like 3) Publisher supports SharedID and first party domain cookie storage initiated by the server

dev-docs/modules/userId.md

patmmccann · 2021-07-22T16:50:46Z

identity/sharedid.md

-            name: 'sharedId',
+            name: 'sharedId', //"pubCommonId" as a name is supported for backwards compatibility,
+            params: {
+                pixelUrl: "/wp-json/pubcid/v1/extend/"


I would add: '// this parameter identifies your server side endpoint that will set a first party cookie if you have configued SharedId server'

patmmccann · 2021-07-22T16:51:11Z

identity/sharedid.md

+
+### SharedId Script
+
+For those interested in implementing Sharedid outside of Prebid. 


without prebid.js

patmmccann · 2021-07-22T16:52:34Z

identity/sharedid.md

+}
+```
+
+Using a PubCID Server implementation, create the cookie once, which will be allowed to expire before it is created again.


SharedId Server

patmmccann · 2021-07-22T16:52:57Z

identity/sharedid.md

+2. Drupal : Install from [Github](https://github.com/prebid/sharedid-drupal).
+
+#### Server Implementations
+Below are some examples for how to implement PubCID in various languages or platforms.


SharedId Server

dev-docs/modules/userId.md

patmmccann

Great work! Thank you, a few comments throughout

identity/sharedid.md

updating sharedid examples to include a #3 describing the setConfig when a server is used

adding text around docuement.cookie use in safari

dev-docs/modules/userId.md

bretg · 2021-07-22T17:55:11Z

dev-docs/modules/userId.md

@@ -1354,8 +1354,12 @@ In addition to the parameters documented above in the Basic Configuration sectio
 | name | Required | String | The name of this module. | `'pubCommonId'` |
 | params | Optional | Object | Customized parameters | |
 | params.create | Optional | Boolean | For publisher server support only.  If true, the publisher's server will create the (pubcid) cookie.  Default is true. | `true` |
-| params.pixelUrl | Optional | String | For publisher server support only.  This is a URL of a pixel for updating cookies' expiration times.  Fired after a new ID has been created or an existing ID is being extended.  No default. | `'https://example.com/ping'`
+| params.pixelUrl | Optional | String | For publisher server support only. Where to call out to for a server cookie. | `/wp-json/pubcid/v1/extend/`


This server-cookie thing would be mysterious to me if I didn't know about the PubCID first-party server thing.

added a see here for more info link

renaming user id module section and updating desc in table to prebid.js

noting that Pubcid script has a high technical cost and a variable revenue benifit

renaming pubcid server to SharedId Server

adding a comment to pixelURL clarifying what this param should be used for.

updating when sharedid script is appropriate

updating pubcid server to SharedId Server

adding a link to sharedid.html

adding a second link to sharedid.html

adding additional language sharedid servers benefits wrt safari

patmmccann · 2021-07-23T16:30:05Z

@jdwieland8282 thanks so much for getting this to the finish line; this doc has some really useful information that will hopefully help publishers more successfully implement.

identity/sharedid.md

adding text to CMS description.

- The term "sharedId server" confused me. I changed most of these to "endpoint" instead of server. - Clarified the term "plugin", which has a meaning in PBJS that's quite different than the usage here. - Removed duplicate exhortations to use the weird "endpoint" thing.

jdwieland8282 added 2 commits July 21, 2021 14:22

Update userId.md

e7b8202

updating the table and text of Sharedid (FKA pubcommon's) entry in the user id section.

Update sharedid.md

8dd20ff

adding docs from Conversant's site as requested in #2525

jdwieland8282 requested a review from patmmccann July 21, 2021 22:31

jdwieland8282 changed the title ~~Update userId.md~~ Update SharedId docs with Conversant content Jul 21, 2021

jdwieland8282 mentioned this pull request Jul 21, 2021

Incorporate PubCID doc #2525

Closed

patmmccann reviewed Jul 22, 2021

View reviewed changes

patmmccann requested changes Jul 22, 2021

View reviewed changes

patmmccann reviewed Jul 22, 2021

View reviewed changes

dev-docs/modules/userId.md Show resolved Hide resolved

patmmccann requested changes Jul 22, 2021

View reviewed changes

identity/sharedid.md Show resolved Hide resolved

jdwieland8282 added 2 commits July 22, 2021 11:47

Update userId.md

0405ab0

updating sharedid examples to include a #3 describing the setConfig when a server is used

Update sharedid.md

3cd454a

adding text around docuement.cookie use in safari

bretg reviewed Jul 22, 2021

View reviewed changes

dev-docs/modules/userId.md Show resolved Hide resolved

bretg reviewed Jul 22, 2021

View reviewed changes

jdwieland8282 added 10 commits July 22, 2021 11:56

Update sharedid.md

e54b54a

renaming user id module section and updating desc in table to prebid.js

Update sharedid.md

7e6f970

noting that Pubcid script has a high technical cost and a variable revenue benifit

Update sharedid.md

e1a6ea7

renaming pubcid server to SharedId Server

Update sharedid.md

3e4294f

adding a comment to pixelURL clarifying what this param should be used for.

Update sharedid.md

f400d82

updating when sharedid script is appropriate

Update sharedid.md

e438269

updating pubcid server to SharedId Server

Update sharedid.md

5054ba8

updating pubcid server to SharedId Server

Update userId.md

4dd5435

adding a link to sharedid.html

Update userId.md

d7311ce

adding a second link to sharedid.html

Update sharedid.md

fe9803d

adding additional language sharedid servers benefits wrt safari

jdwieland8282 requested review from bretg and patmmccann July 23, 2021 16:20

patmmccann approved these changes Jul 23, 2021

View reviewed changes

changing link to relative

ea8d9ef

bretg added 3 commits July 23, 2021 14:53

another link

8dbd23e

wordsmithing

63e28e3

consistency and wordsmithing

7f28939

bretg requested changes Jul 23, 2021

View reviewed changes

identity/sharedid.md Outdated Show resolved Hide resolved

Update sharedid.md

e524cc1

adding text to CMS description.

jdwieland8282 requested a review from bretg July 27, 2021 17:57

bretg approved these changes Jul 27, 2021

View reviewed changes

jdwieland8282 merged commit fede322 into master Jul 27, 2021

bretg deleted the jdwieland8282-patch-3 branch August 2, 2021 16:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update SharedId docs with Conversant content #3137

Update SharedId docs with Conversant content #3137

jdwieland8282 commented Jul 21, 2021

patmmccann Jul 22, 2021

jdwieland8282 Jul 22, 2021

patmmccann Jul 22, 2021 •

edited

Loading

jdwieland8282 Jul 22, 2021

patmmccann Jul 22, 2021

jdwieland8282 Jul 22, 2021

patmmccann Jul 22, 2021

jdwieland8282 Jul 23, 2021

patmmccann Jul 22, 2021

jdwieland8282 Jul 22, 2021

patmmccann Jul 22, 2021

jdwieland8282 Jul 22, 2021

patmmccann Jul 22, 2021

jdwieland8282 Jul 22, 2021

patmmccann Jul 22, 2021

jdwieland8282 Jul 22, 2021

patmmccann left a comment

bretg Jul 22, 2021

jdwieland8282 Jul 22, 2021

patmmccann commented Jul 23, 2021


		### SharedId Script

		For those interested in implementing Sharedid outside of Prebid.

Update SharedId docs with Conversant content #3137

Update SharedId docs with Conversant content #3137

Conversation

jdwieland8282 commented Jul 21, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

patmmccann Jul 22, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

patmmccann left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

patmmccann commented Jul 23, 2021

patmmccann Jul 22, 2021 •

edited

Loading