GoogleMobileAds Framework Reference
Stay organized with collections
Save and categorize content based on your preferences.
@protocol GADMediationAdRequest <NSObject>
Provides information which can be used for making ad requests during mediation.
-
Publisher ID set by the publisher on the AdMob frontend.
Declaration
Swift
func publisherId() -> String?
Objective-C
- (nullable NSString *)publisherId;
-
Mediation configurations set by the publisher on the AdMob frontend.
Declaration
Swift
func credentials() -> [AnyHashable : Any]?
Objective-C
- (nullable NSDictionary *)credentials;
-
Returns YES if the publisher is requesting test ads.
Declaration
Swift
func testMode() -> Bool
Objective-C
- (BOOL)testMode;
-
The adapter’s ad network extras specified in GADRequest.
Declaration
Swift
func networkExtras() -> (any AdNetworkExtras)?
-
Returns the value of childDirectedTreatment supplied by the publisher. Returns nil if the
publisher hasn’t specified child directed treatment. Returns @YES if child directed treatment is
enabled.
Declaration
Swift
func childDirectedTreatment() -> NSNumber?
Objective-C
- (nullable NSNumber *)childDirectedTreatment;
-
Returns the maximum ad content rating supplied by the publisher. Returns nil if the publisher
hasn’t specified a max ad content rating.
-
Returns the value of underAgeOfConsent supplied by the publisher. Returns nil if the publisher
hasn’t specified the user is under the age of consent. Returns @YES if the user is under the age
of consent.
Declaration
Swift
func underAgeOfConsent() -> NSNumber?
Objective-C
- (nullable NSNumber *)underAgeOfConsent;
-
Keywords describing the user’s current activity. Example: @“Sport Scores”.
Declaration
Swift
func userKeywords() -> [Any]?
Objective-C
- (nullable NSArray *)userKeywords;
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-20 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-20 UTC."],[[["\u003cp\u003e\u003ccode\u003eGADMediationAdRequest\u003c/code\u003e provides information for ad requests during the mediation process.\u003c/p\u003e\n"],["\u003cp\u003eIt includes publisher information like ID, mediation configurations, and test mode status.\u003c/p\u003e\n"],["\u003cp\u003eIt allows specifying targeting options such as child-directed treatment, content rating, and user keywords.\u003c/p\u003e\n"],["\u003cp\u003eAd network extras from \u003ccode\u003eGADRequest\u003c/code\u003e can be accessed for adapter configuration.\u003c/p\u003e\n"],["\u003cp\u003ePublishers can indicate if the user is under the age of consent.\u003c/p\u003e\n"]]],["The `GADMediationAdRequest` protocol provides data for ad requests during mediation. It allows access to the publisher ID, mediation configurations, and whether test ads are requested. It also provides information like ad network extras, child-directed treatment, maximum ad content rating, user's age of consent status, and user keywords. The protocol enables retrieval of these values via methods in both Swift and Objective-C, returning the information if the publisher has provided them.\n"],null,["# GoogleMobileAds Framework Reference\n\nGADMediationAdRequest\n=====================\n\n @protocol GADMediationAdRequest \u003cNSObject\u003e\n\nProvides information which can be used for making ad requests during mediation.\n- `\n ``\n ``\n `\n\n ### [-publisherId](#/c:objc(pl)GADMediationAdRequest(im)publisherId)\n\n `\n ` \n Publisher ID set by the publisher on the AdMob frontend. \n\n #### Declaration\n\n Swift \n\n func publisherId() -\u003e String?\n\n Objective-C \n\n - (nullable NSString *)publisherId;\n\n- `\n ``\n ``\n `\n\n ### [-credentials](#/c:objc(pl)GADMediationAdRequest(im)credentials)\n\n `\n ` \n Mediation configurations set by the publisher on the AdMob frontend. \n\n #### Declaration\n\n Swift \n\n func credentials() -\u003e [AnyHashable : Any]?\n\n Objective-C \n\n - (nullable NSDictionary *)credentials;\n\n- `\n ``\n ``\n `\n\n ### [-testMode](#/c:objc(pl)GADMediationAdRequest(im)testMode)\n\n `\n ` \n Returns YES if the publisher is requesting test ads. \n\n #### Declaration\n\n Swift \n\n func testMode() -\u003e Bool\n\n Objective-C \n\n - (BOOL)testMode;\n\n- `\n ``\n ``\n `\n\n ### [-networkExtras](#/c:objc(pl)GADMediationAdRequest(im)networkExtras)\n\n `\n ` \n The adapter's ad network extras specified in GADRequest. \n\n #### Declaration\n\n Swift \n\n func networkExtras() -\u003e (any AdNetworkExtras)?\n\n Objective-C \n\n - (nullable id\u003c../Protocols.html#/c:objc(pl)GADAdNetworkExtras\u003e)networkExtras;\n\n- `\n ``\n ``\n `\n\n ### [-childDirectedTreatment](#/c:objc(pl)GADMediationAdRequest(im)childDirectedTreatment)\n\n `\n ` \n Returns the value of childDirectedTreatment supplied by the publisher. Returns nil if the\n publisher hasn't specified child directed treatment. Returns @YES if child directed treatment is\n enabled. \n\n #### Declaration\n\n Swift \n\n func childDirectedTreatment() -\u003e NSNumber?\n\n Objective-C \n\n - (nullable NSNumber *)childDirectedTreatment;\n\n- `\n ``\n ``\n `\n\n ### [-maxAdContentRating](#/c:objc(pl)GADMediationAdRequest(im)maxAdContentRating)\n\n `\n ` \n Returns the maximum ad content rating supplied by the publisher. Returns nil if the publisher\n hasn't specified a max ad content rating. \n\n #### Declaration\n\n Swift \n\n func maxAdContentRating() -\u003e ../Type-Definitions.html#/c:GADRequestConfiguration.h@T@GADMaxAdContentRating?\n\n Objective-C \n\n - (nullable ../Type-Definitions.html#/c:GADRequestConfiguration.h@T@GADMaxAdContentRating)maxAdContentRating;\n\n- `\n ``\n ``\n `\n\n ### [-underAgeOfConsent](#/c:objc(pl)GADMediationAdRequest(im)underAgeOfConsent)\n\n `\n ` \n Returns the value of underAgeOfConsent supplied by the publisher. Returns nil if the publisher\n hasn't specified the user is under the age of consent. Returns @YES if the user is under the age\n of consent. \n\n #### Declaration\n\n Swift \n\n func underAgeOfConsent() -\u003e NSNumber?\n\n Objective-C \n\n - (nullable NSNumber *)underAgeOfConsent;\n\n- `\n ``\n ``\n `\n\n ### [-userKeywords](#/c:objc(pl)GADMediationAdRequest(im)userKeywords)\n\n `\n ` \n Keywords describing the user's current activity. Example: @\"Sport Scores\". \n\n #### Declaration\n\n Swift \n\n func userKeywords() -\u003e [Any]?\n\n Objective-C \n\n - (nullable NSArray *)userKeywords;"]]
