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

AMX RTB: Separate documentation for amx/amx-server #4419

Merged
merged 1 commit into from
Mar 17, 2023
Merged
Show file tree
Hide file tree
Changes from all 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
80 changes: 80 additions & 0 deletions dev-docs/bidders/amx-server.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
---
layout: bidder
title: AMX RTB
description: AMX RTB Bid Adapter
hide: true
schain_supported: true
gdpr_supported: true
usp_supported: true
coppa_supported: true
userIds: all
biddercode: amx
safeframes_ok: true
media_types: banner, video, native
pbjs: false
pbs: true
pbs_app_supported: true
fpd_supported: true
multiformat_supported: true
gpp_supported: true
gvl_id: 737
sidebarType: 1
---

### Bid Params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|-------------|----------|-----------------------------------------------------------------|---------------------------------|----------|
| `tagId` | required | Tag ID | `'cHJlYmlkLm9yZw'` | `string` |
| `testMode` | optional | Activate 100% fill ads | `true` | `boolean`|
| `adUnitId` | optional | Ad Unit ID used in reporting. Will default to `bid.adUnitCode` | `'sticky_banner'` | `string` |

### Test Parameters

To enable 100% fill test ads, you can use the following `params`:

```javascript
{
testMode: true,
tagId: "cHJlYmlkLm9yZw"
}
```

This will produce a bid at $10 with a test creative.

Note that the `tagId` is case-sensitive. Do not use `cHJlYmlkLm9yZw` in production environments: this ID is for testing only.

### First Party Data

From Prebid.js >= 4.30, publishers can use the `ortb2` configuration parameter to provide First Party Data. We accept all standard OpenRTB fields for both:

- `ortb2.site`
- `ortb2.user`

Note that all fields are optional. For contextual data (e.g. categories), standard IAB taxonomies are supported. We do not support passing first party data via bid parameters.

#### Example - Setting ortb2.site and ortb2.user fields

```javascript
pbjs.setBidderConfig({
bidders: ["amx"],
config: {
ortb2: {
site: {
keywords: "kw1,kw2",
cat: ["IAB2"],
sectioncat: ["IAB2-1"],
pagecat: ["IAB2-22"],
content: {
context: 5
}
},
user: {
yob: 1981,
keywords: "kw3",
}
}
}
})
```
10 changes: 5 additions & 5 deletions dev-docs/bidders/amx.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
---
layout: bidder
title: AMX RTB
description: AMX RTB Prebid Bid Adapter
description: AMX RTB Bid Adapter
hide: true
schain_supported: true
gdpr_supported: true
usp_supported: true
coppa_supported: true
userIds: britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId, amxId
userIds: all
biddercode: amx
safeframes_ok: true
media_types: banner, video, native
media_types: banner, video
pbjs: true
pbs: true
pbs_app_supported: true
pbs: false
fpd_supported: true
gpp_supported: true
multiformat_supported: true
gvl_id: 737
sidebarType: 1
---
Expand Down