Skip to content

Commit

Permalink
Merge branch 'prebid:master' into master
Browse files Browse the repository at this point in the history
  • Loading branch information
fatihkaya84 authored Dec 10, 2024
2 parents 8008477 + 2bd11ce commit 77d9144
Show file tree
Hide file tree
Showing 87 changed files with 1,146 additions and 319 deletions.
8 changes: 8 additions & 0 deletions _data/sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -490,6 +490,14 @@
sectionTitle:
subgroup: 5

- sbSecId: 1
title: User ID Modules
link: /dev-docs/modules/index.html#user-id-modules
isHeader: 0
isSectionHeader: 0
sectionTitle:
subgroup: 5

- sbSecId: 1
title: External Interfaces
link:
Expand Down
2 changes: 2 additions & 0 deletions _includes/dev-docs/fingerprinting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
{: .alert.alert-warning :}
This adapter uses JavaScript APIs commonly used in fingerprinting and may get your Prebid build flagged as a fingerprinting script.
5 changes: 0 additions & 5 deletions _includes/disqus_addon.html

This file was deleted.

4 changes: 0 additions & 4 deletions _layouts/api_prebidjs.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,6 @@ <h2>{{ page.title }}</h2>

<p><a href="/dev-docs/publisher-api-reference.html">Back to Publisher API Reference</a></p>
</div>

{% if page.show_disqus %}
{% include disqus_addon.html %}
{% endif %}
</div>

</div>
Expand Down
4 changes: 0 additions & 4 deletions _layouts/bidder.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,10 +86,6 @@ <h3>"Send All Bids" Ad Server Keys</h3>

<p><a href="/dev-docs/bidders.html">Back to Bidders</a></p>
</div>

{% if page.show_disqus %}
{% include disqus_addon.html %}
{% endif %}
</div>

</div>
Expand Down
4 changes: 0 additions & 4 deletions _layouts/internal_api_prebidjs.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,6 @@ <h2>{{ page.title }}</h2>

<p><a href="/dev-docs/internal-api-reference.html">Back to Internal API Reference</a></p>
</div>

{% if page.show_disqus %}
{% include disqus_addon.html %}
{% endif %}
</div>

</div>
Expand Down
3 changes: 0 additions & 3 deletions _layouts/test.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,6 @@ <h4>Send All Bids Ad Server Keys</h4>

</div>

{% if page.show_disqus %}
{% include disqus_addon.html %}
{% endif %}
</div>

</div>
Expand Down
18 changes: 18 additions & 0 deletions _layouts/userid.html
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,24 @@
<p><a href="/dev-docs/modules/userId.html#user-id-sub-modules">Back to User ID Module</a></p>

<h2>{{ page.title }}</h2>
<table class="table table-bordered table-striped">
<tr>
<th class="pbTh">Module</th>
<td class="pbTd">{{ page.useridmodule }}</td>
</tr>
<tr>
<th class="pbTh">EID Source</th>
<td class="pbTd">{{ page.eidsource }}</td>
</tr>
<tr>
<th class="pbTh">bidRequest.userId</th>
<td class="pbTd">{{ page.bidRequestUserId }}</td>
</tr>
<tr>
<th class="pbTh">Example</th>
<td class="pbTd"><code>{{ page.example }}</code></td>
</tr>
</table>

{{content}}

Expand Down
Binary file modified assets/images/prebid-server/module-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions dev-docs/analytics/yandex.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Disclosure: The adapter utilizes the Metrica Tag build based on [github.com/yand

2. **Insert Counter Initialization Code:**

Retrieve the counter initialization code from the Yandex Metrica settings page at `https://metrica.yandex.com/settings?id={counterId}`, where `{counterId}` is your counter ID, and embed it into your website's HTML.
Retrieve the counter initialization code from the Yandex Metrica settings page at [metrica.yandex.com/r/settings](https://metrica.yandex.com/r/settings), and embed it into your website's HTML.

3. **Initialize the Adapter in Prebid.js:**

Expand All @@ -43,4 +43,4 @@ Disclosure: The adapter utilizes the Metrica Tag build based on [github.com/yand

## Accessing Analytics Data

You can view the collected analytics data in the Yandex Metrica dashboard. Navigate to [metrika.yandex.com/dashboard](https://metrika.yandex.com/dashboard) and look for the Prebid Analytics section to analyze your data.
You can view the collected analytics data in the Yandex Metrica dashboard. Navigate to [metrika.yandex.com/r/stat/prebid_events](https://metrika.yandex.com/r/stat/prebid_events) to analyze your data.
22 changes: 20 additions & 2 deletions dev-docs/bidders/adgrid.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
layout: bidder
title: AdGrid
description: Prebid AdGrid Bidder Adaptor
description: Prebid AdGrid Bidder Adapter
biddercode: adgrid
media_types: banner
media_types: banner, video
pbjs: true
tcfeu_supported: false
dsa_supported: false
Expand Down Expand Up @@ -67,6 +67,24 @@ var adUnits = [
domainId: 67890
}
}]
},
// Video adUnit
{
code: 'test-video-div',
mediaTypes: {
video: {
playerSize: [
[640, 480]
],
context: 'instream'
}
},
bids: [{
bidder: 'adgrid',
params: {
domainId: 12345
}
}]
}
];
```
52 changes: 52 additions & 0 deletions dev-docs/bidders/bidtheatre.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
layout: bidder
title: Bidtheatre
description: Bidtheatre Prebid Bidder Adapter
biddercode: bidtheatre
gvl_id: 30
tcfeu_supported: true
media_types: banner, video
safeframes_ok: true
deals_supported: true
floors_supported: true
fpd_supported: true
ortb_blocking_supported: partial
multiformat_supported: will-bid-on-any
privacy_sandbox: topics
pbjs: true
sidebarType: 1
pbs: false
pbs_app_supported: false
---

### Registration

The Bidtheatre bidding adapter requires manual set up before use. Please contact us at [[email protected]](mailto:[email protected]) if you would like to access Bidtheatre's demand.

### Bid Params

{: .table .table-bordered .table-striped }

| Name | Scope | Description | Example | Type |
|---------------|----------|-----------------------|-----------|-----------|
| `publisherId` | required | Manually set up publisher ID | `'73b20b3a-12a0-4869-b54e-8d42b55786ee'` | `string` |

In addition to the required bid param above, Bidtheatre will also enforce the following requirements

- All ad slots on a page must belong to the same publisher ID
- The publisher must provide either a client IP and/or explicit geo data in the request

### First Party Data

Publishers should use the `ortb2` method of setting First Party Data. All standard OpenRTB 2.5 properties are supported, including but not limited to

- ortb2.site.*
- ortb2.user.*

### ORTB Blocking

`bcat`, `badv` and `battr` are all supported.

### Media Types

All standard OpenRTB 2.5 properties are supported for both banner and video. Bidtheatre Bidding adapter will always return VAST 2.0 or lower for video requests.
3 changes: 2 additions & 1 deletion dev-docs/bidders/copper6ssp.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ title: Copper6SSP
description: Prebid Copper6SSP Bidder Adapter
biddercode: copper6ssp
gpp_sids: usstate_all
tcfeu_supported: false
gvl_id: 1356
tcfeu_supported: true
usp_supported: true
coppa_supported: true
schain_supported: true
Expand Down
64 changes: 14 additions & 50 deletions dev-docs/bidders/equativ.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,20 +35,19 @@ The Equativ bidder adapter requires setup and approval from the Equativ service
{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|------|-------|-------------|---------|------|
| `networkId` | required | The network identifier you have been provided with. _See **Bid Parameter Usage** notes below for more information_. | `1234` | `integer` |
| `siteId` | required | The placement site ID. _See **Bid Parameter Usage** notes below for more information_. |`1234` | `integer` |
| `pageId` | required | The placement page ID. _See **Bid Parameter Usage** notes below for more information_. | `1234` | `integer` |
| `formatId` | required | The placement format ID. _See **Bid Parameter Usage** notes below for more information_. | `1234` | `integer` |
| `networkId` | required | The network identifier you have been provided with. Normally required, but there are certain conditions under which this may be omitted. _See **Bid Parameter Usage** notes below for more information_. | `1234` | `integer` |
| `siteId` | optional | The placement site ID. _See **Bid Parameter Usage** notes below for more information_. |`1234` | `integer` |
| `pageId` | optional | The placement page ID. _See **Bid Parameter Usage** notes below for more information_. | `1234` | `integer` |
| `formatId` | optional | The placement format ID. _See **Bid Parameter Usage** notes below for more information_. | `1234` | `integer` |

#### Bid Parameter Usage

Different combinations of parameters are required depending upon which ones you choose to use.

There are three options for passing bidder parameters:
There are two options for passing parameters:

- **Option 1**. Specify `networkId` by itself (_without_ `siteId`, `pageId` and `formatId`), or
- **Option 2**. Specify `siteId` _and_ `pageId` _and_ `formatId` (all together) _without_ `networkId`, or
- **Option 3**. Specify _none_ of the above parameters, and instead use either `ortb2.site.publisher.id`, `ortb2.app.publisher.id` or `ortb2.dooh.publisher.id`
- **Option 1**. Specify `networkId` by itself (_and optionally providing_ `siteId`, `pageId` and `formatId`), or
- **Option 2**. Specify either `ortb2.site.publisher.id`, `ortb2.app.publisher.id` or `ortb2.dooh.publisher.id`

See **Sample Banner Setup** for examples of these parameter options.

Expand Down Expand Up @@ -93,9 +92,9 @@ pbjs.bidderSettings = {

#### Sample Banner Setup

As mentioned in the **Bid Parameter Usage** section, when including `'equativ'` as one of your available bidders your adunit setup, there are three general approaches to how you can specify parameters. Below are examples that illustrate them.
As mentioned in the **Bid Parameter Usage** section, when including `'equativ'` as one of your available bidders your adunit setup, there are two approaches to how you can specify parameters. Below are examples that illustrate them.

#### Option 1 -- Using networkId as the only bid param
#### Option 1 -- Using networkId as a parameter

```html
<script>
Expand All @@ -113,10 +112,11 @@ As mentioned in the **Bid Parameter Usage** section, when including `'equativ'`
bids: [
{
bidder: 'equativ',
// siteId, pageId and formatId are NOT
// required if networkId is provided instead
params: {
networkId: 42,
networkId: 42, // REQUIRED
siteId: 142, // optional
pageId: 242, // optional
formatId: 342, // optional
},
},
],
Expand All @@ -129,43 +129,7 @@ As mentioned in the **Bid Parameter Usage** section, when including `'equativ'`
</script>
```

#### Option 2 - Using siteId, pageId and formatId as bid params

```html
<script>
var adUnits = [
{
code: 'div-123',
mediaTypes: {
banner: {
sizes: [
[600, 500],
[300, 600],
],
},
},
bids: [
{
bidder: 'equativ',
// all 3 of the below params are required
// when used together in place of networkId
params: {
siteId: 1,
pageId: 2,
formatId: 3,
},
},
],
},
];
pbjs.que.push(function () {
pbjs.addAdUnits(adUnits);
});
</script>
```

#### Option 3 - Using ortb2 for parameter info
#### Option 2 - Using ortb2 for parameter info

You can also, as an alternative to using bidder params, specify a value for `publisher.id` that may be nested under an `app`, `site` or `dooh` object. The Equativ adapter will, in turn, look for these property paths under the `ortb2` property of the request:

Expand Down
Loading

0 comments on commit 77d9144

Please sign in to comment.