MediationAdConfiguration

Kotlin |Java

@ParametersAreNonnullByDefault
class MediationAdConfiguration

Known direct subclasses

MediationAppOpenAdConfiguration, MediationBannerAdConfiguration, MediationInterstitialAdConfiguration, MediationNativeAdConfiguration, MediationRewardedAdConfiguration

MediationAppOpenAdConfiguration	Data used to render mediation app open ads.
MediationBannerAdConfiguration	Data used to render mediation banner ads.
MediationInterstitialAdConfiguration	Data used to render mediation interstitial ads.
MediationNativeAdConfiguration	Data used to render mediation native ads.
MediationRewardedAdConfiguration	Data used to render mediation rewarded ads.

---

Data used to render mediation ads.

Summary

Nested types
@Retention(value = SOURCE) @IntDef(value = ) annotation MediationAdConfiguration.TagForChildDirectedTreatment Tag for child directed treatment.

Constants
const Int	TAG_FOR_CHILD_DIRECTED_TREATMENT_FALSE = 0 As returned by taggedForChildDirectedTreatment, indicates that the app should not be treated as child-directed for purposes of the Children’s Online Privacy Protection Act (COPPA).
const Int	TAG_FOR_CHILD_DIRECTED_TREATMENT_TRUE = 1 As returned by taggedForChildDirectedTreatment, indicates that the app should be treated as child-directed for purposes of the Children’s Online Privacy Protection Act (COPPA).
const Int	TAG_FOR_CHILD_DIRECTED_TREATMENT_UNSPECIFIED = -1 As returned by taggedForChildDirectedTreatment, indicates that the publisher has not specified whether the app should be treated as child-directed for purposes of the Children’s Online Privacy Protection Act (COPPA).

Public functions
Boolean	isTestRequest() Returns true if the publisher is asking for test ads.
Int	@MediationAdConfiguration.TagForChildDirectedTreatment taggedForChildDirectedTreatment() Returns whether the publisher indicated that the app is to be treated as child-directed for purposes of the Children’s Online Privacy Protection Act (COPPA) - http://business.ftc.gov/privacy-and-security/childrens-privacy.
Int	@RequestConfiguration.TagForUnderAgeOfConsent taggedForUnderAgeTreatment() Returns whether the publisher indicated that the ad request should receive treatment for users in the European Economic Area (EEA) under the age of consent, if defined by the .

Public properties
String!	bidResponse The encrypted data from the third party server containing information the third party SDK needs to render an ad.
Context!	context The context passed by this publisher for this specific request.
String?	maxAdContentRating
Bundle!	mediationExtras Additional parameters passed in by the publisher for this specific request.
Bundle!	serverParameters Additional parameters defined by the publisher on the mediation server side.
String!	watermark A base64-encoded watermark PNG file that identifies the source of the ad.

Constants

TAG_FOR_CHILD_DIRECTED_TREATMENT_FALSE

const val TAG_FOR_CHILD_DIRECTED_TREATMENT_FALSE = 0: Int

As returned by taggedForChildDirectedTreatment, indicates that the app should not be treated as child-directed for purposes of the Children’s Online Privacy Protection Act (COPPA).

TAG_FOR_CHILD_DIRECTED_TREATMENT_TRUE

const val TAG_FOR_CHILD_DIRECTED_TREATMENT_TRUE = 1: Int

As returned by taggedForChildDirectedTreatment, indicates that the app should be treated as child-directed for purposes of the Children’s Online Privacy Protection Act (COPPA).

TAG_FOR_CHILD_DIRECTED_TREATMENT_UNSPECIFIED

const val TAG_FOR_CHILD_DIRECTED_TREATMENT_UNSPECIFIED = -1: Int

As returned by taggedForChildDirectedTreatment, indicates that the publisher has not specified whether the app should be treated as child-directed for purposes of the Children’s Online Privacy Protection Act (COPPA).

Public functions

isTestRequest

fun isTestRequest(): Boolean

Returns true if the publisher is asking for test ads. Publishers request test ads by specifying a device ID, but this information is resolved to a boolean for convenience.

taggedForChildDirectedTreatment

@MediationAdConfiguration.TagForChildDirectedTreatment
fun taggedForChildDirectedTreatment(): Int

Returns whether the publisher indicated that the app is to be treated as child-directed for purposes of the Children’s Online Privacy Protection Act (COPPA) - http://business.ftc.gov/privacy-and-security/childrens-privacy.

If this method returns TAG_FOR_CHILD_DIRECTED_TREATMENT_TRUE, it indicates that the app should be treated as child-directed for purposes of the Children’s Online Privacy Protection Act (COPPA).

If this method returns TAG_FOR_CHILD_DIRECTED_TREATMENT_FALSE, it indicates that the app should not be treated as child-directed for purposes of the Children’s Online Privacy Protection Act (COPPA).

If this method returns TAG_FOR_CHILD_DIRECTED_TREATMENT_UNSPECIFIED, it indicates that the publisher has not specified whether the app should be treated as child-directed for purposes of the Children’s Online Privacy Protection Act (COPPA).

taggedForUnderAgeTreatment

@RequestConfiguration.TagForUnderAgeOfConsent
fun taggedForUnderAgeTreatment(): Int

Returns whether the publisher indicated that the ad request should receive treatment for users in the European Economic Area (EEA) under the age of consent, if defined by the . This feature is designed to help facilitate compliance with the General Data Protection Regulation (GDPR).

Public properties

bidResponse

val bidResponse: String!

The encrypted data from the third party server containing information the third party SDK needs to render an ad.

context

val context: Context!

The context passed by this publisher for this specific request.

maxAdContentRating

val maxAdContentRating: String?

mediationExtras

val mediationExtras: Bundle!

Additional parameters passed in by the publisher for this specific request.

serverParameters

val serverParameters: Bundle!

Additional parameters defined by the publisher on the mediation server side.

watermark

val watermark: String!

A base64-encoded watermark PNG file that identifies the source of the ad.

Notes: This is for Open Bidding only.