| commit | author | age | ||
| 96fe76 | 1 | // |
| L | 2 | // GADRequest.h |
| 3 | // Google Mobile Ads SDK | |
| 4 | // | |
| 5 | // Copyright 2011 Google LLC. All rights reserved. | |
| 6 | // | |
| 7 | ||
| 8 | #import <CoreGraphics/CoreGraphics.h> | |
| 9 | #import <Foundation/Foundation.h> | |
| 10 | #import <GoogleMobileAds/GADAdNetworkExtras.h> | |
| 11 | #import <GoogleMobileAds/GoogleMobileAdsDefines.h> | |
| 12 | #import <UIKit/UIKit.h> | |
| 13 | ||
| 14 | /// Specifies optional parameters for ad requests. | |
| 15 | @interface GADRequest : NSObject <NSCopying> | |
| 16 | ||
| 17 | /// Returns a default request. | |
| 18 | + (nonnull instancetype)request; | |
| 19 | ||
| 20 | #pragma mark Additional Parameters For Ad Networks | |
| 21 | ||
| 22 | /// Ad networks may have additional parameters they accept. To pass these parameters to them, create | |
| 23 | /// the ad network extras object for that network, fill in the parameters, and register it here. The | |
| 24 | /// ad network should have a header defining the interface for the 'extras' object to create. All | |
| 25 | /// networks will have access to the basic settings you've set in this GADRequest. If you register | |
| 26 | /// an extras object that is the same class as one you have registered before, the previous extras | |
| 27 | /// will be overwritten. | |
| 28 | - (void)registerAdNetworkExtras:(nonnull id<GADAdNetworkExtras>)extras; | |
| 29 | ||
| 30 | /// Returns the network extras defined for an ad network. | |
| 31 | - (nullable id<GADAdNetworkExtras>)adNetworkExtrasFor:(nonnull Class<GADAdNetworkExtras>)aClass; | |
| 32 | ||
| 33 | /// Removes the extras for an ad network. |aClass| is the class which represents that network's | |
| 34 | /// extras type. | |
| 35 | - (void)removeAdNetworkExtrasFor:(nonnull Class<GADAdNetworkExtras>)aClass; | |
| 36 | ||
| 37 | #pragma mark Publisher Provided | |
| 38 | ||
| 39 | /// Scene object. Used in multiscene apps to request ads of the appropriate size. If this is nil, | |
| 40 | /// uses the application's key window scene. | |
| 41 | @property(nonatomic, nullable, weak) UIWindowScene *scene API_AVAILABLE(ios(13.0)); | |
| 42 | ||
| 43 | #pragma mark Contextual Information | |
| 44 | ||
| 45 | /// Array of keyword strings. Keywords are words or phrases describing the current user activity | |
| 46 | /// such as @"Sports Scores" or @"Football". Set this property to nil to clear the keywords. | |
| 47 | @property(nonatomic, copy, nullable) NSArray<NSString *> *keywords; | |
| 48 | ||
| 49 | /// URL string for a webpage whose content matches the app's primary content. This webpage content | |
| 50 | /// is used for targeting and brand safety purposes. | |
| 51 | @property(nonatomic, copy, nullable) NSString *contentURL; | |
| 52 | ||
| 53 | /// URL strings for non-primary web content near an ad. Promotes brand safety and allows displayed | |
| 54 | /// ads to have an app level rating (MA, T, PG, etc) that is more appropriate to neighboring | |
| 55 | /// content. | |
| 56 | @property(nonatomic, copy, nullable) NSArray<NSString *> *neighboringContentURLStrings; | |
| 57 | ||
| 58 | #pragma mark Request Agent Information | |
| 59 | ||
| 60 | /// String that identifies the ad request's origin. Third party libraries that reference the Mobile | |
| 61 | /// Ads SDK should set this property to denote the platform from which the ad request originated. | |
| 62 | /// For example, a third party ad network called "CoolAds network" that is mediating requests to the | |
| 63 | /// Mobile Ads SDK should set this property as "CoolAds". | |
| 64 | @property(nonatomic, copy, nullable) NSString *requestAgent; | |
| 65 | ||
| 66 | @end | |
