Skip to content

Mobile: UI/UX policy#6204

Merged
muuki88 merged 16 commits intomasterfrom
mobile-ui-ux-policy
Aug 19, 2025
Merged

Mobile: UI/UX policy#6204
muuki88 merged 16 commits intomasterfrom
mobile-ui-ux-policy

Conversation

@YuriyVelichkoPI
Copy link
Contributor

Description

This doc will serve as a public spec of Mobile SDK UI/UX policy.

It describes how UI/UX is currently implemented. What is the default behaviour and how publishers can customize it if needed.

Eventually this doc will be changed if new UI/UX features are added to the SDK.

Publishers can use this doc in two ways:

  • Study the behaviour and customization options
  • Propose new policies and features.

🏷 Type of documentation

  • [ x] new examples

📋 Checklist

Closes prebid/prebid-mobile-ios#693

@netlify
Copy link

netlify bot commented Aug 12, 2025

Deploy Preview for prebid-docs-preview ready!

Name Link
🔨 Latest commit f089166
🔍 Latest deploy log https://app.netlify.com/projects/prebid-docs-preview/deploys/68a48404bf303f000860311a
😎 Deploy Preview https://deploy-preview-6204--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 project configuration.

| Policy | Behavior | Customization |
|--------|-----------|---------------|
|`Reward`|**Prebid SDK** can signal the publisher about the type and quantity of reward coins.<br><br> If the `rwdd` or `reward` object is absent in the response, by **default,** SDK will send an empty object into the respective delegate method. |**Publisher** can set the type and number of coins in the `rwdd.reward` object.|
|`Completion`|**Prebid SDK** will inform the application once the reward time has come.<br><br> If the `rwdd` or `reward` object is absent in the response, by **default,** <br><br>- **banner:** SDK triggers the completion of the banner rewarded ad after **120 seconds** on the screen.<br><br>- **video:** SDK triggers the completion of the rewarded ad once the video playback is completed. But only if the ad doesn’t have an end card. | **Publisher** can set the rule when the SDK should inform the app about the reward time. Depending on the ad format, the publisher can set different rules using `rwdd.completion.banner` and `rwdd.completion.banner` objects respectively.|
Copy link
Collaborator

Choose a reason for hiding this comment

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

set different rules using rwdd.completion.banner and rwdd.completion.banner

probably you meant rwdd.completion.banner and reward.completion.banner ?

| `Rotation` | **Prebid SDK** allows the rotation of the screen for the interstitial ads. The ad content is rotated according to the screen position. SDK changes the layout of the ad control elements according to the screen orientation. <br><br> **Publisher** has nothing to do in this operation, SDK doesn't provide any events to subscribe. | Currently, there is no way to customize the rotation behavior of the interstitial ads. Open an issue or PR for the alternative approach.|
| `Close Button` | **Prebid SDK** adds a close button to the interstitial ad, providing a way for users to dismiss the fullscreen ad. Depending on the ad format, the button can appear from the very beginning of the ad or with some delay. <br><br> **Publisher** is responsible for subscribing to the ad flow events and managing the app flow, accordingly. | **Publisher** can customize the default SDK behavior using the [Ad Experience Controls](https://docs.prebid.org/prebid-mobile/modules/rendering/combined-ad-experience-controls.html) feature.|
| `Learn More Button` | **Prebid SDK** adds a close button to the interstitial ad, providing a way for users to dismiss the fullscreen ad. Depending on the ad format, the button can appear from the very beginning of the ad or with some delay. <br><br> **Publisher** is responsible for subscribing to the ad flow events and managing the app flow, accordingly. |**Publisher** can customize the default SDK behavior using [Ad Experience Controls](https://docs.prebid.org/prebid-mobile/modules/rendering/combined-ad-experience-controls.html)|
| `Tap` | **Prebid SDK** processes the clicks, actually taps, in different ways, respectively, depending on the type of the ad. <br> **The publisher** is responsible for handling `adwillopen` delegate. |Currently, there is no way to customize the way of processing the taps on the ad. Open an issue or PR for the alternative approach.|
Copy link
Collaborator

Choose a reason for hiding this comment

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

handling adwillopen delegate.

should we add link to the doc as you did for banner autorefresh property ?

Copy link
Contributor

@muuki88 muuki88 left a comment

Choose a reason for hiding this comment

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

Please use relative links whenever possible, so that links also properly work in stage deployments 😊

I know we have a lot of <br> tags floating around in the docs. Usually I recommend to avoid those.

Co-authored-by: Muki Seiler <muuki88@users.noreply.github.com>
@YuriyVelichkoPI
Copy link
Contributor Author

Hi @muuki88

I know we have a lot of <br> tags floating around in the docs. Usually I recommend to avoid those.

Could you suggest an alternative method for adding an empty line within a table cell? I tried "" but without success.

@muuki88
Copy link
Contributor

muuki88 commented Aug 13, 2025

I haven't found one 🥲 Ideally we would find an alternative, but at this point it's okay to have them, if the docs are unreadable otherwise.

@muuki88
Copy link
Contributor

muuki88 commented Aug 18, 2025

Hi @YuriyVelichkoPI

I would commit all the suggestions, using relative links and then merge this. Fine for you? 😊

@YuriyVelichkoPI
Copy link
Contributor Author

YuriyVelichkoPI commented Aug 18, 2025

Hi @YuriyVelichkoPI

I would commit all the suggestions, using relative links and then merge this. Fine for you? 😊

Hi @muuki88 ! Yes, I'm ok to use relative links, but just want to make sure that you read this and this comment and are aware that in fact they are external links. So everyone is on the same page

@muuki88 muuki88 merged commit 8e57b7e into master Aug 19, 2025
2 checks passed
@muuki88 muuki88 deleted the mobile-ui-ux-policy branch August 19, 2025 14:03
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.

[DOC] Public policy for UI/UX appearance and behaviour

3 participants