Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New bid adapter: Adverxo #5676

Merged
merged 7 commits into from
Dec 12, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 116 additions & 0 deletions dev-docs/bidders/adport.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
---
layout: bidder
title: AdPort
description: Prebid AdPort Bidder Adapter
aliasCode: adverxo
pbjs: true
muuki88 marked this conversation as resolved.
Show resolved Hide resolved
pbs: true
pbs_app_supported: true
biddercode: adport
userIds:
media_types: banner, native, video
schain_supported: true
dchain_supported: false
ortb_blocking_supported: true
floors_supported: true
multiformat_supported: will-bid-on-any
tcfeu_supported: false
dsa_supported: false
gvl_id: none
usp_supported: false
coppa_supported: false
gpp_sids: none
userId: no
safeframes_ok: false
deals_supported: true
fpd_supported: true
prebid_member: false
privacy_sandbox: no
sidebarType: 1
---

### Note

The AdPort Bidding adapter requires setup and approval before beginning. Please reach out to <[email protected]> for
more details.

### Bid Params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|----------|----------|-----------------------|---------------------------|----------|
| `adUnitId` | required | Unique identifier for the ad unit in AdPort platform. | `1` | `integer` |
| `auth` | required | Authentication token provided by AdPort platform for the AdUnit. |

Check failure on line 43 in dev-docs/bidders/adport.md

View workflow job for this annotation

GitHub Actions / run markdownlint

Table column count

dev-docs/bidders/adport.md:43:94 MD056/table-column-count Table column count [Expected: 5; Actual: 3; Too few cells, row will be missing data] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md056.md
`'61336e75e414c77c367eq5c47c2599ce80a8032b'` | `string` |

Check failure on line 44 in dev-docs/bidders/adport.md

View workflow job for this annotation

GitHub Actions / run markdownlint

Table pipe style

dev-docs/bidders/adport.md:44:1 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: trailing_only; Missing leading pipe] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md055.md

Check failure on line 44 in dev-docs/bidders/adport.md

View workflow job for this annotation

GitHub Actions / run markdownlint

Table column count

dev-docs/bidders/adport.md:44:57 MD056/table-column-count Table column count [Expected: 5; Actual: 2; Too few cells, row will be missing data] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md056.md

### Setting First Party Data (FPD)

Publishers should use the `ortb2` method of setting First Party Data. The following fields are supported:

- ortb2.site.\*
- ortb2.app.\*
- ortb2.user.\*

Example first party data:

```javascript
pbjs.setConfig({
ortb2: {
site: {
keywords: "kw1,kw2",
content: {
title: "title1",
series: "series1"
}
},
user: {
keywords: "a,b",
gender: "M",
yob: 1984
}
}
});
```

### ORTB Blocking

AdPort supports the next blocking parameters:

- Blocked advertisers list (`badv`) is an array of domains as strings.
- Blocked apps list (`bapp`) is an array of apps names as strings, for mobile apps in Google Play Store, these should be
bundle or package names (e.g. com.foo.mygame). For apps in Apple App Store, these should be a numeric ID.
- Blocked categories list (`bcat`) is an array of IAB categories as strings.
- Blocked attributes list (`battr`) is an array of integers. Refer to section 5.3 of the IAB specification for a list of
attributes.

#### Globally defined ORTB Blocking

```javascript
pbjs.setConfig({
ortb2: {
badv: ["domain1.com", "domain2.com"],
bapp: ["com.foo.mygame", "284708449"],
bcat: ["IAB23-1", "IAB23-5", "IAB25-3", "IAB25-2"]
}
});
```

#### ORTB Blocking specific only to the AdPort bidder

```javascript
pbjs.setBidderConfig({
bidders: ['adport'], // Or alias
config: {
ortb2: {
badv: ["domain1.com", "domain2.com"],
bapp: ["com.foo.mygame"],
bcat: ["IAB23-1", "IAB23-5", "IAB25-3", "IAB25-2"]
}
}
});
```

#### Media Type defined ORTB Blocking

Additionally `battr` ORTB blocking param may be set on media types to specify blocked creative
attributes. Refer to section 5.3 of the IAB specification for a list of attributes.

Check failure on line 116 in dev-docs/bidders/adport.md

View workflow job for this annotation

GitHub Actions / run markdownlint

Files should end with a single newline character

dev-docs/bidders/adport.md:116:83 MD047/single-trailing-newline Files should end with a single newline character https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md047.md
116 changes: 116 additions & 0 deletions dev-docs/bidders/adverxo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
---
layout: bidder
title: Adverxo
description: Prebid Adverxo Bidder Adapter
pbjs: true
pbs: true
pbs_app_supported: true
biddercode: adverxo
userIds:
media_types: banner, native, video
schain_supported: true
dchain_supported: false
ortb_blocking_supported: true
floors_supported: true
multiformat_supported: will-bid-on-any
tcfeu_supported: false
dsa_supported: false
gvl_id: none
usp_supported: false
coppa_supported: false
gpp_sids: none
userId: no
safeframes_ok: false
deals_supported: true
fpd_supported: true
prebid_member: false
privacy_sandbox: no
sidebarType: 1
---

### Note

The Adverxo Bidding adapter requires setup and approval before beginning. Please reach out to <[email protected]> for
more details.

### Bid Params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|----------|----------|-----------------------|---------------------------|----------|
| `host` | optional | Ad network host | `'js.pbsadverxo.com'` | `string` |
| `adUnitId` | required | Unique identifier for the ad unit in Adverxo platform. | `1` | `integer` |
| `auth` | required | Authentication token provided by Adverxo platform for the AdUnit. |

Check failure on line 43 in dev-docs/bidders/adverxo.md

View workflow job for this annotation

GitHub Actions / run markdownlint

Table column count

dev-docs/bidders/adverxo.md:43:95 MD056/table-column-count Table column count [Expected: 5; Actual: 3; Too few cells, row will be missing data] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md056.md
`'61336e75e414c77c367eq5c47c2599ce80a8032b'` | `string` |

Check failure on line 44 in dev-docs/bidders/adverxo.md

View workflow job for this annotation

GitHub Actions / run markdownlint

Table pipe style

dev-docs/bidders/adverxo.md:44:1 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: trailing_only; Missing leading pipe] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md055.md

Check failure on line 44 in dev-docs/bidders/adverxo.md

View workflow job for this annotation

GitHub Actions / run markdownlint

Table column count

dev-docs/bidders/adverxo.md:44:57 MD056/table-column-count Table column count [Expected: 5; Actual: 2; Too few cells, row will be missing data] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md056.md

### Setting First Party Data (FPD)

Publishers should use the `ortb2` method of setting First Party Data. The following fields are supported:

- ortb2.site.\*
- ortb2.app.\*
- ortb2.user.\*

Example first party data:

```javascript
pbjs.setConfig({
ortb2: {
site: {
keywords: "kw1,kw2",
content: {
title: "title1",
series: "series1"
}
},
user: {
keywords: "a,b",
gender: "M",
yob: 1984
}
}
});
```

### ORTB Blocking

Adverxo supports the next blocking parameters:

- Blocked advertisers list (`badv`) is an array of domains as strings.
- Blocked apps list (`bapp`) is an array of apps names as strings, for mobile apps in Google Play Store, these should be
bundle or package names (e.g. com.foo.mygame). For apps in Apple App Store, these should be a numeric ID.
- Blocked categories list (`bcat`) is an array of IAB categories as strings.
- Blocked attributes list (`battr`) is an array of integers. Refer to section 5.3 of the IAB specification for a list of
attributes.

#### Globally defined ORTB Blocking

```javascript
pbjs.setConfig({
ortb2: {
badv: ["domain1.com", "domain2.com"],
bapp: ["com.foo.mygame", "284708449"],
bcat: ["IAB23-1", "IAB23-5", "IAB25-3", "IAB25-2"]
}
});
```

#### ORTB Blocking specific only to the Adverxo bidder

```javascript
pbjs.setBidderConfig({
bidders: ['adverxo'], // Or alias
config: {
ortb2: {
badv: ["domain1.com", "domain2.com"],
bapp: ["com.foo.mygame"],
bcat: ["IAB23-1", "IAB23-5", "IAB25-3", "IAB25-2"]
}
}
});
```

#### Media Type defined ORTB Blocking

Additionally `battr` ORTB blocking param may be set on media types to specify blocked creative
attributes. Refer to section 5.3 of the IAB specification for a list of attributes.

Check failure on line 116 in dev-docs/bidders/adverxo.md

View workflow job for this annotation

GitHub Actions / run markdownlint

Files should end with a single newline character

dev-docs/bidders/adverxo.md:116:83 MD047/single-trailing-newline Files should end with a single newline character https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md047.md
116 changes: 116 additions & 0 deletions dev-docs/bidders/bidsmind.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
---
layout: bidder
title: Bidsmind
description: Prebid Bidsmind Bidder Adapter
aliasCode: adverxo
pbjs: true
pbs: true
pbs_app_supported: true
biddercode: bidsmind
userIds:
media_types: banner, native, video
schain_supported: true
dchain_supported: false
ortb_blocking_supported: true
floors_supported: true
multiformat_supported: will-bid-on-any
tcfeu_supported: false
dsa_supported: false
gvl_id: none
usp_supported: false
coppa_supported: false
gpp_sids: none
userId: no
safeframes_ok: false
deals_supported: true
fpd_supported: true
prebid_member: false
privacy_sandbox: no
sidebarType: 1
---

### Note

The Bidsmind Bidding adapter requires setup and approval before beginning. Please reach out to <[email protected]> for
more details.

### Bid Params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|----------|----------|-----------------------|---------------------------|----------|
| `adUnitId` | required | Unique identifier for the ad unit in Bidsmind platform. | `1` | `integer` |
| `auth` | required | Authentication token provided by Bidsmind platform for the AdUnit. |

Check failure on line 43 in dev-docs/bidders/bidsmind.md

View workflow job for this annotation

GitHub Actions / run markdownlint

Table column count

dev-docs/bidders/bidsmind.md:43:96 MD056/table-column-count Table column count [Expected: 5; Actual: 3; Too few cells, row will be missing data] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md056.md
`'61336e75e414c77c367eq5c47c2599ce80a8032b'` | `string` |

Check failure on line 44 in dev-docs/bidders/bidsmind.md

View workflow job for this annotation

GitHub Actions / run markdownlint

Table pipe style

dev-docs/bidders/bidsmind.md:44:1 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: trailing_only; Missing leading pipe] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md055.md

### Setting First Party Data (FPD)

Publishers should use the `ortb2` method of setting First Party Data. The following fields are supported:

- ortb2.site.\*
- ortb2.app.\*
- ortb2.user.\*

Example first party data:

```javascript
pbjs.setConfig({
ortb2: {
site: {
keywords: "kw1,kw2",
content: {
title: "title1",
series: "series1"
}
},
user: {
keywords: "a,b",
gender: "M",
yob: 1984
}
}
});
```

### ORTB Blocking

Bidsmind supports the next blocking parameters:

- Blocked advertisers list (`badv`) is an array of domains as strings.
- Blocked apps list (`bapp`) is an array of apps names as strings, for mobile apps in Google Play Store, these should be
bundle or package names (e.g. com.foo.mygame). For apps in Apple App Store, these should be a numeric ID.
- Blocked categories list (`bcat`) is an array of IAB categories as strings.
- Blocked attributes list (`battr`) is an array of integers. Refer to section 5.3 of the IAB specification for a list of
attributes.

#### Globally defined ORTB Blocking

```javascript
pbjs.setConfig({
ortb2: {
badv: ["domain1.com", "domain2.com"],
bapp: ["com.foo.mygame", "284708449"],
bcat: ["IAB23-1", "IAB23-5", "IAB25-3", "IAB25-2"]
}
});
```

#### ORTB Blocking specific only to the Bidsmind bidder

```javascript
pbjs.setBidderConfig({
bidders: ['bidsmind'], // Or alias
config: {
ortb2: {
badv: ["domain1.com", "domain2.com"],
bapp: ["com.foo.mygame"],
bcat: ["IAB23-1", "IAB23-5", "IAB25-3", "IAB25-2"]
}
}
});
```

#### Media Type defined ORTB Blocking

Additionally `battr` ORTB blocking param may be set on media types to specify blocked creative
attributes. Refer to section 5.3 of the IAB specification for a list of attributes.