Combined iOS and Android ad experience controls documentation into a single file #5150
Conversation
✅ Deploy Preview for prebid-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Thanks @charles-the-developer . We also have a preview link automatically created for each PR 😃 See #5150 (comment) For the other two questions, can you help @YuriyVelichkoPI ? |
There was a problem hiding this comment.
Love it. Thanks @charles-the-developer . I think we should remove the separate files and change the left-nav links to point to the combined file.
|
|
||
| If you use Prebid SDK to render the winning bid you can customize behaviour using the following API. | ||
|
|
||
| > NOTE: Planned future enhancements will support Server Side Configuration. Follow this [feature request](https://github.com/prebid/prebid-server/issues/2186) for the details. |
There was a problem hiding this comment.
@YuriyVelichkoPI - I assume this is the bidrequest.ext.prebid.passthrough feature? Is there anything in this doc that should change as a result of this being done in PBS now besides removing this note?
There was a problem hiding this comment.
Hi @bretg ! Yes it is about bidrequest.ext.prebid.passthrough. And yes - the doc should contain config keys to change the properties via passthrough. Missing this info in the documentation is our gap. I'll create a ticket to highlight the changes.
There was a problem hiding this comment.
Basically, the properties are already in the doc. They are listed in the Server Property row for each section. But we still should remove (pending for PBS implementation) text for them.
There was a problem hiding this comment.
Just for your info. It is not common for mobile SDK docs to merge functional documentation. As usual, documentation for iOS and Android lives in separate sections. Even if it is super similar. Maybe it because developers don't like to jump over their scope.
Examples:
MAX:
Android: https://dash.applovin.com/documentation/mediation/android/getting-started/integration
iOS: https://dash.applovin.com/documentation/mediation/ios/getting-started/integration
GMA SDK (both for AdMob and GAM integration):
Android: https://developers.google.com/ad-manager/mobile-ads-sdk/android/quick-start
iOS: https://developers.google.com/ad-manager/mobile-ads-sdk/ios/quick-start
ironSource
Android: https://developers.is.com/ironsource-mobile/android/getting-started-android/
iOS: https://developers.is.com/ironsource-mobile/ios/getting-started-ios/
Smaato
Android: https://developers.smaato.com/publishers/nextgen-sdk-android-getting-started/
iOS: https://developers.smaato.com/publishers/nextgen-sdk-ios-getting-started/
All of these don't have common pages. Especially pages with both iOS and Android code together.
So such changes will be unusual for mobile developers.
|
|
||
| If you use Prebid SDK to render the winning bid you can customize behaviour using the following API. | ||
|
|
||
| > NOTE: Planned future enhancements will support Server Side Configuration. Follow this [feature request](https://github.com/prebid/prebid-server/issues/2186) for the details. |
There was a problem hiding this comment.
Basically, the properties are already in the doc. They are listed in the Server Property row for each section. But we still should remove (pending for PBS implementation) text for them.
Yuriy and I discussed this. We agreed that certain pages (e.g the general integration guides for each platform like https://docs.prebid.org/prebid-mobile/pbm-api/ios/code-integration-ios.html) need to be standalone, but that the "recipe" pages can be combined. |
There was a problem hiding this comment.
I updated the PR:
- removed the previously separate files
- added link to the left nav
- removed the "pending" note
Note that the side effect of the combined file is that BOTH iOS and Android left nav entries are opened when looking at this file in preview. I think that's ok.
@YuriyVelichkoPI brought up that really the image examples should have an Android version and an iOS version. It's hard for me to see the difference in the currently live pages so I'm considering this a low priority.
I'm good to merge this with the understanding that @YuriyVelichkoPI will update at some point to describe how the passthrough feature works.
I have implemented tabs to merge the iOS and Android ad experience controls documentation into a single file
combined-ad-experience-controls.md.I have a couple of questions/notes: