From 58b7c7b0449b424435de341e75764446fae9d9fe Mon Sep 17 00:00:00 2001 From: Vladyslav Date: Thu, 13 Feb 2025 13:05:49 +0200 Subject: [PATCH 1/4] add doc md --- dev-docs/bidders/epomDspBidAdapter.md | 77 +++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 dev-docs/bidders/epomDspBidAdapter.md diff --git a/dev-docs/bidders/epomDspBidAdapter.md b/dev-docs/bidders/epomDspBidAdapter.md new file mode 100644 index 0000000000..c9ff5a3f96 --- /dev/null +++ b/dev-docs/bidders/epomDspBidAdapter.md @@ -0,0 +1,77 @@ +--- +layout: bidder +title: Epom DSP +description: Prebid Epom DSP Bid Adapter +biddercode: epom_dsp +tcfeu_supported: true +gvl_id: none +usp_supported: true +coppa_supported: false +gpp_sids: tcfeu, usnat +schain_supported: true +dchain_supported: false +userId: none +media_types: banner +safeframes_ok: true +deals_supported: true +floors_supported: true +fpd_supported: false +pbjs: true +pbs: false +prebid_member: false +multiformat_supported: will-bid-on-one +ortb_blocking_supported: false +privacy_sandbox: no +sidebarType: 1 +--- + +## Overview + +The **Epom DSP Bid Adapter** allows publishers to connect with the Epom DSP Exchange for programmatic advertising. It supports banner formats and adheres to the OpenRTB protocol. + +## Bid Params + +{: .table .table-bordered .table-striped } +| Name | Scope | Description | Example | Type | +|------------|---------|----------------------------------|---------|--------| +| `endpoint` | required | The URL of the Epom DSP bidding endpoint | `'https://bidder.epommarket.com/bidder/v2_5/bid?key=your_api_key'` | `string` | +| `placementId` | optional | Unique identifier for the placement | `'12345'` | `string` | +| `bidfloor` | optional | Minimum CPM value for the bid in USD | `0.5` | `number` | + +## Example Configuration + +```javascript +var adUnits = [ + { + code: 'epom-banner-div', + mediaTypes: { + banner: { + sizes: [ + [300, 250], + [728, 90], + [160, 600], + ] + } + }, + bids: [ + { + bidder: 'epom_dsp', + params: { + endpoint: 'https://bidder.epommarket.com/bidder/v2_5/bid?key=your_api_key' + } + } + ] + } +]; +``` + +## GDPR and Privacy Compliance + +The **Epom DSP Bid Adapter** supports GDPR and CCPA compliance. Consent information can be passed via: + +- `bidderRequest.gdprConsent` +- `bidderRequest.uspConsent` + +## Support + +For integration assistance, contact [Epom Support](mailto:support@epom.com). From dc08dcbaf87100c1a48eba240666c0a07d77b703 Mon Sep 17 00:00:00 2001 From: Vladyslav Date: Fri, 28 Feb 2025 14:32:18 +0200 Subject: [PATCH 2/4] add real data for EPOM DSP --- dev-docs/bidders/epomDspBidAdapter.md | 80 +++++++++++++++++++++++++-- 1 file changed, 74 insertions(+), 6 deletions(-) diff --git a/dev-docs/bidders/epomDspBidAdapter.md b/dev-docs/bidders/epomDspBidAdapter.md index c9ff5a3f96..81dc74682c 100644 --- a/dev-docs/bidders/epomDspBidAdapter.md +++ b/dev-docs/bidders/epomDspBidAdapter.md @@ -41,15 +41,13 @@ The **Epom DSP Bid Adapter** allows publishers to connect with the Epom DSP Exch ## Example Configuration ```javascript -var adUnits = [ + var adUnits = [ { code: 'epom-banner-div', mediaTypes: { banner: { sizes: [ - [300, 250], - [728, 90], - [160, 600], + [300, 250] ] } }, @@ -57,8 +55,78 @@ var adUnits = [ { bidder: 'epom_dsp', params: { - endpoint: 'https://bidder.epommarket.com/bidder/v2_5/bid?key=your_api_key' - } + endpoint: 'https://bidder.epommarket.com/bidder/v2_5/bid?key=d0b9fb9de9dfbba694dfe75294d8e45a' + }, + "imp": [ + { + "banner": { + "w": 300, + "h": 250, + "btype": [ + 4 + ], + "pos": 0, + "api": [ + 3 + ] + }, + "instl": 0, + "tagid": "test4", + "bidfloor": 0.01, + "bidfloorcur": "USD", + "id": "2" + } + ], + "site": { + "id": "fc59bd54-36df-4d33-830c-fdsfds", + "domain": "epom.com", + "privacypolicy": 0, + "publisher": { + "id": "testid" + }, + "content": { + "id": "1234567", + "episode": 23, + "title": "Car Show", + "series": "All About Cars", + "season": "2", + "cat": [ + "IAB2-2" + ] + } + }, + "device": { + "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36", + "geo": { + "country": "UKR", + "region": "", + "city": "" + }, + "ip": "176.112.120.50", + "devicetype": 2, + "os": "windows", + "osv": "", + "js": 1, + "language": "US", + "carrier": "VERIZON", + "connectiontype": 5, + "ifa": "AA000DFE74168477C70D291f574D344790E0BB11" + }, + "user": { + "id": "testiduser" + }, + "test": 0, + "at": 2, + "allimps": 0, + "cur": [ + "USD" + ], + "bcat": [ + "IAB25-2", + "IAB25-1" + ], + "badv": [], + "id": "NewIdTest" } ] } From ff9a46ab84a011a5856899e52f566725f4437cba Mon Sep 17 00:00:00 2001 From: Vladyslav Date: Fri, 30 May 2025 13:23:29 +0300 Subject: [PATCH 3/4] update doc --- dev-docs/bidders/epomDspBidAdapter.md | 267 ++++++++++++++------------ 1 file changed, 146 insertions(+), 121 deletions(-) diff --git a/dev-docs/bidders/epomDspBidAdapter.md b/dev-docs/bidders/epomDspBidAdapter.md index 81dc74682c..4c2e8935e7 100644 --- a/dev-docs/bidders/epomDspBidAdapter.md +++ b/dev-docs/bidders/epomDspBidAdapter.md @@ -1,145 +1,170 @@ --- + layout: bidder title: Epom DSP description: Prebid Epom DSP Bid Adapter -biddercode: epom_dsp -tcfeu_supported: true -gvl_id: none -usp_supported: true -coppa_supported: false -gpp_sids: tcfeu, usnat -schain_supported: true -dchain_supported: false +biddercode: epom\_dsp +tcfeu\_supported: true +gvl\_id: none +usp\_supported: true +coppa\_supported: false +gpp\_sids: tcfeu, usnat +schain\_supported: true +dchain\_supported: false userId: none -media_types: banner -safeframes_ok: true -deals_supported: true -floors_supported: true -fpd_supported: false +media\_types: banner +safeframes\_ok: true +deals\_supported: true +floors\_supported: true +fpd\_supported: false pbjs: true pbs: false -prebid_member: false -multiformat_supported: will-bid-on-one -ortb_blocking_supported: false -privacy_sandbox: no +prebid\_member: false +multiformat\_supported: will-bid-on-one +ortb\_blocking\_supported: false +privacy\_sandbox: no sidebarType: 1 ---- +-------------- ## Overview -The **Epom DSP Bid Adapter** allows publishers to connect with the Epom DSP Exchange for programmatic advertising. It supports banner formats and adheres to the OpenRTB protocol. +The **Epom DSP Bid Adapter** enables publishers to monetize inventory via the Epom DSP Exchange using the OpenRTB protocol. It supports **banner media types** and enforces required fields to ensure bid validity and proper auction participation. + +--- + +## Bid Parameters -## Bid Params +| Name | Scope | Description | Example | Type | +| ------------- | -------- | --------------------------------------------------------------- | ------------------------------------------------------------------ | -------- | +| `endpoint` | required | Full URL to the Epom DSP bidding endpoint | `'https://bidder.epommarket.com/bidder/v2_5/bid?key=your_api_key'` | `string` | +| `placementId` | optional | Placement identifier provided by Epom | `'12345'` | `string` | +| `bidfloor` | optional | Minimum CPM for bid, in USD (unless FX enabled on tenant level) | `0.50` | `number` | -{: .table .table-bordered .table-striped } -| Name | Scope | Description | Example | Type | -|------------|---------|----------------------------------|---------|--------| -| `endpoint` | required | The URL of the Epom DSP bidding endpoint | `'https://bidder.epommarket.com/bidder/v2_5/bid?key=your_api_key'` | `string` | -| `placementId` | optional | Unique identifier for the placement | `'12345'` | `string` | -| `bidfloor` | optional | Minimum CPM value for the bid in USD | `0.5` | `number` | +--- -## Example Configuration +## Example Ad Unit Configuration ```javascript - var adUnits = [ - { - code: 'epom-banner-div', - mediaTypes: { - banner: { - sizes: [ - [300, 250] - ] - } - }, - bids: [ - { - bidder: 'epom_dsp', - params: { - endpoint: 'https://bidder.epommarket.com/bidder/v2_5/bid?key=d0b9fb9de9dfbba694dfe75294d8e45a' - }, - "imp": [ - { - "banner": { - "w": 300, - "h": 250, - "btype": [ - 4 - ], - "pos": 0, - "api": [ - 3 - ] - }, - "instl": 0, - "tagid": "test4", - "bidfloor": 0.01, - "bidfloorcur": "USD", - "id": "2" - } - ], - "site": { - "id": "fc59bd54-36df-4d33-830c-fdsfds", - "domain": "epom.com", - "privacypolicy": 0, - "publisher": { - "id": "testid" - }, - "content": { - "id": "1234567", - "episode": 23, - "title": "Car Show", - "series": "All About Cars", - "season": "2", - "cat": [ - "IAB2-2" - ] - } - }, - "device": { - "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36", - "geo": { - "country": "UKR", - "region": "", - "city": "" - }, - "ip": "176.112.120.50", - "devicetype": 2, - "os": "windows", - "osv": "", - "js": 1, - "language": "US", - "carrier": "VERIZON", - "connectiontype": 5, - "ifa": "AA000DFE74168477C70D291f574D344790E0BB11" - }, - "user": { - "id": "testiduser" - }, - "test": 0, - "at": 2, - "allimps": 0, - "cur": [ - "USD" - ], - "bcat": [ - "IAB25-2", - "IAB25-1" - ], - "badv": [], - "id": "NewIdTest" - } - ] +var adUnits = [{ + code: 'epom-banner-div', + mediaTypes: { + banner: { + sizes: [[300, 250]] } -]; + }, + bids: [{ + bidder: 'epom_dsp', + params: { + endpoint: 'https://bidder.epommarket.com/bidder/v2_5/bid?key=d0b9fb9de9dfbba694dfe75294d8e45a' + }, + imp: [{ + id: '2', + banner: { + w: 300, + h: 250, + btype: [4], + pos: 0, + api: [3] + }, + bidfloor: 0.01, + bidfloorcur: 'USD' + }], + site: { + id: 'fc59bd54-36df-4d33-830c-fdsfds', + domain: 'epom.com', + publisher: { + id: 'testid' + }, + content: { + id: '1234567', + title: 'Car Show', + series: 'All About Cars', + season: '2', + cat: ['IAB2-2'] + } + }, + device: { + ua: navigator.userAgent, + ip: '176.112.120.50', + devicetype: 2, + os: 'windows', + js: 1, + language: 'US', + carrier: 'VERIZON', + connectiontype: 5 + }, + user: { + id: 'testiduser' + }, + id: 'NewIdTest', + cur: ['USD'], + bcat: ['IAB25-2', 'IAB25-1'], + badv: [] + }] +}]; ``` -## GDPR and Privacy Compliance +--- + +## Required Fields for Bid Request Validation + +To be considered **valid**, a bid request must include the following: + +| Field | Location | Description | +| ------------- | ------------- | --------------------------------------------------------------------- | +| `request.id` | root | Unique ID for the request | +| `imp[]` | root | Must contain at least one impression object | +| `imp[i].id` | imp object | Unique impression ID | +| `site.domain` | site object | Must be present (or `app.bundle` if app-based) | +| `device.ip` | device object | Device IP address (required unless IP forwarding feature is disabled) | +| `cur[]` | root | Must be `['USD']` unless currency FX is enabled on tenant level | + +If any of the above is missing or malformed, the bid request will be **rejected** by the adapter during validation (`isBidRequestValid`). + +--- + +## Privacy Compliance + +The Epom DSP adapter supports the following privacy frameworks: + +* **GDPR**: via `bidderRequest.gdprConsent.consentString` +* **US Privacy (CCPA)**: via `bidderRequest.uspConsent` +* **GPP**: Supports `tcfeu` and `usnat` sections + +--- -The **Epom DSP Bid Adapter** supports GDPR and CCPA compliance. Consent information can be passed via: +## Testing & Debugging -- `bidderRequest.gdprConsent` -- `bidderRequest.uspConsent` +To test integration, use a configuration similar to this inside a local HTML page with Prebid.js: + +```html + + +``` + +--- ## Support -For integration assistance, contact [Epom Support](mailto:support@epom.com). +For questions or assistance integrating Epom DSP into your Prebid setup, please contact: +📩 [support@epom.com](mailto:support@epom.com) From 2db847e638f7e73b2ee425d656e00bb7314cb4c9 Mon Sep 17 00:00:00 2001 From: Vladyslav Date: Tue, 10 Jun 2025 11:50:54 +0300 Subject: [PATCH 4/4] fix markup --- dev-docs/bidders/epomDspBidAdapter.md | 145 +++++++++++++------------- 1 file changed, 72 insertions(+), 73 deletions(-) diff --git a/dev-docs/bidders/epomDspBidAdapter.md b/dev-docs/bidders/epomDspBidAdapter.md index 4c2e8935e7..3449f30508 100644 --- a/dev-docs/bidders/epomDspBidAdapter.md +++ b/dev-docs/bidders/epomDspBidAdapter.md @@ -1,30 +1,29 @@ --- - layout: bidder title: Epom DSP description: Prebid Epom DSP Bid Adapter -biddercode: epom\_dsp -tcfeu\_supported: true -gvl\_id: none -usp\_supported: true -coppa\_supported: false -gpp\_sids: tcfeu, usnat -schain\_supported: true -dchain\_supported: false +biddercode: epom_dsp +tcfeu_supported: true +gvl_id: none +usp_supported: true +coppa_supported: false +gpp_sids: tcfeu, usnat +schain_supported: true +dchain_supported: false userId: none -media\_types: banner -safeframes\_ok: true -deals\_supported: true -floors\_supported: true -fpd\_supported: false +media_types: banner +safeframes_ok: true +deals_supported: true +floors_supported: true +fpd_supported: false pbjs: true pbs: false -prebid\_member: false -multiformat\_supported: will-bid-on-one -ortb\_blocking\_supported: false -privacy\_sandbox: no +prebid_member: false +multiformat_supported: will-bid-on-one +ortb_blocking_supported: false +privacy_sandbox: no sidebarType: 1 --------------- +--- ## Overview @@ -46,61 +45,61 @@ The **Epom DSP Bid Adapter** enables publishers to monetize inventory via the Ep ```javascript var adUnits = [{ - code: 'epom-banner-div', - mediaTypes: { - banner: { - sizes: [[300, 250]] - } - }, - bids: [{ - bidder: 'epom_dsp', - params: { - endpoint: 'https://bidder.epommarket.com/bidder/v2_5/bid?key=d0b9fb9de9dfbba694dfe75294d8e45a' - }, - imp: [{ - id: '2', - banner: { - w: 300, - h: 250, - btype: [4], - pos: 0, - api: [3] - }, - bidfloor: 0.01, - bidfloorcur: 'USD' - }], - site: { - id: 'fc59bd54-36df-4d33-830c-fdsfds', - domain: 'epom.com', - publisher: { - id: 'testid' - }, - content: { - id: '1234567', - title: 'Car Show', - series: 'All About Cars', - season: '2', - cat: ['IAB2-2'] - } - }, - device: { - ua: navigator.userAgent, - ip: '176.112.120.50', - devicetype: 2, - os: 'windows', - js: 1, - language: 'US', - carrier: 'VERIZON', - connectiontype: 5 - }, - user: { - id: 'testiduser' + code: 'epom-banner-div', + mediaTypes: { + banner: { + sizes: [[300, 250]] + } }, - id: 'NewIdTest', - cur: ['USD'], - bcat: ['IAB25-2', 'IAB25-1'], - badv: [] - }] + bids: [{ + bidder: 'epom_dsp', + params: { + endpoint: 'https://bidder.epommarket.com/bidder/v2_5/bid?key=d0b9fb9de9dfbba694dfe75294d8e45a' + }, + imp: [{ + id: '2', + banner: { + w: 300, + h: 250, + btype: [4], + pos: 0, + api: [3] + }, + bidfloor: 0.01, + bidfloorcur: 'USD' + }], + site: { + id: 'fc59bd54-36df-4d33-830c-fdsfds', + domain: 'epom.com', + publisher: { + id: 'testid' + }, + content: { + id: '1234567', + title: 'Car Show', + series: 'All About Cars', + season: '2', + cat: ['IAB2-2'] + } + }, + device: { + ua: navigator.userAgent, + ip: '176.112.120.50', + devicetype: 2, + os: 'windows', + js: 1, + language: 'US', + carrier: 'VERIZON', + connectiontype: 5 + }, + user: { + id: 'testiduser' + }, + id: 'NewIdTest', + cur: ['USD'], + bcat: ['IAB25-2', 'IAB25-1'], + badv: [] + }] }]; ```