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

Adding documentation for the Mobian RTD module for docs.prebid.org #5775

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

richmtk
Copy link

@richmtk richmtk commented Dec 12, 2024

🏷 Type of documentation

  • [ X] text edit only (wording, typos)

📋 Checklist

Copy link

netlify bot commented Dec 12, 2024

Deploy Preview for prebid-docs-preview ready!

Name Link
🔨 Latest commit 31623ff
🔍 Latest deploy log https://app.netlify.com/sites/prebid-docs-preview/deploys/6776b73eb88d110008598e7d
😎 Deploy Preview https://deploy-preview-5775--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.


Module Type: Rtd Provider

Maintainer: <[email protected]>
Copy link
Contributor

Choose a reason for hiding this comment

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

@richmtk - we can't allow individual email addresses as maintainers. People move around in ad tech a lot. Please supply a group address like "[email protected]", "[email protected]", or something along those lines. It can be an existing support alias in your company.


Maintainer: <[email protected]>

The Mobian Real-Time Data (RTD) Module is a plug-and-play Prebid.js adapter that is designed to provide Mobian Contextual results on the publisher’s page.
Copy link
Contributor

Choose a reason for hiding this comment

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

The title of this document is "Brand Safety Evaluation". Please help the read understand how this module helps publishers with brand safety. This sentence talks about "Mobian Contextual results", not mentioning "brand safety" at all.

Please avoid marketing superlatives like "best" or "fastest". Just describe what it does. Perhaps move the description below in the "Functionality" section?


## Downloading and Configuring the Mobian RTD module

Navigate to <https://docs.prebid.org/download.html> and check the box labeled Mobian Prebid Contextual Evaluation. If you have installed Prebid.js on your site previously, please be sure to select any other modules and adaptors to suit your needs. When clicking the "Get Prebid.js" button at the bottom of the page, the site will build a version of Prebid.js with all of your selections.
Copy link
Contributor

Choose a reason for hiding this comment

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

Again, the title here has been changed to "Brand Safety Evaluation", but the reference here is to "Mobian Prebid Contextual Evaluation". Please make this consistent.


NOTE: The examples below for targetable keys for GAM or otherwise in the ortb2 object assume that your prefix is the default of "mobian". The prefix in the targetable key will change based on your settings.

Risk:
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 an informative section, but the formatting could be a better. See https://deploy-preview-5775--prebid-docs-preview.netlify.app/dev-docs/modules/mobianrtdprovider

I would suggest having each of these be a heading. e.g.

Classification: Risk

This category assesses whether content contains any potential risks or concerns to advertisers and returns a determination of Low Risk, Medium Risk, or High Risk based on the inclusion of sensitive or high-risk topics. Content that might be categorized as unsafe may include violence, hate speech, misinformation, or sensitive topics that most advertisers would like to avoid. Content that is explicit or overly graphic in nature will be more likely to fall into the High Risk tier compared to content that describes similar subjects in a more informative or educational manner.

  • Targetable Key: mobian_risk
  • Possible values: "none", "low", "medium" or "high"

(What is the "Prebid.outcomes.net endpoint key"? Is it something the publisher has to care about?)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants