From 9fed91178b48fc95fd6ad9e5ded3a1da2e2bd4f9 Mon Sep 17 00:00:00 2001 From: Patrick McCann Date: Tue, 27 May 2025 05:33:59 -0400 Subject: [PATCH] docs(prebid-mobile): fix markdownlint issues --- .../android-sdk-integration-gam-native.md | 2 +- .../rendering/ios-sdk-integration-gam-native.md | 2 +- .../modules/rendering/rendering-deeplinkplus.md | 17 ++++++++--------- .../pbm-api/android/pbm-util-android.md | 4 +--- .../pbm-api/ios/code-integration-ios.md | 2 +- prebid-mobile/pbm-api/ios/pbm-util-ios.md | 2 +- .../prebid-mobile-privacy-regulation.md | 1 + 7 files changed, 14 insertions(+), 16 deletions(-) diff --git a/prebid-mobile/modules/rendering/android-sdk-integration-gam-native.md b/prebid-mobile/modules/rendering/android-sdk-integration-gam-native.md index 2211345625..091c282435 100644 --- a/prebid-mobile/modules/rendering/android-sdk-integration-gam-native.md +++ b/prebid-mobile/modules/rendering/android-sdk-integration-gam-native.md @@ -157,7 +157,7 @@ private fun createNativeAdConfiguration(): NativeAdConfiguration { } ``` -See more NativeAdConfiguration options [here](rendering-native-ad-configuration.html). +See more NativeAdConfiguration options in the [NativeAdConfiguration guide](rendering-native-ad-configuration.html). ### Step 4: Load the Ad diff --git a/prebid-mobile/modules/rendering/ios-sdk-integration-gam-native.md b/prebid-mobile/modules/rendering/ios-sdk-integration-gam-native.md index 1b378f87d3..7f99f2ac6f 100644 --- a/prebid-mobile/modules/rendering/ios-sdk-integration-gam-native.md +++ b/prebid-mobile/modules/rendering/ios-sdk-integration-gam-native.md @@ -173,7 +173,7 @@ let assets = [ ] ``` -See the full description of NativeAdConfiguration options [here](rendering-native-ad-configuration.md). +See the full description of NativeAdConfiguration options in the [NativeAdConfiguration guide](rendering-native-ad-configuration.md). ### Step 4: Load the Ad diff --git a/prebid-mobile/modules/rendering/rendering-deeplinkplus.md b/prebid-mobile/modules/rendering/rendering-deeplinkplus.md index 4b5d8c943d..b0364bfada 100644 --- a/prebid-mobile/modules/rendering/rendering-deeplinkplus.md +++ b/prebid-mobile/modules/rendering/rendering-deeplinkplus.md @@ -19,10 +19,10 @@ Deep Link+ provides a premium user experience while letting advertisers scale re The new deeplinking format enables buyers to submit: - * primary URL - * fallback URL - * primary tracking URL - * fallback tracking URL +* primary URL +* fallback URL +* primary tracking URL +* fallback tracking URL And since Deep Link+ is built into the SDK, there is no need to pop up browser windows and re-directs that deteriorate the user experience. @@ -32,12 +32,11 @@ The schema is supported for both kinds of ads - video and display. The JSTag integration is not supported yet. - ## How it works - DSPs should rely on the SDK version in the bid request: -``` + +```json "displaymanagerver": "4.11.0" ``` @@ -45,7 +44,7 @@ Starting with version 4.11.0 Android SDK supports deeplink+ To leverage the retargeting campaigns buyers use a specific scheme as click URL in the ad response. That URL describes the deep-linking and failover logic: -``` +```text deeplink+://navigate? primaryUrl=PRIMARY_DEEPLINK& primaryTrackingUrl=PRIMARY_TRACKER& @@ -59,7 +58,7 @@ The `fallbackUrl` can be any supported URI type (e.g., http, traditional deeplin For example, below is a Deep Link+ URL whose primary target is the Twitter app, with two (2) primary tracker URLs, a fallback URL directing the user to Twitter’s mobile website if the primary deeplink fails and zero (0) fallback tracker URLs: -``` +```text deeplink+://navigate? primaryUrl=twitter%3A%2F%2Ftimeline& primaryTrackingUrl=http%3A%2F%2Fmopub.com%2Fclicktracking& diff --git a/prebid-mobile/pbm-api/android/pbm-util-android.md b/prebid-mobile/pbm-api/android/pbm-util-android.md index a5c02d08aa..f093ffbb9c 100755 --- a/prebid-mobile/pbm-api/android/pbm-util-android.md +++ b/prebid-mobile/pbm-api/android/pbm-util-android.md @@ -16,11 +16,10 @@ This page will store any utilities that can used in conjuntion with the Prebid S {:toc} ## Find Prebid Creative Size -Prebid SDK provides a function `findPrebidCreativeSize` to address a bug in the Google Ad Manager ad server (described [here](https://groups.google.com/forum/?utm_medium=email&utm_source=footer#!category-topic/google-admob-ads-sdk/ios/648jzAP2EQY)) where under certain situations ads fail to render. +Prebid SDK provides a function `findPrebidCreativeSize` to address a bug in the Google Ad Manager ad server (described in [this Google forum thread](https://groups.google.com/forum/?utm_medium=email&utm_source=footer#!category-topic/google-admob-ads-sdk/ios/648jzAP2EQY)) where under certain situations ads fail to render. It is recommended all Google Ad Manager integrations resize all ads served based on the winning Prebid creative size `findPrebidCreativeSize`. Functionally speaking the Prebid SDK resizes ad slots based on the [onAdLoaded](https://developers.google.com/android/reference/com/google/android/gms/ads/AdListener.html#onAdLoaded()) (when an ad is received) to determine the winning Prehbid ad size to determine how to resize the ad slot. - {% include alerts/alert_note.html content="`findPrebidCreativeSize` is supported on Android API versions 19+. Using on earlier versions is safe to use, however the resizing would not function." %} Usage example: @@ -43,4 +42,3 @@ adView.adListener = object : AdListener() { } } ``` - diff --git a/prebid-mobile/pbm-api/ios/code-integration-ios.md b/prebid-mobile/pbm-api/ios/code-integration-ios.md index 6f0b421cc8..15658748ab 100644 --- a/prebid-mobile/pbm-api/ios/code-integration-ios.md +++ b/prebid-mobile/pbm-api/ios/code-integration-ios.md @@ -221,7 +221,7 @@ As part of Apple's evolving privacy policies, SDKs that access user data in a wa Currently, the Prebid Mobile SDK is not classified as one of these SDKs. But future changes from Apple or internal app review policies may prompt publishers to proactively register the Prebid Server (PBS) endpoint in the privacy manifest. To support this, the Prebid SDK is designed to accommodate both tracking and non-tracking PBS domains. Here are the Prebid recommendations: -- Include the relevant `NSPrivacyCollectedDataTypes` and define your primary Prebid Server domain in the `NSPrivacyTrackingDomains` array in your the `PrivacyInfo.xcprivacy` file to cover a potential "worst case" scenario. Read more about the `PrivacyInfo.xcprivacy` data [here](https://docs.prebid.org/faq/prebid-mobile-faq.html#privacysecurity). +- Include the relevant `NSPrivacyCollectedDataTypes` and define your primary Prebid Server domain in the `NSPrivacyTrackingDomains` array in your the `PrivacyInfo.xcprivacy` file to cover a potential "worst case" scenario. Read more about the `PrivacyInfo.xcprivacy` data in the [Prebid Mobile FAQ](https://docs.prebid.org/faq/prebid-mobile-faq.html#privacysecurity). - You may choose to provide a secondary, privacy-mode PBS URL to the SDK. This secondary domain can be used when tracking is disallowed. Get this additional hostname from your Prebid Server host provider. Every initialization method contains optional parameter to define this privacy-safe PBS domain. Since these requests will have the `limit ad tracking` flag defined, Prebid Server will anonymize the requests. You’re not required to use a secondary PBS domain -- you can simply allow iOS to block PBS requests when the user opts out of tracking. diff --git a/prebid-mobile/pbm-api/ios/pbm-util-ios.md b/prebid-mobile/pbm-api/ios/pbm-util-ios.md index afdc97915d..4ebfb2de3c 100755 --- a/prebid-mobile/pbm-api/ios/pbm-util-ios.md +++ b/prebid-mobile/pbm-api/ios/pbm-util-ios.md @@ -17,7 +17,7 @@ This page will store any utilities that can used in conjuntion with the Prebid S ## Find Prebid Creative Size -Prebid SDK provides a function `findPrebidCreativeSize` to address a bug in the Google Ad Manager ad server (described [here](https://groups.google.com/forum/?utm_medium=email&utm_source=footer#!category-topic/google-admob-ads-sdk/ios/648jzAP2EQY)) where under certain situations ads fail to render. +Prebid SDK provides a function `findPrebidCreativeSize` to address a bug in the Google Ad Manager ad server (described in [this Google forum thread](https://groups.google.com/forum/?utm_medium=email&utm_source=footer#!category-topic/google-admob-ads-sdk/ios/648jzAP2EQY)) where under certain situations ads fail to render. It is recommended all Google Ad Manager integrations resize all ads served based on the winning Prebid creative size `findPrebidCreativeSize`. Functionally speaking the Prebid SDK resizes ad slots based on the [adViewDidReceiveAd event](https://developers.google.com/admob/ios/banner) (when an ad is received) to determine the winning Prehbid ad size to determine how to resize the ad slot. diff --git a/prebid-mobile/prebid-mobile-privacy-regulation.md b/prebid-mobile/prebid-mobile-privacy-regulation.md index 4171f381ca..368e536103 100644 --- a/prebid-mobile/prebid-mobile-privacy-regulation.md +++ b/prebid-mobile/prebid-mobile-privacy-regulation.md @@ -57,6 +57,7 @@ To ensure proper monetization and relevant targeting, the SDK should be enabled - Describing the actions taken for the different purposeConsents values in combination with consentRequired values. {: .table .table-bordered .table-striped } + | | deviceAccessConsent= true | deviceAccessConsent= false | deviceAccessConsent= undefined | |---------------------|------------------------------|--------------------------------|---------------------------------------| |consentRequired=false
(gdprApplies = false)|The SDK will read and pass IDFA/AAID info to server. |The SDK will **not** read and pass IDFA/AAID info to server. | The SDK will read and pass IDFA/AAID info to server.|