MediationAdConfiguration

@ParametersAreNonnullByDefault
public class MediationAdConfiguration

Known direct subclasses
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 = )
public annotation MediationAdConfiguration.TagForChildDirectedTreatment

Tag for child directed treatment.

Constants

static final 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).

static final 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).

static final 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 fields

final String

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

final Context

The context passed by this publisher for this specific request.

final @Nullable String
final Bundle

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

final Bundle

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

final String

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

Public methods

String

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

Context

The context passed by this publisher for this specific request.

@Nullable String

Returns the maximum ad content rating for this request.

Bundle

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

Bundle

Parameters defined by the publisher in the AdMob or Google Ad Manager UI.

String

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

boolean

Returns true if the publisher is asking for test ads.

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.

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 .

Constants

TAG_FOR_CHILD_DIRECTED_TREATMENT_FALSE

public static final 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).

TAG_FOR_CHILD_DIRECTED_TREATMENT_TRUE

public static final 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).

TAG_FOR_CHILD_DIRECTED_TREATMENT_UNSPECIFIED

public static final 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 fields

bidResponse

public final String bidResponse

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

context

public final Context context

The context passed by this publisher for this specific request.

maxAdContentRating

public final @Nullable String maxAdContentRating

mediationExtras

public final Bundle mediationExtras

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

serverParameters

public final Bundle serverParameters

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

watermark

public final String watermark

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

Notes: This is for Open Bidding only.

Public methods

getBidResponse

public String getBidResponse()

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

getContext

public Context getContext()

The context passed by this publisher for this specific request.

getMaxAdContentRating

@RequestConfiguration.MaxAdContentRating
public @Nullable String getMaxAdContentRating()

Returns the maximum ad content rating for this request. This content rating is the more conservative rating between the publisher-specified rating in the , or the app rating provided by Google's ad server.

getMediationExtras

public Bundle getMediationExtras()

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

getServerParameters

public Bundle getServerParameters()

Parameters defined by the publisher in the AdMob or Google Ad Manager UI.

getWatermark

public String getWatermark()

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

isTestRequest

public boolean isTestRequest()

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
public int 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.

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
public int 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 . This feature is designed to help facilitate compliance with the General Data Protection Regulation (GDPR).