From 76337917e4572a22152ba6a1a526e7a463b35f91 Mon Sep 17 00:00:00 2001 From: Jeff Mahoney Date: Mon, 4 Nov 2024 18:10:43 -0500 Subject: [PATCH 1/7] 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 2/7] 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 3/7] 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 4/7] 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 6/7] 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 7/7] 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).