Skip to content

Commit eb6d294

Browse files
dev-adverxoabraham-kimiamuuki88
authored
Add new adverxo Bidder alias: alchemyx (prebid#6398)
* Add new adverxo alias: alchemyx * Update dev-docs/bidders/alchemyx.md Co-authored-by: Muki Seiler <muuki88@users.noreply.github.com> * Update dev-docs/bidders/alchemyx.md Co-authored-by: Muki Seiler <muuki88@users.noreply.github.com> * Update dev-docs/bidders/alchemyx.md Co-authored-by: Muki Seiler <muuki88@users.noreply.github.com> --------- Co-authored-by: Abraham <abraham@kimiagroup.com> Co-authored-by: Muki Seiler <muuki88@users.noreply.github.com>
1 parent 5345e8b commit eb6d294

1 file changed

Lines changed: 113 additions & 0 deletions

File tree

dev-docs/bidders/alchemyx.md

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
---
2+
layout: bidder
3+
title: AlchemyX
4+
description: Prebid AlchemyX Bidder Adapter
5+
aliasCode: adverxo
6+
pbjs: true
7+
pbs: false
8+
pbs_app_supported: false
9+
biddercode: alchemyx
10+
media_types: banner, native, video
11+
schain_supported: true
12+
dchain_supported: false
13+
ortb_blocking_supported: true
14+
floors_supported: true
15+
multiformat_supported: will-bid-on-any
16+
tcfeu_supported: false
17+
dsa_supported: false
18+
gvl_id: none
19+
usp_supported: false
20+
coppa_supported: false
21+
gpp_sids: none
22+
userId: none
23+
safeframes_ok: false
24+
deals_supported: true
25+
fpd_supported: true
26+
prebid_member: false
27+
sidebarType: 1
28+
---
29+
30+
### Note
31+
32+
The AlchemyX Bidding adapter requires setup and approval before beginning. Please reach out to <prebid@alchemyx.io> for
33+
more details.
34+
35+
### Bid Params
36+
37+
{: .table .table-bordered .table-striped }
38+
| Name | Scope | Description | Example | Type |
39+
|----------|----------|-----------------------|---------------------------|----------|
40+
| `adUnitId` | required | Unique identifier for the ad unit in AlchemyX platform. | `1` | `integer` |
41+
| `auth` | required | Authentication token provided by AlchemyX platform for the AdUnit. |`'61336e75e414c77c367eq5c47c2599ce80a8032b'` | `string` |
42+
43+
### Setting First Party Data (FPD)
44+
45+
Publishers should use the `ortb2` method of setting First Party Data. The following fields are supported:
46+
47+
- ortb2.site.\*
48+
- ortb2.app.\*
49+
- ortb2.user.\*
50+
51+
Example first party data:
52+
53+
```javascript
54+
pbjs.setConfig({
55+
ortb2: {
56+
site: {
57+
keywords: "kw1,kw2",
58+
content: {
59+
title: "title1",
60+
series: "series1"
61+
}
62+
},
63+
user: {
64+
keywords: "a,b",
65+
gender: "M",
66+
yob: 1984
67+
}
68+
}
69+
});
70+
```
71+
72+
### ORTB Blocking
73+
74+
AlchemyX supports the next blocking parameters:
75+
76+
- Blocked advertisers list (`badv`) is an array of domains as strings.
77+
- Blocked apps list (`bapp`) is an array of apps names as strings, for mobile apps in Google Play Store, these should be
78+
bundle or package names (e.g. com.foo.mygame). For apps in Apple App Store, these should be a numeric ID.
79+
- Blocked categories list (`bcat`) is an array of IAB categories as strings.
80+
- Blocked attributes list (`battr`) is an array of integers. Refer to section 5.3 of the IAB specification for a list of
81+
attributes.
82+
83+
#### Globally defined ORTB Blocking
84+
85+
```javascript
86+
pbjs.setConfig({
87+
ortb2: {
88+
badv: ["domain1.com", "domain2.com"],
89+
bapp: ["com.foo.mygame", "284708449"],
90+
bcat: ["IAB23-1", "IAB23-5", "IAB25-3", "IAB25-2"]
91+
}
92+
});
93+
```
94+
95+
#### ORTB Blocking specific only to the AlchemyX bidder
96+
97+
```javascript
98+
pbjs.setBidderConfig({
99+
bidders: ['alchemyx'],
100+
config: {
101+
ortb2: {
102+
badv: ["domain1.com", "domain2.com"],
103+
bapp: ["com.foo.mygame"],
104+
bcat: ["IAB23-1", "IAB23-5", "IAB25-3", "IAB25-2"]
105+
}
106+
}
107+
});
108+
```
109+
110+
#### Media Type defined ORTB Blocking
111+
112+
Additionally `battr` ORTB blocking param may be set on media types to specify blocked creative
113+
attributes. Refer to section 5.3 of the IAB specification for a list of attributes.

0 commit comments

Comments
 (0)