Skip to content

Commit f9559f6

Browse files
authored
Glimpse: add usp support, update params and fpd setup (prebid#3669)
- Add usp support - Remove demand and keywords bidder params - Update example on setting up adapter with first party data - Rename placementId to pid - Update fpd section description - remove user.ext.keywords from example - update contact email address
1 parent 3231fdb commit f9559f6

1 file changed

Lines changed: 39 additions & 51 deletions

File tree

dev-docs/bidders/glimpse.md

Lines changed: 39 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ description: Glimpse Protocol Bid Adapter
55
biddercode: glimpse
66
pbjs: true
77
gdpr_supported: true
8+
usp_supported: true
89
deals_supported: true
910
media_types: banner
1011
gvl_id: 1012
@@ -15,26 +16,26 @@ gvl_id: 1012
1516
```
1617
Module Name: Glimpse Protocol Bid Adapter
1718
Module Type: Bidder Adapter
18-
Maintainer: publisher@glimpseprotocol.io
19+
Maintainer: support@glimpseportal.io
1920
```
2021

2122
## Description
2223

23-
This module connects publishers to Glimpse Protocol's demand sources via Prebid.js. Our innovative marketplace protects consumer privacy while allowing precise targeting.
24+
Glimpse protects consumer privacy while allowing precise targeting. This module connects publishers
25+
to Glimpse Protocol's demand sources via Prebid.js.
2426

2527
## Supported Media Types
2628

27-
| Type | Sizes |
29+
{: .table .table-bordered .table-striped }
30+
| Type | Sizes |
2831
| -------- | ----------------------------------------- |
2932
| `Banner` | 300x250, 300x600, 320x50, 728x90, 970x250 |
3033

3134
## Setup
3235

33-
This section shows how to configure your Prebid.js integration to work with the Glimpse module.
34-
3536
### Prerequisites
3637

37-
Before you start to configure Glimpse, you will need to build a `prebid.js` file with the Glimpse module included, and include both `gpt.js` and `prebid.js` in the `head` of each page with supply. An example of a typical pair of script tags might be:
38+
Before you start, you will need to build a `prebid.js` file with the Glimpse module included, and include both `gpt.js` and `prebid.js` in the `head` of each page with supply. An example of a typical pair of script tags might be:
3839

3940
```html
4041
<script
@@ -45,29 +46,16 @@ Before you start to configure Glimpse, you will need to build a `prebid.js` file
4546
<script async src="https://<PUBLISHER_DOMAIN>/prebid.js"></script>
4647
```
4748

48-
### Publisher Registration
49-
50-
Coming soon.
51-
52-
### Domain Registration
53-
54-
Coming soon.
55-
56-
### Ad Unit Registration
57-
58-
Coming soon.
59-
6049
## Configuration
6150

6251
### Bid Requests
6352

64-
Our adapter captures the following values in the `params` block of each bid request:
53+
Our adapter expects the following values in the `params` block of each bid request:
6554

66-
| Name | Scope | Type | Description | Example |
67-
| ------------- | -------- | ------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ---------------------- |
68-
| `placementId` | Required | string | A unique identifier associated with a publisher and ad unit, provided by the Glimpse Publisher Portal when registering a unit | 'glimpse-placement-id' |
69-
| `demand` | Optional | string | Target demand source (defaults to 'glimpse') | 'xandr' |
70-
| `keywords` | Optional | Record<string, any> | Audience targeting data (applies to the single ad unit) | { sticky: true } |
55+
{: .table .table-bordered .table-striped }
56+
| Name | Scope | Type | Description | Example |
57+
| ----- | -------- | ------ | --------------------------------------------------------------------------------------------------- | ---------------------- |
58+
| `pid` | Required | string | A unique identifier representing an ad unit. It is provided by Glimpse when registering an ad unit. | 'glimpse-placement-id' |
7159

7260
#### Example
7361

@@ -82,11 +70,7 @@ const units = [
8270
{
8371
bidder: "glimpse",
8472
params: {
85-
placementId: "glimpse-placement-id",
86-
demand: "glimpse",
87-
keywords: {
88-
sticky: true,
89-
},
73+
pid: "glimpse-placement-id",
9074
},
9175
},
9276
],
@@ -96,43 +80,47 @@ const units = [
9680

9781
### First Party Data
9882

99-
Our adapter captures site and user level data that can be passed to all units using the `ortb2` block, as described [here](https://docs.prebid.org/features/firstPartyData.html).
83+
Our adapter works with first party data providers as described [here](https://docs.prebid.org/features/firstPartyData.html). In this example we add Permutive data to our bidder request using [setBidderConfig](https://docs.prebid.org/features/firstPartyData.html#supplying-bidder-specific-data).
10084

10185
#### Example
10286

10387
```javascript
10488
pbjs.que.push(() => {
105-
pbjs.setConfig({
106-
ortb2: {
107-
site: {
108-
keywords: "sports, basketball",
109-
ext: {
110-
data: {
111-
title: "The Premier League",
89+
pbjs.setBidderConfig({
90+
bidders: ["glimpse"],
91+
config: {
92+
ortb2: {
93+
site: {
94+
keywords: "business,finance,crypto",
95+
ext: {
96+
data: {
97+
permutive: {
98+
pvc: JSON.parse(localStorage.getItem("permutive-pvc")) ?? {},
99+
},
100+
},
112101
},
113102
},
114-
},
115-
user: {
116-
keywords: "food, takeaway",
117-
ext: {
118-
data: {
119-
firstVisit: true,
103+
user: {
104+
ext: {
105+
data: {
106+
permutive: {
107+
keywords: JSON.parse(localStorage.getItem("_psegs")) ?? [],
108+
enrichers:
109+
JSON.parse(
110+
localStorage.getItem("permutive-data-enrichers")
111+
) ?? {},
112+
},
113+
},
120114
},
121115
},
122116
},
123-
}
117+
},
124118
})
125-
126-
...
127119
})
128120
```
129121
130122
## FAQs
131123
132-
### Can I test my setup without a Publisher Portal Account?
133-
134-
Yes, to test your setup, you can trigger Glimpse to respond with randomly-generated bids for your correctly-configured units by setting `demand: 'demo'` in the `params` of each unit.
135-
136124
### Can you provide additional support?
137125
138-
Of course! You can check the Glimpse Prebid Adapter documentation, [here](https://docs.glimpseportal.io/en/latest/), or reach out to us at [publisher@glimpseprotocol.io](mailto:publisher@glimpseprotocol.io).
126+
Of course! You can check the Glimpse Prebid Adapter documentation [here](https://docs.glimpseportal.io/en/latest/) or reach out to us at [support@glimpseportal.io](mailto:support@glimpseportal.io).

0 commit comments

Comments
 (0)