MediationAdRequest

public interface MediationAdRequest

Known direct subclasses
NativeMediationAdRequest

This interface is deprecated. Use [com.google.android.gms.ads.mediation.Adapter] and [com.google.android.gms.ads.mediation.MediationNativeAdConfiguration] instead.

Information about the ad to fetch for a single publisher. The information is passed through to the ad network's adapter.

Summary

Nested types
public static class MediationAdRequest.Companion

This class is deprecated. Use [com.google.android.gms.ads.mediation.Adapter] and [com.google.android.gms.ads.mediation.MediationAdConfiguration] instead.

Public methods
abstract Date

This method is deprecated. This method is deprecated.
abstract int

This method is deprecated. This method is deprecated.
abstract Set<@NonNull String>

Returns the set of keywords requested by the user, if defined by the ad request.
abstract Location

Returns the location of the user, if defined by the ad request.
abstract String

Returns the maximum ad content rating for this request.
abstract boolean

This method is deprecated. This method is deprecated.
abstract boolean

Returns true if the publisher is asking for test ads.
abstract 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.
abstract 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 ad request.

Public methods

getBirthday

abstract Date getBirthday()

Returns the birthday of the user, if defined by the ad request.

getGender

abstract int getGender()

Returns the gender of the user, if defined by the ad request.

getKeywords

abstract Set<@NonNull String> getKeywords()

Returns the set of keywords requested by the user, if defined by the ad request.

getLocation

abstract Location getLocation()

Returns the location of the user, if defined by the ad request.

getMaxAdContentRating

abstract 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 ad request, or the app rating provided by Google's ad server.

isDesignedForFamilies

abstract boolean isDesignedForFamilies()

Publishers that have opted into the Designed for Families program may specify that an ad request should return a Designed for Families-compliant ad. Please see the Google AdMob help center article for more information about this setting.

Returns true if the publisher indicated that the ad request is required to return a Designed for Families-compliant ad.

Returns false if the publisher did not indicate that the ad request is required to return a Designed for Families-compliant ad.

Note: This setting is separate from the Children's Online Privacy Protection Act (COPPA) "tag for child directed treatment" setting. For COPPA-related compliance, see taggedForChildDirectedTreatment.

isTesting

abstract boolean isTesting()

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

abstract 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 MediationAdapter.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 MediationAdapter.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 MediationAdapter.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

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