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

Jump to bottom

Update documentation on the specific parameters required by the ResetDigital adapter for supported bidders. #5508

Merged
merged 7 commits into from
Jul 18, 2024
Merged

Update documentation on the specific parameters required by the ResetDigital adapter for supported bidders. #5508

Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
0ff799c
Update resetdigital.md
javimartos Jul 17, 2024
40fd1ec
Update resetdigital.md
javimartos Jul 17, 2024
40817e9
Update resetdigital.md
javimartos Jul 17, 2024
152645d
Update resetdigital.md
javimartos Jul 17, 2024
e026a78
Merge branch 'master' into master
javimartos Jul 17, 2024
35a3238
Update resetdigital.md
javimartos Jul 17, 2024
0296e34
Update resetdigital.md
javimartos Jul 18, 2024
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
94 changes: 84 additions & 10 deletions dev-docs/bidders/resetdigital.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,30 +20,37 @@ media_types: banner, video
sidebarType: 1
---

### bid params
### Note

Prebid adapter for Reset Digital requires approval and account setup. Video is supported but requires a publisher supplied renderer at this time.
bretg marked this conversation as resolved.
Show resolved Hide resolved

### Bid Params

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

| Name | Scope | Description | Example | Type |
|----------|----------|-------------|------------------------------------|----------|
| `pubId` | required | Publisher account id | `'123pubId'` | `string` |
| `siteID` | optional | Publisher site id | `'123siteId'` | `string` |
| `pubId` | required | Publisher Account ID provided by ResetDigital | `'123pubId'` | `string` |
| `siteID` | optional | Publisher Site ID | `'123siteId'` | `string` |
| `zoneId` | optional | Used for extra fields | `{}` | `object` |
| `zoneId.placementId` | optional | ID used for reporting purposes | `"<id>"` | `string` |
bretg marked this conversation as resolved.
Show resolved Hide resolved
| `zoneId.deals` | optional | Deal IDs comma-separated | `"deal123,deal456"` | `string` |
| `zoneId.test` | optional | Flag to force bidder response with a creative | `1` | `integer` |
| `forceBid` | optional | Returns test bid | true | `boolean` |
| `position` | optional | Set the page position. Valid values are "atf" and "btf". | `'atf'` | `string` |
| `bidFloor` | optional | Sets the global floor -- no bids will be made under this value. | `0.50` | `float` |
| `latLong` | optional | Sets the latitude and longitude for the visitor | `[40.7608, 111.8910]` | `Array<float>` |
| `inventory` | optional | This parameter allows the definition of an object defining arbitrary key-value pairs concerning the page for use in targeting. The values must be arrays of strings. | `{"rating":["5-star"], "prodtype":["tech","mobile"]}` | `object` |
| `visitor` | optional | This parameter allows the definition of an object defining arbitrary key-value pairs concerning the visitor for use in targeting. The values must be arrays of strings. | `{"ucat":["new"], "search":["iphone"]}` | `object` |
| `keywords` | optional | This can be used to influence reports for client-side display. To get video or server-side reporting, please use First Party data or the inventory/visitor parameters. | `["travel", "tourism"]` | `Array<string>` |
| `position` | optional | Set the page position. Valid values are "atf" and "btf".| `'atf'`| `string` |
bretg marked this conversation as resolved.
Show resolved Hide resolved
| `bidFloor` | optional | Sets the global floor -- no bids will be made under this value.| `0.50`| `float` |
| `latLong` | optional | Sets the latitude and longitude for the visitor| `[40.7608, 111.8910]`| `Array<float>` |
| `inventory` | optional | This parameter allows the definition of an object defining arbitrary key-value pairs concerning the page for use in targeting. The values must be arrays of strings. | `{"rating":["5-star"], "prodtype":["tech","mobile"]}` | `object` |
| `visitor` | optional | This parameter allows the definition of an object defining arbitrary key-value pairs concerning the visitor for use in targeting. The values must be arrays of strings. | `{"ucat":["new"], "search":["iphone"]}` | `object` |
| `keywords` | optional | This can be used to influence reports for client-side display. To get video or server-side reporting, please use First Party data or the inventory/visitor parameters. | `["travel", "tourism"]` | `Array<string>` |

#### mediaTypes.video

The following video parameters are supported here so publishers may fully declare their video inventory:

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

| Name | Scope | Description | Example | Type |
| Name | Scope | Description | Example | Type |
|----------------|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|-----------|
| context | required | instream or outstream |"outstream" | string |
| playerSize| required | width, height of the player in pixels | [640,360] - will be translated to w and h in bid request | array<integers> |
Expand All @@ -60,3 +67,70 @@ The following video parameters are supported here so publishers may fully declar
| maxbitrate | optional | Maximum bit rate in Kbps. | 9600 | integer |
| startdelay | recommended | Indicates the start delay in seconds for pre-roll, mid-roll, or post-roll ad placements.<br /> >0: Mid-Roll (value indicates start delay in second)<br /> 0: Pre-Roll<br />-1: Generic Mid-Roll<br />-2: Generic Post-Roll | 0 | integer |
| placement | recommended | Placement type for the impression. (see openRTB v2.5 section 5.9 for options) | 1 | integer |

### Code Examples

#### Banner Ad Unit

Define the ad units for banner ads:

```javascript
var adUnits = [
{
code: 'your-div', // Replace with the actual ad unit code``
mediaTypes: {
banner: {
sizes: [[300, 250]] // Define the sizes for banner ads
}
},
bids: [
{
bidder: "resetdigital",
params: {
pubId: "your-pub-id", // Replace with your publisher ID
siteID: "your-site-id", // Replace with your site ID
endpoint: 'https://ads.resetsrv.com', // Optional: Endpoint URL for the ad server
forceBid: true, // Optional parameter to force the bid
zoneId: {
placementId: "abc123", // Optional ID used for reports
deals: "deal123,deal456", // Optional string of deal IDs, comma-separated
test: 1 // Set to 1 to force the bidder to respond with a creative
}
}
}
]
}
];
```

#### Video Ad Unit

Define the ad units for video ads

```javascript
var videoAdUnits = [
{
code: 'your-div', // Replace with the actual video ad unit code
mediaTypes: {
video: {
playerSize: [640, 480] // Define the player size for video ads
}
},
bids: [
{
bidder: "resetdigital",
params: {
pubId: "your-pub-id", // (required) Replace with your publisher ID
site_id: "your-site-id", // Replace with your site ID
forceBid: true, // Optional parameter to force the bid
zoneId: { // (optional) Zone ID parameters
placementId: "<id>", // Optional ID used for reports
deals: "<deal ids>", // Optional string of deal IDs, comma-separated
test: 1 // Set to 1 to force the bidder to respond with a creative
}
}
}
]
}
];
```