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.

Sign up for GitHub

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

adform.md docs updated #2262

Merged
merged 2 commits into from
Aug 26, 2020
Merged

adform.md docs updated #2262

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9f584a5
adform supported params described
braizhas Aug 21, 2020
c6b1f06
note about csv format
braizhas Aug 25, 2020
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
32 changes: 28 additions & 4 deletions dev-docs/bidders/adform.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,31 @@ userIds: britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrable
### Bid Params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|-------------|----------|-------------------|--------------------|-----------|
| `mid` | required | | `12345` | `integer` |
| `adxDomain` | optional | The Adform domain | `'adx.adform.net'` | `string` |
| Name | Scope | Description | Example | Type |
|-------------|----------|-----------------------------------------------|----------------------------|-----------|
| `mid` | required | | `12345` | `integer` |
| `adxDomain` | optional | The Adform domain | `'adx.adform.net'` | `string` |
| `priceType` | optional | An expected price type (net or gross) of bids | `'net'` | `string` |
| `mkv` | optional | Comma-separated key-value pairs | `'city:NY'` | `string` |
| `mkw` | optional | Comma-separated keywords | `'news,sport'` | `string` |
| `minp` | optional | Minimum CPM price | `2.55` | `number` |
| `cdims` | optional | Comma-separated creative dimentions | `'300x250'` | `string` |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The validation does not allow for spaces to exist between in the CSV list, such like 300x250, 1x1. Can you please make that clear in this doc?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it the right place for such a note? c6b1f06

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think so? @bretg does this look good to you?

| `url` | optional | Custom targeting URL | `'https://some.app/?home'` | `string` |

Note: Spaces are not allowed between comma-separated list values. For example:
```
// valid params
{
mid: 12345,
mkv: 'city:NY,city:London',
mkv: 'news,sport',
cdims: '300x250,250x300'
}
// invalid params
{
mid: 12345,
mkv: 'city:NY, city:London',
mkv: 'news, sport',
cdims: '300x250, 250x300'
}
```