Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/dev' into dev
Browse files Browse the repository at this point in the history
  • Loading branch information
SSuranie committed Mar 29, 2021
2 parents eb991af + b4b23fa commit 11deb64
Show file tree
Hide file tree
Showing 19 changed files with 278 additions and 57 deletions.
38 changes: 38 additions & 0 deletions _data/sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2046,3 +2046,41 @@
isSectionHeader: 0
sectionTitle:
subgroup: 0

#-------------- Prebid Identity --------------|

- sbSecId: 9
title:
link:
isHeader: 0
isSectionHeader: 1
sectionTitle: Prebid Identity
sectionId: prebid-identity
subgroup: 1000
sbCollapseId: prebid-identity

- sbSecId: 9
title: invis
link:
isHeader: 1
headerId: invis
isSectionHeader: 0
sectionTitle:
subgroup: 0

- sbSecId: 9
title: Identity Overview
link: /identity/prebid-identity.html
isHeader: 0
isSectionHeader: 0
sectionTitle:
subgroup: 0

- sbSecId: 9
title: SharedID and PubCommon ID
link: /identity/sharedIdPubCommon.html
isHeader: 0
isSectionHeader: 0
sectionTitle:
subgroup: 0

2 changes: 2 additions & 0 deletions _layouts/bidder.html
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,8 @@ <h3>Features</h3>
<td class="pbTd">{% if page.dchain_supported == true %}yes{% else %}no{% endif %}</td>
<th class="pbTh">Safeframes OK</th>
<td class="pbTd">{% if page.safeframes_ok == false %}no{% elsif page.safeframes_ok == true %}yes{% else %}check with bidder{% endif %}</td>
<th class="pbTh"></th>
<td class="pbTd"></td>
</tr>
<tr>
<th class="pbTh">Supports Deals</th>
Expand Down
8 changes: 8 additions & 0 deletions _layouts/home.html
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,14 @@ <h1>Prebid Documentation</h1>
<p class="mt-4"><a href="/prebid-mobile/download.html">Download Mobile SDK</a></p>
</div>
</div>
<div class="card text-center">
<div class="card-body">
<div class="card-media"><img src="/assets/images/user-identity.png" width=100 alt="Prebid User Identity Icon"></div>
<div class="card-title"><h3>Prebid User Identity</h3></div>
<p class="mb-4">Supporting a thriving open web while respecting user privacy.</p>
<a href="/identity/prebid-identity.html" class="btn btn-outline-brand">View Docs</a>
</div>
</div>
</div>

<div class="row text-center mt-7">
Expand Down
Binary file added assets/images/sharedid.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/user-identity.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 1 addition & 24 deletions dev-docs/analytics/adWMG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,32 +3,9 @@ layout: analytics
title: adWMG
description: adWMG Analytics Adapter
modulecode: adWMG
gdpr_supported: true
usp_supported: false
coppa_supported: false
prebid_member: false
gvl_id: 959
---

#### Analytics Options

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|-------------|---------|--------------------|-----------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------|------------------|
| publisher_id | required | Publisher ID from WMG Dashboard | `'5abd0543ba45723db49d97ea'` | string |
| site | required | Domain where Prebid.js working | `'test.com'` | string |


### Example Configuration

```
pbjs.enableAnalytics({
provider: 'adWMG',
options : {
site: 'test.com',
publisher_id: '5abd0543ba45723db49d97ea'
}});
```
#### Registration

Please visit [https://adwmg.com/](https://adwmg.com/) for more information.

25 changes: 3 additions & 22 deletions dev-docs/analytics/pubmatic.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,13 @@
---
layout: analytics
title: PubMatic
description: PubMatic Analytics Adapter
title: Pubmatic
description: Pubmatic Analytics Adapter
modulecode: pubmatic
prebid_member: true
gvl_id: 76
enable_download: false
---

#### Registration

The PubMatic Analytics adapter requires setup and approval from the
PubMatic team. Please reach out to your account team for more information.
Please visit []() for more information.

#### Analytics Options

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|-------------|---------|--------------------|-----------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------|------------------|
| publisherId | required | The PubMatic Publisher ID | 1001 | int |

### Example Configuration

```
pbjs.enableAnalytics({
provider: 'pubmatic',
options: {
"publisherId": 12345 // please contact PubMatic to get a publisherId for yourself
}
});
```
2 changes: 1 addition & 1 deletion dev-docs/bidders/adyoulike.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Adyoulike
description: Prebid Adyoulike Bidder Adaptor
pbjs: true
pbs: true
media_types: banner, video, native
media_types: banner, native
biddercode: adyoulike
gdpr_supported: true
usp_supported: true
Expand Down
2 changes: 1 addition & 1 deletion dev-docs/bidders/amx.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ layout: bidder
title: AMX RTB
description: AMX RTB Prebid Bid Adapter
hide: true
schain_supported: true
schain_supported: false
gdpr_supported: true
usp_supported: true
coppa_supported: true
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion dev-docs/bidders/livewrapped.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ biddercode: livewrapped
pbjs: true
media_types: banner, video, native
gdpr_supported: true
userIds: all
userIds: id5Id, pubCommonId
schain_supported: true
gvl_id: 919
---
Expand Down
2 changes: 1 addition & 1 deletion dev-docs/modules/idLibrary.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Maintainer: eng-dmp@magnite.com
# ID Import Library
{:.no_toc}

The ID Import Library module gathers and generates a map of identities present on the page. The primary usecase for this adapter is for Publishers who have included multiple UserId subadapters in their prebid.js implementation, and want to store the resulting user ids serverside for modeling or graphing purposes. The ID Library module, anchors the response of `refreshUserIds()` to a presistant identifier (md5 encrypted) and returns an map of uids. This map of uids comes in the form of a POST message in JSON format and must be output to a publisher configured endpoint.
The ID Import Library module gathers and generates a map of identities present on the page. The primary usecase for this adapter is for Publishers who have included multiple UserId subadapters in their prebid.js implementation, and want to store the resulting user ids serverside for modeling or graphing purposes. The ID Library module, anchors the response of `refreshUserIds()` to a persistant identifier (md5 encrypted) and returns an map of uids. This map of uids comes in the form of a POST message in JSON format and must be output to a publisher configured endpoint.

The module attempts to extract a persistant identifier in the following ways:

Expand Down
4 changes: 2 additions & 2 deletions dev-docs/modules/userId.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,6 @@ of sub-objects. The table below has the options that are common across ID system
| value | Optional | Object | Used only if the page has a separate mechanism for storing a User ID. The value is an object containing the values to be sent to the adapters. | `{"tdid": "1111", "pubcid": {2222}, "IDP": "IDP-2233", "id5id": {"uid": "ID5-12345"}}` |


## User ID Sub-Modules

## Permissions
Publishers can control which user ids are shared with the bid adapters they choose to work with by using the bidders array. The bidders array is part of the User id module config, publisher may choose to send an id to some bidders but not all, the default behavior is that each user id go to all bid adapters the publisher is working with.

Expand Down Expand Up @@ -135,6 +133,8 @@ The Rubicon bid adapter would then receive
}
```

## User ID Sub-Modules

### BritePool

The [BritePool]((https://britepool.com)) ID is a persistent identifier that enables identity resolution for people-based marketing in the cookieless world. Every BritePool ID is associated with a real identity. As a result, publishers, SSPs and DSPs that integrate with BritePool, or automated
Expand Down
4 changes: 2 additions & 2 deletions dev-docs/pbs-bidders.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ You can also download the full <a href="/dev-docs/bidder-data.csv" download>CSV
| **Bidder Code** | {{ page.biddercode }} | **Prebid.org Member** | {% if page.prebid_member == true %}yes{% else %}no{% endif %} |
| **Media Types** | {% unless page.media_types contains 'no-display' %}display{% endunless %}{% if page.media_types contains 'video' %},{% endif %}{% if page.media_types contains 'video' %} video{% endif %}{% if page.media_types != "no-display, native" and page.media_types contains 'native' %}, native{% endif %}{% if page.media_types == "no-display, native" %}native{% endif %} | **GDPR TCF Support** | {% if page.gdpr_supported == true %}yes{% else %}no{% endif %} |
| **User IDs** | {% if page.userIds and page.userIds != '' %}{{page.userIds}}{% else %}none{% endif %} | **USP/CCPA Support** | {% if page.usp_supported == true %}yes{% else %}no{% endif %} |
| **Supply Chain Support** | {% if page.schain_supported == true %}yes{% else %}no{% endif %} | **COPPA Support** | {% if page.coppa_supported == true %}yes{% else %}no{% endif %} |
| **Demand Chain Support** | {% if page.dchain_supported == true %}yes{% else %}no{% endif %} | **Safeframes OK** | {% if page.safeframes_ok and page.safeframes_ok == false %}no{% elsif page.safeframes_ok and page.safeframes_ok == true %}yes{% else %}check with bidder{% endif %} |
| **SChain Support** | {% if page.schain_supported == true %}yes{% else %}no{% endif %} | **COPPA Support** | {% if page.coppa_supported == true %}yes{% else %}no{% endif %} |
| **Safeframes OK** | {% if page.safeframes_ok and page.safeframes_ok == false %}no{% elsif page.safeframes_ok and page.safeframes_ok == true %}yes{% else %}check with bidder{% endif %} | | |
| **Supports Deals** | {% if page.bidder_supports_deals and page.bidder_supports_deals == false %}no{% else %}yes{% endif %} | **Prebid.js Adapter** | {% if page.pbjs == true %}yes{% else %}no{% endif %} |
| **Mobile App Support** | {% if page.pbs_app_supported and page.pbs_app_supported == false %}no{% elsif page.pbs_app_supported and page.pbs_app_supported == true %}yes{% else %}check with bidder{% endif %} | **Prebid Server Adapter** | yes |

Expand Down
2 changes: 1 addition & 1 deletion features/firstPartyData.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ pbjs.setConfig({
keywords: "power tools, drills",
search: "drill",
content: {
userrating: "4",
userrating: 4,
data: [{
"name": "www.dataprovider1.com",
"ext": { "taxonomyname": "iab_content_taxonomy" },
Expand Down
60 changes: 60 additions & 0 deletions identity/prebid-identity.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
layout: page_v2
title: Prebid User Identity
description: What is Prebid User Identity
sidebarType: 9
---

# Prebid User Identity Overview

`DRAFT`

Prebid's aim is to enable the protection of user privacy while still supporting publisher's ability to make revenue,
keeping the Open Web healthy.

To do this, Prebid offers a number of identity-related products that encourage awareness of privacy regulations such as GDPR, CCPA, and COPPA. The most important projects are:

- [Prebid.js User Identity Module](/dev-docs/modules/userId.html) - supporting more than 20 different flavors of global IDs with different features, publishers can work with.
- [SharedId and PubCommon ID](/identity/sharedIdPubCommon.html) - Prebid's native hosted ID offerings are simple, free, robust, and privacy-minded.
- Coming soon: UID2

## Prebid.js and Identity

Publishers have several ways to include user identity as part of
the header bidding auction:

1. Install one or more [User ID modules](/dev-docs/modules/userId.html) - these modules obtain
the user's ID from the service and make it available to participating bidders. Publishers
can place [permissons](/dev-docs/modules/userId.html#permissions) on which bidders receive which IDs.
2. Install the [ID Import Module](/dev-docs/modules/idLibrary.html) - this can be
used to generates a map of identities present on the page.
3. Pass registered [User First Party Data](/features/firstPartyData.html) to bidders such as interests to bidders for more relevant advertising.
4. [User Syncing](dev-docs/publisher-api-reference.html#setConfig-Configure-User-Syncing) allows bid adapters to establish IDs. Publishers have control over which bidders may sync, which syncing mechanisms are allowed, and when the syncing occurs. Syncing is subject to privacy controls such as GDPR, CCPA, and COPPA.

## Prebid Server and Identity

Prebid Server has a user-sync functionality allowing server-side bidders to establish
IDs given appropriate permission from the user for setting cookies.

Prebid Server can receive extended ID arrays from Prebid.js and provide them to
participating server-side bid adapters. It also supports permissioning to determine
which eids can be sent to which bidders.

User IDs are not sent to bid adapters in privacy scenarios such as COPPA and
GDPR requests lacking appropriate consent. For more details see the [Prebid Server Privacy](/prebid-server/features/pbs-privacy.html) page.

## Prebid SDK and Identity

In application environments, performance based advertisers rely on a device’s IDFA to target,
frequency cap and determine attribution, very similar to how cookies are used in desktop
environments, however IDFAs are persistent to the device. Prebid SDK will read the IDFA from
the device when available. Additionally, Prebid SDK supports third party identity IDs.

Prebid Server will strip the IDFA and / or third party identity IDs when enforcing government regulation (GDPR, CCPA, etc.).

## AMP, Prebid, and Identity

Prebid Server supports a user [cookie-sync](/prebid-server/developers/pbs-cookie-sync.html) functionality, including integration with
a consent management platform. This allows server-side bidders to establish IDs given
the appropriate cookie-setting permissions from the user.

Loading

0 comments on commit 11deb64

Please sign in to comment.