From 65e26107f05252bf91fa20925c4ea815588181e6 Mon Sep 17 00:00:00 2001 From: Giuseppe Cera Date: Wed, 3 Apr 2024 13:59:36 +0200 Subject: [PATCH 1/4] fix: related to markdown lint validation --- dev-docs/bidders/exadsadserver.md | 65 ++++++++++++++++++------------- 1 file changed, 37 insertions(+), 28 deletions(-) diff --git a/dev-docs/bidders/exadsadserver.md b/dev-docs/bidders/exadsadserver.md index 8ba8935f4a..87dc21c6bc 100644 --- a/dev-docs/bidders/exadsadserver.md +++ b/dev-docs/bidders/exadsadserver.md @@ -20,7 +20,8 @@ A very minimal RTB Banner example that shows how to use the EXADS adapter. The most important attributes are: **endpoint**, **fid** and **zoneId**. You can get them after configuring the zones. For more details about ad formats and parameters, read it in the next sections. -``` +```js + adUnits = [ { code: 'postbid_iframe', // the frame where to render the creative @@ -52,14 +53,17 @@ adUnits = [ ``` ### Configuration -##### General settings -Use `setConfig` to instruct Prebid.js to initilize the exadsBidAdapter, as specified below. + +#### General settings + +Use `setConfig` to instruct Prebid.js to initilize the exadsBidAdapter, as specified below. + * Set "debug" as true if you need to read logs; * Set "gdprApplies" as true if you need to pass gdpr consent string; * The tcString is the iabtcf consent string for gdpr; * Uncomment the cache instruction if you need to configure a cache server (e.g. for instream video) -``` +```js pbjs.setConfig({ debug: false, //cache: { url: "https://prebid.adnxs.com/pbc/v1/cache" }, @@ -80,10 +84,12 @@ pbjs.setConfig({ ``` ##### Video settings + If you will work with video stream ad formats you could choose to use the prebidJS video module to render the video using already supported video players as videoJS. Add the `video` config if you need to render videos using the video module. -For more info navigate to https://docs.prebid.org/prebid-video/video-module.html. -``` +For more info navigate to . + +```js pbjs.setConfig({ video: { providers: [ @@ -139,11 +145,11 @@ pbjs.setConfig({ |---------------|----------|-----------------------|-----------|-----------| | `dsarequired` | optional | flag to indicate if DSA information should be made available | `3` | `integer` | | `pubrender` | optional | flag to indicate if the publisher will render the DSA Transparency info | `0` | `integer` | -| `datatopub` | optional | ndependent of pubrender, the publisher may need the transparency data for audit purposes | `2` | `integer` | +| `datatopub` | optional | independent of pubrender, the publisher may need the transparency data for audit purposes | `2` | `integer` | ##### RTB Banner 2.4 (Image) -```javascript +```js adUnits = [ { code: 'postbid_iframe', // the frame where to render the creative @@ -187,7 +193,7 @@ adUnits = [ ##### RTB Banner 2.4 (Video) -```javascript +```js adUnits = [ { code: 'postbid_iframe', // the frame where to render the creative @@ -268,9 +274,9 @@ adUnits = [ |---------------|----------|-----------------------|-----------|-----------| | `dsarequired` | optional | flag to indicate if DSA information should be made available | `3` | `integer` | | `pubrender` | optional | flag to indicate if the publisher will render the DSA Transparency info | `0` | `integer` | -| `datatopub` | optional | ndependent of pubrender, the publisher may need the transparency data for audit purposes | `2` | `integer` | +| `datatopub` | optional | independent of pubrender, the publisher may need the transparency data for audit purposes | `2` | `integer` | -```javascript +```js adUnits = [ { code: 'postbid_iframe', @@ -345,32 +351,32 @@ adUnits = [ ##### Assets * **assets (title)** - * **id** - unique asset ID, assigned by exchange. Typically a counter for the array (integer): - * 1 - image asset ID + * **id** - unique asset ID, assigned by exchange. Typically a counter for the array (integer): + *1 - image asset ID * 2 - title asset ID * 3 - description asset ID - * **required** - set to 1 if asset is required or 0 if asset is optional (integer) - * **title** + * **required** - set to 1 if asset is required or 0 if asset is optional (integer) + * **title** * len (required) - maximum length of the text in the title element (integer) * **assets (data)** - * **id** - unique asset ID, assigned by exchange. Typically a counter for the array (integer): - * 1 - image asset ID + * **id** - unique asset ID, assigned by exchange. Typically a counter for the array (integer): + *1 - image asset ID * 2 - title asset ID * 3 - description asset ID * **data** - * **type** - type ID of the element supported by the publisher (integer). We support: - * 1 - sponsored - sponsored By message where response should contain the brand name of the sponsor + * **type** - type ID of the element supported by the publisher (integer). We support: + *1 - sponsored - sponsored By message where response should contain the brand name of the sponsor * 2 - desc - descriptive text associated with the product or service being advertised * **len** - maximum length of the text in the element’s response (integer) * **assets (img)** - * **id** - unique asset ID, assigned by exchange. Typically a counter for the array (integer): - * 1 - image asset ID + * **id** - unique asset ID, assigned by exchange. Typically a counter for the array (integer): + *1 - image asset ID * 2 - title asset ID * 3 - description asset ID * **required** - set to 1 if asset is required or 0 if asset is optional (integer) * **img** - * **type** - type ID of the image element supported by the publisher. We support: - * 1 - icon image (integer) + * **type** - type ID of the image element supported by the publisher. We support: + *1 - icon image (integer) * 3 - large image preview for the ad (integer) * **w** - width of the image in pixels, optional (integer) * **h** - height of the image in pixels, optional (integer) @@ -382,9 +388,9 @@ adUnits = [ |---------------|----------|-----------------------|-----------|-----------| | `dsarequired` | optional | flag to indicate if DSA information should be made available | `3` | `integer` | | `pubrender` | optional | flag to indicate if the publisher will render the DSA Transparency info | `0` | `integer` | -| `datatopub` | optional | ndependent of pubrender, the publisher may need the transparency data for audit purposes | `2` | `integer` | +| `datatopub` | optional | independent of pubrender, the publisher may need the transparency data for audit purposes | `2` | `integer` | -```javascript +```js adUnits = [ { code: 'postbid_iframe', @@ -454,9 +460,11 @@ adUnits = [ ]; ``` -# DSA Transparency +### DSA Transparency + All DSA information, returned by the ad server, can be found into the **meta** tag of the response. As: -``` + +```js "meta": { "dsa": { "behalf": "...", @@ -472,4 +480,5 @@ All DSA information, returned by the ad server, can be found into the **meta** t } } ``` -For more information navigate to https://docs.prebid.org/dev-docs/bidder-adaptor.html. \ No newline at end of file + +For more information navigate to . From cf7a84a045476c41b2cbbe4b8750bb6faf9ca843 Mon Sep 17 00:00:00 2001 From: Giuseppe Cera Date: Mon, 8 Apr 2024 15:26:11 +0100 Subject: [PATCH 2/4] fix: from code review --- dev-docs/bidders/exadsadserver.md | 85 ++----------------------------- 1 file changed, 3 insertions(+), 82 deletions(-) diff --git a/dev-docs/bidders/exadsadserver.md b/dev-docs/bidders/exadsadserver.md index 87dc21c6bc..736d72ae33 100644 --- a/dev-docs/bidders/exadsadserver.md +++ b/dev-docs/bidders/exadsadserver.md @@ -3,7 +3,9 @@ layout: bidder title: EXADS description: EXADS Bidder Adapter pbjs: true +multiformat_supported: will-bid-on-one biddercode: exadsadserver +dsa_supported: true gvl_id: 1084 tcfeu_supported: true media_types: banner, video, native @@ -54,66 +56,12 @@ adUnits = [ ### Configuration -#### General settings - -Use `setConfig` to instruct Prebid.js to initilize the exadsBidAdapter, as specified below. - -* Set "debug" as true if you need to read logs; -* Set "gdprApplies" as true if you need to pass gdpr consent string; -* The tcString is the iabtcf consent string for gdpr; -* Uncomment the cache instruction if you need to configure a cache server (e.g. for instream video) - -```js -pbjs.setConfig({ - debug: false, - //cache: { url: "https://prebid.adnxs.com/pbc/v1/cache" }, - consentManagement: { - gdpr: { - cmpApi: 'static', - timeout: 1000000, - defaultGdprScope: true, - consentData: { - getTCData: { - tcString: consentString, - gdprApplies: false, // set to true to pass the gdpr consent string - }, - }, - }, - }, -}); -``` - -##### Video settings +#### Video settings If you will work with video stream ad formats you could choose to use the prebidJS video module to render the video using already supported video players as videoJS. Add the `video` config if you need to render videos using the video module. For more info navigate to . -```js -pbjs.setConfig({ - video: { - providers: [ - { - divId: 'player', // the id related to the videojs tag in your body - vendorCode: 2, // videojs, - playerConfig: { - params: { - adPluginConfig: { - numRedirects: 10, - }, - vendorConfig: { - controls: true, - autoplay: true, - preload: 'auto', - }, - }, - }, - }, - ], - }, -}); -``` - #### RTB Banner 2.4 {: .table .table-bordered .table-striped } @@ -138,15 +86,6 @@ pbjs.setConfig({ | `dsa` | optional | DSA transparency information. To see the specific paragraph for more details. | `{ dsarequired: 3, pubrender: 0, datatopub: 2 }` | `object` | | `endpoint` | required | EXADS endpoint (URL) | `https://your-ad-network.com/rtb.php` | `string` | -##### DSA - -{: .table .table-bordered .table-striped } -| Name | Scope | Description | Example | Type | -|---------------|----------|-----------------------|-----------|-----------| -| `dsarequired` | optional | flag to indicate if DSA information should be made available | `3` | `integer` | -| `pubrender` | optional | flag to indicate if the publisher will render the DSA Transparency info | `0` | `integer` | -| `datatopub` | optional | independent of pubrender, the publisher may need the transparency data for audit purposes | `2` | `integer` | - ##### RTB Banner 2.4 (Image) ```js @@ -267,15 +206,6 @@ adUnits = [ | `protocols` | required | list of supported video bid response protocols | `[3, 6]` | `integer array` | | `context` | recommended | the video context, either ‘instream’, ‘outstream’. Defaults to ‘instream’ | `'instream'` | `string` | -##### DSA - -{: .table .table-bordered .table-striped } -| Name | Scope | Description | Example | Type | -|---------------|----------|-----------------------|-----------|-----------| -| `dsarequired` | optional | flag to indicate if DSA information should be made available | `3` | `integer` | -| `pubrender` | optional | flag to indicate if the publisher will render the DSA Transparency info | `0` | `integer` | -| `datatopub` | optional | independent of pubrender, the publisher may need the transparency data for audit purposes | `2` | `integer` | - ```js adUnits = [ { @@ -381,15 +311,6 @@ adUnits = [ * **w** - width of the image in pixels, optional (integer) * **h** - height of the image in pixels, optional (integer) -##### DSA - -{: .table .table-bordered .table-striped } -| Name | Scope | Description | Example | Type | -|---------------|----------|-----------------------|-----------|-----------| -| `dsarequired` | optional | flag to indicate if DSA information should be made available | `3` | `integer` | -| `pubrender` | optional | flag to indicate if the publisher will render the DSA Transparency info | `0` | `integer` | -| `datatopub` | optional | independent of pubrender, the publisher may need the transparency data for audit purposes | `2` | `integer` | - ```js adUnits = [ { From 1158e4a0d68d957e9552f4f2e65aa5c4eba953db Mon Sep 17 00:00:00 2001 From: Giuseppe Cera Date: Mon, 8 Apr 2024 15:35:28 +0100 Subject: [PATCH 3/4] fix: from code review --- dev-docs/bidders/exadsadserver.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/dev-docs/bidders/exadsadserver.md b/dev-docs/bidders/exadsadserver.md index 736d72ae33..a5059a6c11 100644 --- a/dev-docs/bidders/exadsadserver.md +++ b/dev-docs/bidders/exadsadserver.md @@ -3,13 +3,12 @@ layout: bidder title: EXADS description: EXADS Bidder Adapter pbjs: true -multiformat_supported: will-bid-on-one +multiformat_supported: will-not-bid biddercode: exadsadserver dsa_supported: true gvl_id: 1084 tcfeu_supported: true media_types: banner, video, native -gpp_sids: tcfeu safeframes_ok: false deals_supported: false floors_supported: true From 2073d144814864ca5dc9ae020938b843aa396b6c Mon Sep 17 00:00:00 2001 From: Giuseppe Cera Date: Thu, 11 Apr 2024 15:21:45 +0100 Subject: [PATCH 4/4] fix: from CR --- dev-docs/bidders/exadsadserver.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/dev-docs/bidders/exadsadserver.md b/dev-docs/bidders/exadsadserver.md index a5059a6c11..5e80e506ed 100644 --- a/dev-docs/bidders/exadsadserver.md +++ b/dev-docs/bidders/exadsadserver.md @@ -59,7 +59,7 @@ adUnits = [ If you will work with video stream ad formats you could choose to use the prebidJS video module to render the video using already supported video players as videoJS. Add the `video` config if you need to render videos using the video module. -For more info navigate to . +For more info navigate to [instructions](/prebid-video/video-module.html). #### RTB Banner 2.4 @@ -401,4 +401,4 @@ All DSA information, returned by the ad server, can be found into the **meta** t } ``` -For more information navigate to . +For more information navigate to the [page](/dev-docs/bidder-adaptor.html).