diff --git a/dev-docs/bidders/equativ.md b/dev-docs/bidders/equativ.md index 6611a3b6c3..8e230476b1 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: true 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 userIds: all +media_types: banner +safeframes_ok: true +deals_supported: false +floors_supported: true +fpd_supported: true pbjs: true pbs: true -floors_supported: true +prebid_member: false +multiformat_supported: will-bid-on-one +ortb_blocking_supported: true +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` | @@ -32,27 +40,60 @@ 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. ### 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. @@ -85,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 @@ -139,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, @@ -179,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: { @@ -191,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: { @@ -211,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).