From 728ae173fdd6d837339a9711801f19a9b2145a3b Mon Sep 17 00:00:00 2001 From: John Salis Date: Fri, 17 Jun 2022 13:41:34 -0400 Subject: [PATCH] Add first-party data support to Beachfront doc (#3853) * update beachfront doc * update * update * update Co-authored-by: John Salis --- dev-docs/bidders/beachfront.md | 78 +++++++++++++++++++++++----------- 1 file changed, 54 insertions(+), 24 deletions(-) diff --git a/dev-docs/bidders/beachfront.md b/dev-docs/bidders/beachfront.md index c5fa950895..80e24b0f08 100644 --- a/dev-docs/bidders/beachfront.md +++ b/dev-docs/bidders/beachfront.md @@ -5,6 +5,7 @@ description: Prebid Beachfront Bidder Adapter biddercode: beachfront media_types: video floors_supported: true +fpd_supported: true gdpr_supported: true usp_supported: true userIds: unifiedId, identityLink, uid2, hadronId @@ -26,56 +27,85 @@ For further information, please contact adops@beachfront.com. ### Bid Params {: .table .table-bordered .table-striped } -| Name | Scope | Description | Example | Type | +| Name | Scope | Description | Example | Type | |------------|----------|---------------------------------------------------------------------------------------------|------------------------------------------|----------| -| `appId` | required | Beachfront Exchange ID | `'11bc5dd5-7421-4dd8-c926-40fa653bec76'` | `string` | -| `bidfloor` | required | Bid floor | `0.01` | `float` | -| `video` | optional | Object with video parameters. See the [video section below](#beachfront-video) for details. | | `object` | -| `banner` | optional | Object with banner parameters. See the [banner section below](#beachfront-banner) for details. | | `object` | -| `player` | optional | Object with outstream player parameters. See the [player section below](#beachfront-player) for details. | | `object` | +| `appId` | required | Beachfront Exchange ID | `'11bc5dd5-7421-4dd8-c926-40fa653bec76'` | `string` | +| `bidfloor` | required | Bid floor | `0.01` | `float` | +| `video` | optional | Object with video parameters. See the [video section below](#beachfront-video) for details. | | `object` | +| `banner` | optional | Object with banner parameters. See the [banner section below](#beachfront-banner) for details. | | `object` | +| `player` | optional | Object with outstream player parameters. See the [player section below](#beachfront-player) for details. | | `object` | -### video params +#### video params {: .table .table-bordered .table-striped } -| Name | Scope | Description | Example | Type | +| Name | Scope | Description | Example | Type | |------------------|----------|------------------------------------------------|-------------------------------------------|-----------------| -| `appId` | optional | Beachfront Exchange ID for video bids. | `'11bc5dd5-7421-4dd8-c926-40fa653bec76'` | `string` | -| `bidfloor` | optional | Bid floor for video bids. | `0.01` | `float` | -| `tagid` | optional | Tag ID | `'placement-name'` | `string` | -| `responseType` | optional | Video response type.
`both`: VAST URL and VAST XML
`nurl`: VAST URL only
`adm`: VAST XML only | `'both'` | `string` | -| `mimes` | optional | Array of strings listing supported MIME types. | `["video/mp4", "application/javascript"]` | `Array` | +| `appId` | optional | Beachfront Exchange ID for video bids. | `'11bc5dd5-7421-4dd8-c926-40fa653bec76'` | `string` | +| `bidfloor` | optional | Bid floor for video bids. | `0.01` | `float` | +| `tagid` | optional | Tag ID | `'placement-name'` | `string` | +| `responseType` | optional | Video response type.
`both`: VAST URL and VAST XML
`nurl`: VAST URL only
`adm`: VAST XML only | `'both'` | `string` | +| `mimes` | optional | Array of strings listing supported MIME types. | `["video/mp4", "application/javascript"]` | `Array` | | `playbackmethod` | optional | Playback method supported by the publisher.
`1`: Auto-play sound on
`2`: Auto-play sound off
`3`: Click-to-play
`4`: Mouse-over | `1` | `integer` | -| `maxduration` | optional | Maximum video ad duration in seconds. | `30` | `integer` | -| `placement` | optional | Placement type for the impression.
`1`: In-Stream
`2`: In-Banner
`3`: In-Article
`4`: In-Feed
`5`: Interstitial/Slider/Floating | `1` | `integer` | -| `skip` | optional | Indicates if the player will allow the video to be skipped. | `1` | `integer` | -| `skipmin` | optional | Videos of total duration greater than this number of seconds can be skippable. | `15` | `integer` | -| `skipafter` | optional | Number of seconds a video must play before skipping is enabled. | `5` | `integer` | +| `maxduration` | optional | Maximum video ad duration in seconds. | `30` | `integer` | +| `placement` | optional | Placement type for the impression.
`1`: In-Stream
`2`: In-Banner
`3`: In-Article
`4`: In-Feed
`5`: Interstitial/Slider/Floating | `1` | `integer` | +| `skip` | optional | Indicates if the player will allow the video to be skipped. | `1` | `integer` | +| `skipmin` | optional | Videos of total duration greater than this number of seconds can be skippable. | `15` | `integer` | +| `skipafter` | optional | Number of seconds a video must play before skipping is enabled. | `5` | `integer` | -### banner params +#### banner params {: .table .table-bordered .table-striped } -| Name | Scope | Description | Example | Type | +| Name | Scope | Description | Example | Type | |------------|----------|-----------------------------------------|------------------------------------------|----------| -| `appId` | optional | Beachfront Exchange ID for banner bids. | `'3b16770b-17af-4d22-daff-9606bdf2c9c3'` | `string` | +| `appId` | optional | Beachfront Exchange ID for banner bids. | `'3b16770b-17af-4d22-daff-9606bdf2c9c3'` | `string` | | `bidfloor` | optional | Bid floor for banner bids. | `0.01` | `float` | -| `tagid` | optional | Tag ID | `'placement-name'` | `string` | +| `tagid` | optional | Tag ID | `'placement-name'` | `string` | -### player params +#### player params {: .table .table-bordered .table-striped } -| Name | Scope | Description | Example | Type | +| Name | Scope | Description | Example | Type | |------------|----------|-----------------------------------------|------------------------------------------|----------| | `progressColor` | optional | The color of the progress bar formatted as a CSS value. | `'#50A8FA'` | `string` | | `adPosterColor` | optional | The color of the ad poster formatted as a CSS value. | `'#FFFFFF'` | `string` | | `expandInView` | optional | Defines whether to expand the player when the ad slot is in view. Defaults to `false`. | `false` | `boolean` | | `collapseOnComplete` | optional | Defines whether to collapse the player when ad playback has completed. Defaults to `true`. | `true` | `boolean` | +### First Party Data + +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 that's available to all bidders and all adunits: + +``` +pbjs.setConfig({ + ortb2: { + site: { + keywords: "kw1,kw2", + content: { + title: "title1", + series: "series1" + } + }, + user: { + keywords: "a,b", + gender: "M", + yob: 1984 + } + } +}); +``` + ### Prebid Server As seen in the JSON response from \{your PBS server\}\/bidder\/params [(example)](https://prebid.adnxs.com/pbs/v1/bidders/params), the beachfront