Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

EXADS Bid Adapter: initial release #5237

Merged
merged 9 commits into from
May 5, 2024
Merged

EXADS Bid Adapter: initial release #5237

merged 9 commits into from
May 5, 2024

Conversation

giuseppe-exads
Copy link
Contributor

@giuseppe-exads giuseppe-exads commented Apr 3, 2024

🏷 Type of documentation

  • new bid adapter
  • update bid adapter
  • new feature
  • text edit only (wording, typos)
  • bugfix (code examples)
  • new examples

📋 Checklist

Copy link

netlify bot commented Apr 3, 2024

Deploy Preview for prebid-docs-preview ready!

Name Link
🔨 Latest commit fb92539
🔍 Latest deploy log https://app.netlify.com/sites/prebid-docs-preview/deploys/6619218b024870000860c388
😎 Deploy Preview https://deploy-preview-5237--prebid-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

dev-docs/bidders/exadsadserver.md Show resolved Hide resolved
Comment on lines 57 to 84
#### 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
},
},
},
},
});
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is prebid core related stuff and shouldn't be part of the adapter. The danger that this gets stale is pretty high

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed all General settings section

Comment on lines 92 to 115
```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',
},
},
},
},
],
},
});
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this specific to your adapter? Otherwise if this is already present in the prebid docs, I would remove it as well

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed this example code. It is not specific to our adapter.


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>.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use relative links to make them correct in every environment.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry @muuki88, what do you mean? The unique url that I'm using here is related to the prebid doc. Are there different environments for it? Probably I missed something.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi ☺️

Use links like this /dev-docs/... , not a full URL

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

* **w** - width of the image in pixels, optional (integer)
* **h** - height of the image in pixels, optional (integer)

##### DSA
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I appreciate you documenting that you support DSA. IMHO a link to https://github.com/InteractiveAdvertisingBureau/openrtb/blob/main/extensions/community_extensions/dsa_transparency.md should be enough and dsa_supported: true in the meta data

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed all dsa documentation sections.

gvl_id: 1084
tcfeu_supported: true
media_types: banner, video, native
gpp_sids: tcfeu
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I confirm that for now we'll support only gdpr. Removed gpp_sids param.

* fix: related to markdown lint validation

* fix: from code review

* fix: from code review
* fix: related to markdown lint validation

* fix: from code review

* fix: from code review

* fix: from CR
@giuseppe-exads
Copy link
Contributor Author

Hi @muuki88, do you have some updates about the review? In the mean time the code PR was merged into master.

@muuki88 muuki88 merged commit 891d45b into prebid:master May 5, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants