GoogleMobileAds Framework Reference

GADRequest


@interface GADRequest : NSObject <NSCopying>

Specifies optional parameters for ad requests.

  • Returns a default request.

    Declaration

    Objective-C

    + (nonnull instancetype)request;

Additional Parameters For Ad Networks

  • Ad networks may have additional parameters they accept. To pass these parameters to them, create the ad network extras object for that network, fill in the parameters, and register it here. The ad network should have a header defining the interface for the ‘extras’ object to create. All networks will have access to the basic settings you’ve set in this GADRequest. If you register an extras object that is the same class as one you have registered before, the previous extras will be overwritten.

    Declaration

    Swift

    func register(_ extras: any AdNetworkExtras)

    Objective-C

    - (void)registerAdNetworkExtras:(nonnull id<GADAdNetworkExtras>)extras;

  • Returns the network extras defined for an ad network.

    Declaration

    Swift

    func adNetworkExtras(for aClass: any AdNetworkExtras.Type) -> (any AdNetworkExtras)?

    Objective-C

    - (nullable id<GADAdNetworkExtras>)adNetworkExtrasFor:
    (nonnull Class<GADAdNetworkExtras>)aClass;

  • Removes the extras for an ad network. |aClass| is the class which represents that network’s extras type.

    Declaration

    Swift

    func removeAdNetworkExtras(for aClass: any AdNetworkExtras.Type)

    Objective-C

    - (void)removeAdNetworkExtrasFor:(nonnull Class<GADAdNetworkExtras>)aClass;

Publisher Provided

  • Scene object. Used in multiscene apps to request ads of the appropriate size. If this is nil, uses the application’s key window scene.

    Declaration

    Swift

    weak var scene: UIWindowScene? { get set }

    Objective-C

    @property (nonatomic, weak, nullable) UIWindowScene *scene;

Contextual Information

  • Array of keyword strings. Keywords are words or phrases describing the current user activity such as @“Sports Scores” or @“Football”. Set this property to nil to clear the keywords.

    Declaration

    Swift

    var keywords: [String]? { get set }

    Objective-C

    @property (nonatomic, copy, nullable) NSArray<NSString *> *keywords;

  • URL string for a webpage whose content matches the app’s primary content. This webpage content is used for targeting and brand safety purposes.

    Declaration

    Swift

    var contentURL: String? { get set }

    Objective-C

    @property (nonatomic, copy, nullable) NSString *contentURL;

  • URL strings for non-primary web content near an ad. Promotes brand safety and allows displayed ads to have an app level rating (MA, T, PG, etc) that is more appropriate to neighboring content.

    Declaration

    Swift

    var neighboringContentURLs: [String]? { get set }

    Objective-C

    @property (nonatomic, copy, nullable) NSArray<NSString *> *neighboringContentURLStrings;

  • An identifier for a placement in reporting. A value set here will be set onto any ad returned by this request.

    Declaration

    Swift

    var placementID: Int64 { get set }

    Objective-C

    @property int64_t placementID;

Request Agent Information

  • String that identifies the ad request’s origin. Third party libraries that reference the Mobile Ads SDK should set this property to denote the platform from which the ad request originated. For example, a third party ad network called “CoolAds network” that is mediating requests to the Mobile Ads SDK should set this property as “CoolAds”.

    Declaration

    Swift

    var requestAgent: String? { get set }

    Objective-C

    @property (nonatomic, copy, nullable) NSString *requestAgent;

Optional Targeting Information

  • Key-value pairs used for custom targeting.

    Declaration

    Swift

    var customTargeting: [String : Any]? { get set }

    Objective-C

    @property (nonatomic, copy, nullable) NSDictionary<NSString *, id> *customTargeting;

AdString

  • Deprecated

    Use each ad format class’s loadWithAdResponseString: instead.

    Deprecated. Use each ad format class’s loadWithAdResponseString: instead.

    Ad string that represents an ad response. If set, the SDK will render this ad and ignore all other targeting information set on this request.

    Declaration

    Swift

    var adString: String? { get set }

    Objective-C

    @property (nonatomic, copy, nullable) NSString *adString;