Equativ Bid Adapter: Updating information about bid params (#5760)

* SADR-6590: initial documentation for Equativ JS bid adapter * SADR-6590: doc refinements * Update equativ.md SADR-6590: adjustments to doc from review feedback. * SADR-6590: fix linting issues * SADR-6590: another linting issue * update app.publisher.id * SADR-6590: providing link to Equativ OpenRTB API documentation * SADR-6590: providing additional required fields for documentation * SADR-6590: adding peer answers to questions * SADR-6590: remove FPD section for now * Equativ: updating documentation on bid adapter parameter requirements --------- Co-authored-by: Krzysztof Sokół <[email protected]>
prebid · Dec 6, 2024 · f9955f5 · f9955f5
1 parent 31c95ea
commit f9955f5
Showing 1 changed file with 14 additions and 50 deletions.
diff --git 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
 <script>
@@ -113,10 +112,11 @@ As mentioned in the **Bid Parameter Usage** section, when including `'equativ'`
       bids: [
         {
           bidder: 'equativ',
-          // siteId, pageId and formatId are NOT
-          // required if networkId is provided instead
           params: {
-            networkId: 42,
+            networkId: 42, // REQUIRED
+            siteId: 142, // optional
+            pageId: 242, // optional
+            formatId: 342, // optional
           },
         },
       ],
@@ -129,43 +129,7 @@ As mentioned in the **Bid Parameter Usage** section, when including `'equativ'`
 </script>
 ```
 
-#### Option 2 - Using siteId, pageId and formatId as bid params
-
-```html
-<script>
-  var adUnits = [
-    {
-      code: 'div-123',
-      mediaTypes: {
-        banner: {
-          sizes: [
-            [600, 500],
-            [300, 600],
-          ],
-        },
-      },
-      bids: [
-        {
-          bidder: 'equativ',
-          // all 3 of the below params are required
-          // when used together in place of networkId
-          params: {
-            siteId: 1,
-            pageId: 2,
-            formatId: 3,
-          },
-        },
-      ],
-    },
-  ];
-
-  pbjs.que.push(function () {
-    pbjs.addAdUnits(adUnits);
-  });
-</script>
-```
-
-#### 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: