From 76337917e4572a22152ba6a1a526e7a463b35f91 Mon Sep 17 00:00:00 2001 From: Jeff Mahoney Date: Mon, 4 Nov 2024 18:10:43 -0500 Subject: [PATCH 01/12] SADR-6590: initial documentation for Equativ JS bid adapter --- dev-docs/bidders/equativ.md | 77 +++++++++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 dev-docs/bidders/equativ.md diff --git a/dev-docs/bidders/equativ.md b/dev-docs/bidders/equativ.md new file mode 100644 index 0000000000..e9fb3704ae --- /dev/null +++ b/dev-docs/bidders/equativ.md @@ -0,0 +1,77 @@ +--- +layout: bidder +title: Equativ +description: Prebid Equativ Bidder Adapter +biddercode: equativ +media_types: display +tcfeu_supported: true +gvl_id: 45 +tcfeu_supported: true +gpp_supported: true +schain_supported: true +usp_supported: true +userIds: all +pbjs: true +pbs: false +floors_supported: true +sidebarType: 1 +--- + +### Registration + +The Equativ bidder adapter requires setup and approval from the Equativ (former Smart AdServer) service team. Please reach out to your account manager for more information and start using it. + +### Bid params + +{: .table .table-bordered .table-striped } +| Name | Scope | Description | Example | Type | +|------|-------|-------------|---------|------| +| `networkId` | required for Prebid Server | The network identifier you have been provided with. **Note**: the `Equativ` bid adapter currently only supports client-side implementations. | `1234` | `integer` | +| `siteId` | required for Prebid.js | The placement site ID |`1234` | `integer` | +| `pageId` | required for Prebid.js | The placement page ID | `1234` | `integer` | +| `formatId` | required for Prebid.js | The placement format ID | `1234` | `integer` | +| `domain` | optional | The network domain (default see example) | `'http://prg.smartadserver.com', 'https://prg.smartadserver.com'` | `string` | +| `target` | optional | The keyword targeting | `'sport=tennis'` | `string` | +| `bidfloor` | optional | Bid floor for this placement in USD or in the currency specified by the `currency` parameter. (Default: `0.0`) | `0.42` | `float` | +| `appName` | optional | Mobile application name | `'Smart AdServer Preview'` | `string` | +| `buId` | optional | Mobile application bundle ID | `'com.smartadserver.android.dashboard'` | `string` | +| `ckId` | optional | Unique Smart AdServer user ID | `1234567890123456789` | `integer` | +| `video` | optional | Parameter object for instream video. See [video Object](#smartadserver-video-object) | `{}` | `object` | +| `schain` | optional | Supply Chain | `'1.0,1!exchange1.com,1234,1,bid-request-1,publisher,publisher.com'` | `string` | + +**Note:** The site, page and format identifiers have to all be provided (for Prebid.js). + +### Supported Media Types (Prebid.js) + +{: .table .table-bordered .table-striped } +| Type | Support | +|---|---| +| `banner` | Supported | +| `video` | Not currently supported | +| `native` | Not currently supported | + +### Example + +With site/page/format: + +```json + "imp": [{ + "id": "some-impression-id", + "banner": { + "format": [{ + "w": 600, + "h": 500 + }, { + "w": 300, + "h": 600 + }] + }, + "ext": { + "smartadserver": { + "siteId": 1, + "pageId": 2, + "formatId": 3 + } + } + }] +``` From 282ec599bcb7d962d872f8fef6fea76c419b17ac Mon Sep 17 00:00:00 2001 From: Jeff Mahoney Date: Tue, 5 Nov 2024 10:21:26 -0500 Subject: [PATCH 02/12] SADR-6590: doc refinements --- dev-docs/bidders/equativ.md | 86 +++++++++++++++++++++++++++---------- 1 file changed, 63 insertions(+), 23 deletions(-) diff --git a/dev-docs/bidders/equativ.md b/dev-docs/bidders/equativ.md index e9fb3704ae..bc2cc4747e 100644 --- a/dev-docs/bidders/equativ.md +++ b/dev-docs/bidders/equativ.md @@ -50,28 +50,68 @@ The Equativ bidder adapter requires setup and approval from the Equativ (former | `video` | Not currently supported | | `native` | Not currently supported | -### Example - -With site/page/format: - -```json - "imp": [{ - "id": "some-impression-id", - "banner": { - "format": [{ - "w": 600, - "h": 500 - }, { - "w": 300, - "h": 600 - }] +### User Syncing + +To enable cookie syncing, publishers should make sure their configuration setup is properly invoked. + +This involves adding an entry for `setConfig()` that allows user syncing for iframes with `'equativ'` included as a bidder: + +```js +pbjs.setConfig({ + userSync: { + filterSettings: { + iframe: { + bidders: ['equativ'], + }, }, - "ext": { - "smartadserver": { - "siteId": 1, - "pageId": 2, - "formatId": 3 - } - } - }] + }, +}); +``` + +And also making sure that storage is enabled for `equativ`: + +```js +pbjs.bidderSettings = { + equativ: { + storageAllowed: true, + }, +}; +``` + +### Configuration Example + +#### Sample Banner Setup + +When including `'equativ'` as one of your available bidders your adunit setup, be sure to include `siteId`, `pageId` and `formatId` as bid parameters, as shown in the example below. + +```html + ``` From 2fd38e655b589eafd4102777e0991e18f6640d4a Mon Sep 17 00:00:00 2001 From: Jeff Mahoney Date: Wed, 6 Nov 2024 17:49:08 -0500 Subject: [PATCH 03/12] Update equativ.md SADR-6590: adjustments to doc from review feedback. --- dev-docs/bidders/equativ.md | 134 ++++++++++++++++++++++++++++++------ 1 file changed, 112 insertions(+), 22 deletions(-) diff --git a/dev-docs/bidders/equativ.md b/dev-docs/bidders/equativ.md index bc2cc4747e..cc332070f9 100644 --- a/dev-docs/bidders/equativ.md +++ b/dev-docs/bidders/equativ.md @@ -3,45 +3,45 @@ layout: bidder title: Equativ description: Prebid Equativ Bidder Adapter biddercode: equativ -media_types: display +media_types: banner tcfeu_supported: true +coppa_supported: true gvl_id: 45 -tcfeu_supported: true gpp_supported: true schain_supported: true usp_supported: true userIds: all pbjs: true -pbs: false +pbs: true floors_supported: true sidebarType: 1 --- ### Registration -The Equativ bidder adapter requires setup and approval from the Equativ (former Smart AdServer) service team. Please reach out to your account manager for more information and start using it. +The Equativ bidder adapter requires setup and approval from the Equativ service team. Please reach out to your account manager for more information to start using it. ### Bid params {: .table .table-bordered .table-striped } | Name | Scope | Description | Example | Type | |------|-------|-------------|---------|------| -| `networkId` | required for Prebid Server | The network identifier you have been provided with. **Note**: the `Equativ` bid adapter currently only supports client-side implementations. | `1234` | `integer` | -| `siteId` | required for Prebid.js | The placement site ID |`1234` | `integer` | -| `pageId` | required for Prebid.js | The placement page ID | `1234` | `integer` | -| `formatId` | required for Prebid.js | The placement format ID | `1234` | `integer` | -| `domain` | optional | The network domain (default see example) | `'http://prg.smartadserver.com', 'https://prg.smartadserver.com'` | `string` | -| `target` | optional | The keyword targeting | `'sport=tennis'` | `string` | -| `bidfloor` | optional | Bid floor for this placement in USD or in the currency specified by the `currency` parameter. (Default: `0.0`) | `0.42` | `float` | -| `appName` | optional | Mobile application name | `'Smart AdServer Preview'` | `string` | -| `buId` | optional | Mobile application bundle ID | `'com.smartadserver.android.dashboard'` | `string` | -| `ckId` | optional | Unique Smart AdServer user ID | `1234567890123456789` | `integer` | -| `video` | optional | Parameter object for instream video. See [video Object](#smartadserver-video-object) | `{}` | `object` | -| `schain` | optional | Supply Chain | `'1.0,1!exchange1.com,1234,1,bid-request-1,publisher,publisher.com'` | `string` | - -**Note:** The site, page and format identifiers have to all be provided (for Prebid.js). - -### Supported Media Types (Prebid.js) +| `networkId` | required | The network identifier you have been provided with. _See **Bid Parameter Usage** notes below for more information_. | `1234` | `integer` | +| `siteId` | required | The placement site ID. _See **Bid Parameter Usage** notes below for more information_. |`1234` | `integer` | +| `pageId` | required | The placement page ID. _See **Bid Parameter Usage** notes below for more information_. | `1234` | `integer` | +| `formatId` | required | The placement format ID. _See **Bid Parameter Usage** notes below for more information_. | `1234` | `integer` | + +#### Bid Parameter Usage +Different combinations of parameters are required depending upon which ones you choose to use. + +There are three options for passing bidder parameters: +- **Option 1**. Specify `networkId` by itself (_without_ `siteId`, `pageId` and `formatId`), or +- **Option 2**. Specify `siteId` _and_ `pageId` _and_ `formatId` (all together) _without_ `networkId`, or +- **Option 3**. Specify _none_ of the above parameters, and instead use either `ortb2.site.publisher.id` or `ortb2.site.app.id` + +See **Sample Banner Setup** for examples of these parameter options. + +### Supported Media Types {: .table .table-bordered .table-striped } | Type | Support | @@ -52,7 +52,7 @@ The Equativ bidder adapter requires setup and approval from the Equativ (former ### User Syncing -To enable cookie syncing, publishers should make sure their configuration setup is properly invoked. +To enable cookie syncing, make sure their configuration setup is properly invoked. This involves adding an entry for `setConfig()` that allows user syncing for iframes with `'equativ'` included as a bidder: @@ -82,8 +82,9 @@ pbjs.bidderSettings = { #### Sample Banner Setup -When including `'equativ'` as one of your available bidders your adunit setup, be sure to include `siteId`, `pageId` and `formatId` as bid parameters, as shown in the example below. +As mentioned in the **Bid Parameter Usage** section, when including `'equativ'` as one of your available bidders your adunit setup, there are three general approaches to how you can specify parameters. Below are examples that illustrate them. +#### Option 1 -- Using networkId as the only bid param ```html +``` + + + +#### Option 2 - Using siteId, pageId and formatId as bid params +```html + ``` + +#### Option 3 - Using ortb2 for parameter info +```html + +``` From 1c87179f574261fcd1e1ea587dedae1063d14e55 Mon Sep 17 00:00:00 2001 From: Jeff Mahoney Date: Wed, 6 Nov 2024 18:05:42 -0500 Subject: [PATCH 04/12] SADR-6590: fix linting issues --- dev-docs/bidders/equativ.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/dev-docs/bidders/equativ.md b/dev-docs/bidders/equativ.md index cc332070f9..935d5e30b8 100644 --- a/dev-docs/bidders/equativ.md +++ b/dev-docs/bidders/equativ.md @@ -24,6 +24,7 @@ The Equativ bidder adapter requires setup and approval from the Equativ service ### Bid params {: .table .table-bordered .table-striped } + | Name | Scope | Description | Example | Type | |------|-------|-------------|---------|------| | `networkId` | required | The network identifier you have been provided with. _See **Bid Parameter Usage** notes below for more information_. | `1234` | `integer` | @@ -35,6 +36,7 @@ The Equativ bidder adapter requires setup and approval from the Equativ service Different combinations of parameters are required depending upon which ones you choose to use. There are three options for passing bidder parameters: + - **Option 1**. Specify `networkId` by itself (_without_ `siteId`, `pageId` and `formatId`), or - **Option 2**. Specify `siteId` _and_ `pageId` _and_ `formatId` (all together) _without_ `networkId`, or - **Option 3**. Specify _none_ of the above parameters, and instead use either `ortb2.site.publisher.id` or `ortb2.site.app.id` @@ -44,6 +46,7 @@ See **Sample Banner Setup** for examples of these parameter options. ### Supported Media Types {: .table .table-bordered .table-striped } + | Type | Support | |---|---| | `banner` | Supported | @@ -85,6 +88,7 @@ pbjs.bidderSettings = { As mentioned in the **Bid Parameter Usage** section, when including `'equativ'` as one of your available bidders your adunit setup, there are three general approaches to how you can specify parameters. Below are examples that illustrate them. #### Option 1 -- Using networkId as the only bid param + ```html ``` - - #### Option 2 - Using siteId, pageId and formatId as bid params ```html From f846ddaa2ce7dfad76e68a748151a79f8826b2a7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Krzysztof=20Sok=C3=B3=C5=82?= Date: Thu, 7 Nov 2024 10:11:00 +0100 Subject: [PATCH 06/12] update app.publisher.id --- dev-docs/bidders/equativ.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dev-docs/bidders/equativ.md b/dev-docs/bidders/equativ.md index eba86725a2..846678d8a9 100644 --- a/dev-docs/bidders/equativ.md +++ b/dev-docs/bidders/equativ.md @@ -39,7 +39,7 @@ There are three options for passing bidder parameters: - **Option 1**. Specify `networkId` by itself (_without_ `siteId`, `pageId` and `formatId`), or - **Option 2**. Specify `siteId` _and_ `pageId` _and_ `formatId` (all together) _without_ `networkId`, or -- **Option 3**. Specify _none_ of the above parameters, and instead use either `ortb2.site.publisher.id` or `ortb2.site.app.id` +- **Option 3**. Specify _none_ of the above parameters, and instead use either `ortb2.site.publisher.id` or `ortb2.app.publisher.id` See **Sample Banner Setup** for examples of these parameter options. From 73f2212f9d04a7c181cef2d48126cfaa3a126d22 Mon Sep 17 00:00:00 2001 From: Jeff Mahoney Date: Thu, 7 Nov 2024 08:54:11 -0500 Subject: [PATCH 07/12] SADR-6590: providing link to Equativ OpenRTB API documentation --- dev-docs/bidders/equativ.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/dev-docs/bidders/equativ.md b/dev-docs/bidders/equativ.md index 846678d8a9..6611a3b6c3 100644 --- a/dev-docs/bidders/equativ.md +++ b/dev-docs/bidders/equativ.md @@ -209,3 +209,6 @@ As mentioned in the **Bid Parameter Usage** section, when including `'equativ'` }); ``` + +### Additional Resources +Information about how Equativ supports the oRTB specification, along with additional examples, can be found [on our OpenRTB API support site](https://help.smartadserver.com/s/article/OpenRTB-API-for-suppliers-Bid-request-specification-Part-1). From e6d7fa91d5e8e865cabce93e4a3a3348fb3b3cfd Mon Sep 17 00:00:00 2001 From: Jeff Mahoney Date: Thu, 7 Nov 2024 15:20:09 -0500 Subject: [PATCH 08/12] SADR-6590: providing additional required fields for documentation --- dev-docs/bidders/equativ.md | 54 ++++++++++++++++++++++++++++++++----- 1 file changed, 47 insertions(+), 7 deletions(-) diff --git a/dev-docs/bidders/equativ.md b/dev-docs/bidders/equativ.md index 6611a3b6c3..70f1a14881 100644 --- a/dev-docs/bidders/equativ.md +++ b/dev-docs/bidders/equativ.md @@ -3,17 +3,26 @@ layout: bidder title: Equativ description: Prebid Equativ Bidder Adapter biddercode: equativ -media_types: banner tcfeu_supported: true -coppa_supported: true +dsa_supported: false // TODO: SADR-6590: is this supported? gvl_id: 45 -gpp_supported: true -schain_supported: true usp_supported: true +coppa_supported: true +gpp_sids: tcfeu, usp +schain_supported: true +dchain_support: false // TODO: SADR-6590: saw no evidence that we support this userIds: all +media_types: banner +safeframes_ok: false // TODO: SADR-6590: is this supported? +deals_supported: false // TODO: SADR-6590: is this supported? +floors_supported: true +fpd_supported: true pbjs: true pbs: true -floors_supported: true +prebid_member: false +multiformat_supported: will-bid-on-any, will-bid-on-one, will-not-bid // TODO: SADR-6590: will-bid-on-one? +ortb_blocking_supported: false // TODO: SADR-6590: is this supported? +privacy_sandbox: no sidebarType: 1 --- @@ -24,7 +33,6 @@ The Equativ bidder adapter requires setup and approval from the Equativ service ### Bid params {: .table .table-bordered .table-striped } - | Name | Scope | Description | Example | Type | |------|-------|-------------|---------|------| | `networkId` | required | The network identifier you have been provided with. _See **Bid Parameter Usage** notes below for more information_. | `1234` | `integer` | @@ -46,13 +54,45 @@ See **Sample Banner Setup** for examples of these parameter options. ### Supported Media Types {: .table .table-bordered .table-striped } - | Type | Support | |---|---| | `banner` | Supported | | `video` | Not currently supported | | `native` | Not currently supported | +### First Party Data + +You can use the `ortb2` property for setting first-party data. The following use cases are supported: + +- `ortb2.site.publisher.id` +- `ortb2.app.publisher.id` + +The `app` or `site` object properties can be used as a way to specify an ID for Equativ to use to identify your requests (through `publisher.id`), as shown with the two examples below: + +```js + pbjs.setConfig({ + ortb2: { + site: { + publisher: { + id: 42 + } + } + }); +``` + +or + +```js + pbjs.setConfig({ + ortb2: { + app: { + publisher: { + id: 42 + } + } + }); +``` + ### User Syncing To enable cookie syncing, make sure their configuration setup is properly invoked. From dba1a529810ae3fedeedb8b5fbd74e1891562f28 Mon Sep 17 00:00:00 2001 From: Jeff Mahoney Date: Fri, 8 Nov 2024 09:05:12 -0500 Subject: [PATCH 09/12] SADR-6590: adding peer answers to questions --- dev-docs/bidders/equativ.md | 42 +++++++++++++++++++------------------ 1 file changed, 22 insertions(+), 20 deletions(-) diff --git a/dev-docs/bidders/equativ.md b/dev-docs/bidders/equativ.md index 70f1a14881..8e230476b1 100644 --- a/dev-docs/bidders/equativ.md +++ b/dev-docs/bidders/equativ.md @@ -4,25 +4,25 @@ title: Equativ description: Prebid Equativ Bidder Adapter biddercode: equativ tcfeu_supported: true -dsa_supported: false // TODO: SADR-6590: is this supported? +dsa_supported: true gvl_id: 45 usp_supported: true coppa_supported: true gpp_sids: tcfeu, usp schain_supported: true -dchain_support: false // TODO: SADR-6590: saw no evidence that we support this +dchain_support: false userIds: all media_types: banner -safeframes_ok: false // TODO: SADR-6590: is this supported? -deals_supported: false // TODO: SADR-6590: is this supported? +safeframes_ok: true +deals_supported: false floors_supported: true fpd_supported: true pbjs: true pbs: true prebid_member: false -multiformat_supported: will-bid-on-any, will-bid-on-one, will-not-bid // TODO: SADR-6590: will-bid-on-one? -ortb_blocking_supported: false // TODO: SADR-6590: is this supported? -privacy_sandbox: no +multiformat_supported: will-bid-on-one +ortb_blocking_supported: true +privacy_sandbox: no sidebarType: 1 --- @@ -40,14 +40,15 @@ The Equativ bidder adapter requires setup and approval from the Equativ service | `pageId` | required | The placement page ID. _See **Bid Parameter Usage** notes below for more information_. | `1234` | `integer` | | `formatId` | required | The placement format ID. _See **Bid Parameter Usage** notes below for more information_. | `1234` | `integer` | -#### Bid Parameter Usage +#### Bid Parameter Usage + Different combinations of parameters are required depending upon which ones you choose to use. There are three options for passing bidder parameters: -- **Option 1**. Specify `networkId` by itself (_without_ `siteId`, `pageId` and `formatId`), or -- **Option 2**. Specify `siteId` _and_ `pageId` _and_ `formatId` (all together) _without_ `networkId`, or -- **Option 3**. Specify _none_ of the above parameters, and instead use either `ortb2.site.publisher.id` or `ortb2.app.publisher.id` +- **Option 1**. Specify `networkId` by itself (_without_ `siteId`, `pageId` and `formatId`), or +- **Option 2**. Specify `siteId` _and_ `pageId` _and_ `formatId` (all together) _without_ `networkId`, or +- **Option 3**. Specify _none_ of the above parameters, and instead use either `ortb2.site.publisher.id` or `ortb2.app.publisher.id` See **Sample Banner Setup** for examples of these parameter options. @@ -62,7 +63,7 @@ See **Sample Banner Setup** for examples of these parameter options. ### First Party Data -You can use the `ortb2` property for setting first-party data. The following use cases are supported: +You can use the `ortb2` property for setting first-party data. The following use cases are supported: - `ortb2.site.publisher.id` - `ortb2.app.publisher.id` @@ -80,7 +81,7 @@ The `app` or `site` object properties can be used as a way to specify an ID for }); ``` -or +or ```js pbjs.setConfig({ @@ -125,7 +126,7 @@ pbjs.bidderSettings = { #### Sample Banner Setup -As mentioned in the **Bid Parameter Usage** section, when including `'equativ'` as one of your available bidders your adunit setup, there are three general approaches to how you can specify parameters. Below are examples that illustrate them. +As mentioned in the **Bid Parameter Usage** section, when including `'equativ'` as one of your available bidders your adunit setup, there are three general approaches to how you can specify parameters. Below are examples that illustrate them. #### Option 1 -- Using networkId as the only bid param @@ -179,9 +180,9 @@ As mentioned in the **Bid Parameter Usage** section, when including `'equativ'` bids: [ { bidder: 'equativ', - // all 3 of the below params are required + // all 3 of the below params are required // when used together in place of networkId - params: { + params: { siteId: 1, pageId: 2, formatId: 3, @@ -219,8 +220,8 @@ As mentioned in the **Bid Parameter Usage** section, when including `'equativ'` ], }, ]; - - // specify ortb2.site.publisher.id in + + // specify ortb2.site.publisher.id in // place of networkId pbjs.setConfig({ ortb2: { @@ -231,9 +232,9 @@ As mentioned in the **Bid Parameter Usage** section, when including `'equativ'` } }); /* - // APP ALTERNATIVE: you can use, if needed, + // APP ALTERNATIVE: you can use, if needed, // "app" instead of "publisher", like this: - // ------------------ + // ------------------ pbjs.setConfig({ ortb2: { app: { @@ -251,4 +252,5 @@ As mentioned in the **Bid Parameter Usage** section, when including `'equativ'` ``` ### Additional Resources + Information about how Equativ supports the oRTB specification, along with additional examples, can be found [on our OpenRTB API support site](https://help.smartadserver.com/s/article/OpenRTB-API-for-suppliers-Bid-request-specification-Part-1). From 5d4916723661fcfa4ac9686b99800afd4f487f5b Mon Sep 17 00:00:00 2001 From: Jeff Mahoney Date: Fri, 8 Nov 2024 17:47:24 -0500 Subject: [PATCH 10/12] SADR-6590: remove FPD section for now --- dev-docs/bidders/equativ.md | 90 +++---------------------------------- 1 file changed, 6 insertions(+), 84 deletions(-) diff --git a/dev-docs/bidders/equativ.md b/dev-docs/bidders/equativ.md index 8e230476b1..ffa7dfb630 100644 --- a/dev-docs/bidders/equativ.md +++ b/dev-docs/bidders/equativ.md @@ -16,7 +16,7 @@ media_types: banner safeframes_ok: true deals_supported: false floors_supported: true -fpd_supported: true +fpd_supported: false pbjs: true pbs: true prebid_member: false @@ -48,7 +48,7 @@ There are three options for passing bidder parameters: - **Option 1**. Specify `networkId` by itself (_without_ `siteId`, `pageId` and `formatId`), or - **Option 2**. Specify `siteId` _and_ `pageId` _and_ `formatId` (all together) _without_ `networkId`, or -- **Option 3**. Specify _none_ of the above parameters, and instead use either `ortb2.site.publisher.id` or `ortb2.app.publisher.id` +- **Option 3**. Specify _none_ of the above parameters, and instead use either `ortb2.site.publisher.id`, `ortb2.app.publisher.id` or `ortb2.dooh.publisher.id` See **Sample Banner Setup** for examples of these parameter options. @@ -61,39 +61,6 @@ See **Sample Banner Setup** for examples of these parameter options. | `video` | Not currently supported | | `native` | Not currently supported | -### First Party Data - -You can use the `ortb2` property for setting first-party data. The following use cases are supported: - -- `ortb2.site.publisher.id` -- `ortb2.app.publisher.id` - -The `app` or `site` object properties can be used as a way to specify an ID for Equativ to use to identify your requests (through `publisher.id`), as shown with the two examples below: - -```js - pbjs.setConfig({ - ortb2: { - site: { - publisher: { - id: 42 - } - } - }); -``` - -or - -```js - pbjs.setConfig({ - ortb2: { - app: { - publisher: { - id: 42 - } - } - }); -``` - ### User Syncing To enable cookie syncing, make sure their configuration setup is properly invoked. @@ -200,56 +167,11 @@ As mentioned in the **Bid Parameter Usage** section, when including `'equativ'` #### Option 3 - Using ortb2 for parameter info -```html - -``` +- `ortb2.app.publisher.id` +- `ortb2.site.publisher.id` +- `ortb2.dooh.publisher.id` ### Additional Resources From b91a985fe710ef9b9bf813da5a6946192218144d Mon Sep 17 00:00:00 2001 From: Jeff Mahoney Date: Tue, 3 Dec 2024 09:59:01 -0500 Subject: [PATCH 11/12] Equativ: updating documentation on bid adapter parameter requirements --- dev-docs/bidders/equativ.md | 64 ++++++++----------------------------- 1 file changed, 14 insertions(+), 50 deletions(-) diff --git a/dev-docs/bidders/equativ.md b/dev-docs/bidders/equativ.md index ffa7dfb630..4ddca56f68 100644 --- a/dev-docs/bidders/equativ.md +++ b/dev-docs/bidders/equativ.md @@ -35,20 +35,19 @@ The Equativ bidder adapter requires setup and approval from the Equativ service {: .table .table-bordered .table-striped } | Name | Scope | Description | Example | Type | |------|-------|-------------|---------|------| -| `networkId` | required | The network identifier you have been provided with. _See **Bid Parameter Usage** notes below for more information_. | `1234` | `integer` | -| `siteId` | required | The placement site ID. _See **Bid Parameter Usage** notes below for more information_. |`1234` | `integer` | -| `pageId` | required | The placement page ID. _See **Bid Parameter Usage** notes below for more information_. | `1234` | `integer` | -| `formatId` | required | The placement format ID. _See **Bid Parameter Usage** notes below for more information_. | `1234` | `integer` | +| `networkId` | required | The network identifier you have been provided with. Normally required, but there are certain conditions under which this may be omitted. _See **Bid Parameter Usage** notes below for more information_. | `1234` | `integer` | +| `siteId` | optional | The placement site ID. _See **Bid Parameter Usage** notes below for more information_. |`1234` | `integer` | +| `pageId` | optional | The placement page ID. _See **Bid Parameter Usage** notes below for more information_. | `1234` | `integer` | +| `formatId` | optional | The placement format ID. _See **Bid Parameter Usage** notes below for more information_. | `1234` | `integer` | #### Bid Parameter Usage Different combinations of parameters are required depending upon which ones you choose to use. -There are three options for passing bidder parameters: +There are two options for passing parameters: -- **Option 1**. Specify `networkId` by itself (_without_ `siteId`, `pageId` and `formatId`), or -- **Option 2**. Specify `siteId` _and_ `pageId` _and_ `formatId` (all together) _without_ `networkId`, or -- **Option 3**. Specify _none_ of the above parameters, and instead use either `ortb2.site.publisher.id`, `ortb2.app.publisher.id` or `ortb2.dooh.publisher.id` +- **Option 1**. Specify `networkId` by itself (_and optionally providing_ `siteId`, `pageId` and `formatId`), or +- **Option 2**. Specify either `ortb2.site.publisher.id`, `ortb2.app.publisher.id` or `ortb2.dooh.publisher.id` See **Sample Banner Setup** for examples of these parameter options. @@ -93,9 +92,9 @@ pbjs.bidderSettings = { #### Sample Banner Setup -As mentioned in the **Bid Parameter Usage** section, when including `'equativ'` as one of your available bidders your adunit setup, there are three general approaches to how you can specify parameters. Below are examples that illustrate them. +As mentioned in the **Bid Parameter Usage** section, when including `'equativ'` as one of your available bidders your adunit setup, there are two approaches to how you can specify parameters. Below are examples that illustrate them. -#### Option 1 -- Using networkId as the only bid param +#### Option 1 -- Using networkId as a parameter ```html ``` -#### Option 2 - Using siteId, pageId and formatId as bid params - -```html - -``` - -#### Option 3 - Using ortb2 for parameter info +#### Option 2 - Using ortb2 for parameter info You can also, as an alternative to using bidder params, specify a value for `publisher.id` that may be nested under an `app`, `site` or `dooh` object. The Equativ adapter will, in turn, look for these property paths under the `ortb2` property of the request: From 16aa89e2eae69f1e0cbf1859b9175844aa2dcc55 Mon Sep 17 00:00:00 2001 From: Jeff Mahoney Date: Fri, 17 Jan 2025 17:54:30 -0500 Subject: [PATCH 12/12] SADR-6882: expanding documentation with additional examples --- dev-docs/bidders/equativ.md | 297 ++++++++++++++++++++++++++++++------ 1 file changed, 253 insertions(+), 44 deletions(-) diff --git a/dev-docs/bidders/equativ.md b/dev-docs/bidders/equativ.md index 4ddca56f68..7d39a7a6f6 100644 --- a/dev-docs/bidders/equativ.md +++ b/dev-docs/bidders/equativ.md @@ -30,7 +30,9 @@ sidebarType: 1 The Equativ bidder adapter requires setup and approval from the Equativ service team. Please reach out to your account manager for more information to start using it. -### Bid params +### Bid Params + +#### Fields {: .table .table-bordered .table-striped } | Name | Scope | Description | Example | Type | @@ -40,16 +42,53 @@ The Equativ bidder adapter requires setup and approval from the Equativ service | `pageId` | optional | The placement page ID. _See **Bid Parameter Usage** notes below for more information_. | `1234` | `integer` | | `formatId` | optional | The placement format ID. _See **Bid Parameter Usage** notes below for more information_. | `1234` | `integer` | -#### Bid Parameter Usage +#### Usage Different combinations of parameters are required depending upon which ones you choose to use. -There are two options for passing parameters: +There are two options for passing Equativ-specific bidder parameters: through bidder params, or through ortb2. + +##### Through bidder params Object + +Publishers can specify required and/or optional parameters through the bidder params object hierarchy like this: + +```javascript +var adUnits = [ + { + /// ... mediaType and other stuff here + bids: [ + { + bidder: 'equativ', + params: { + networkId: 42, // REQUIRED + siteId: 142, // optional + pageId: 242, // optional + formatId: 342, // optional + }, + }, + ], + }, +]; +``` + +##### Through ortb2 -- **Option 1**. Specify `networkId` by itself (_and optionally providing_ `siteId`, `pageId` and `formatId`), or -- **Option 2**. Specify either `ortb2.site.publisher.id`, `ortb2.app.publisher.id` or `ortb2.dooh.publisher.id` +A second way to specify Equativ-specific bidder parameters is through the `ortb2` object. The example below references a `ortb2.site.publisher.id` hierarchy, but publishers can also use `ortb2.app.publisher.id` or `ortb2.dooh.publisher.id` as their needs dictate. -See **Sample Banner Setup** for examples of these parameter options. +```javascript +pbjs.setBidderConfig({ + bidders: ['equativ'], + config: { + ortb2: { + site: { + publisher: { + id: 42, + }, + }, + }, + }, +}); +``` ### Supported Media Types @@ -57,12 +96,12 @@ See **Sample Banner Setup** for examples of these parameter options. | Type | Support | |---|---| | `banner` | Supported | -| `video` | Not currently supported | -| `native` | Not currently supported | +| `video` | Supported | +| `native` | Supported | ### User Syncing -To enable cookie syncing, make sure their configuration setup is properly invoked. +To enable cookie syncing, make sure the configuration setup is properly invoked. This involves adding an entry for `setConfig()` that allows user syncing for iframes with `'equativ'` included as a bidder: @@ -88,54 +127,224 @@ pbjs.bidderSettings = { }; ``` -### Configuration Example +### Ad Unit Setup -#### Sample Banner Setup +#### Banner -As mentioned in the **Bid Parameter Usage** section, when including `'equativ'` as one of your available bidders your adunit setup, there are two approaches to how you can specify parameters. Below are examples that illustrate them. +As mentioned in the **Bid Params > Usage** section, when including `'equativ'` as one of the available bidders in an adunit setup, there are two approaches to how publishers can specify parameters. The below example uses the approach using the `params` object. -#### Option 1 -- Using networkId as a parameter +```javascript +var bannerAdUnits = [ + { + code: 'div-123', + mediaTypes: { + banner: { + sizes: [ + [600, 500], + [300, 600], + ], + }, + }, + bids: [ + { + bidder: 'equativ', + params: { + networkId: 42, // REQUIRED + siteId: 142, // optional + pageId: 242, // optional + formatId: 342, // optional + }, + }, + ], + }, +]; -```html - +pbjs.que.push(function () { + pbjs.addAdUnits(nativeAdUnits); +}); ``` -#### Option 2 - Using ortb2 for parameter info +#### Audio + +It is possible to specify audio inventory through the Equativ adapter. To do so, publishers can define a video-formatted ad unit and specify audio information through the `ortb2Imp` property, like the example shown below. -You can also, as an alternative to using bidder params, specify a value for `publisher.id` that may be nested under an `app`, `site` or `dooh` object. The Equativ adapter will, in turn, look for these property paths under the `ortb2` property of the request: +Note that the `optional`, `recommended` and `REQUIRED` comments apply to the property itself, and not necessarily the values used in this example (_i.e._ `minduration` _is a recommended property to include, but it is up to publishers to decide what particular value it should have_). + +```javascript +var audioAdUnits = [ + { + code: '/19968336/header-bid-tag-1', + mediaTypes: { + video: { + context: 'instream', + playerSize: [640, 480], + }, + }, + ortb2Imp: { + audio: { + mimes: ['audio/mpeg', 'audio/mp4'], // REQUIRED + api: [7], // optional + delivery: [2, 4], // optional + minbitrate: 128, // optional + maxbitrate: 192, // optional + minduration: 10, // recommended + maxduration: 30, // recommended + maxextended: -1, // optional + protocols: [1, 3, 4, 7], // recommended + startdelay: 5, // recommended + }, + }, + bids: [ + { + bidder: 'equativ', + params: { + networkId: 1234, + }, + }, + ], + }, +]; + +pbjs.que.push(function () { + pbjs.addAdUnits(audioAdUnits); +}); +``` -- `ortb2.app.publisher.id` -- `ortb2.site.publisher.id` -- `ortb2.dooh.publisher.id` +{: .alert.alert-warning :} +**Note**: If a demand partner of Equativ is not capable of reading an audio object, the audio object will be converted into a video object with audio mime types. There is, as of this writing, no built-in/default support for serving audio assets in Prebid, so publishers that wish to do so will need to ensure their ad server setups can process whatever hand-offs are necessary. ### Additional Resources