MediationAdRequest

public interface MediationAdRequest
Known Indirect Subclasses

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

Constant Summary

int TAG_FOR_CHILD_DIRECTED_TREATMENT_FALSE 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).
int TAG_FOR_CHILD_DIRECTED_TREATMENT_TRUE 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).
int TAG_FOR_CHILD_DIRECTED_TREATMENT_UNSPECIFIED 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 Method Summary

abstract Date
getBirthday()
Returns the birthday of the user, if defined by the AdRequest.
abstract int
getGender()
Returns the gender of the user, if defined by the AdRequest.
abstract Set<String>
getKeywords()
Returns the set of keywords requested by the user, if defined by the AdRequest.
abstract Location
getLocation()
Returns the location of the user, if defined by the AdRequest.
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.
abstract boolean
isTesting()
Returns true if the publisher is asking for test ads.
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) - //business.ftc.gov/privacy-and-security/childrens-privacy.

Constants

public static final int TAG_FOR_CHILD_DIRECTED_TREATMENT_FALSE

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

Constant Value: 0

public static final int TAG_FOR_CHILD_DIRECTED_TREATMENT_TRUE

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

Constant Value: 1

public static final int TAG_FOR_CHILD_DIRECTED_TREATMENT_UNSPECIFIED

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

Constant Value: -1

Public Methods

public abstract Date getBirthday ()

Returns the birthday of the user, if defined by the AdRequest.

public abstract int getGender ()

Returns the gender of the user, if defined by the AdRequest.

public abstract Set<String> getKeywords ()

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

public abstract Location getLocation ()

Returns the location of the user, if defined by the AdRequest.

public 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 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().

public 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. If no Context was provided to this class' constructor, this will always return true.

public 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) - //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).

Send feedback about...

Need help? Visit our support page.