GoogleMobileAds Framework Reference

GADNativeSignalRequest

@interface GADNativeSignalRequest : GADSignalRequest

A native signal request that can be used as input in server-to-server signal generation.

• numberOfAds

  Number of ads to request. By default, numberOfAds is one. Requests are invalid and will fail if numberOfAds is less than one. If numberOfAds exceeds the maximum limit (5), only the maximum number of ads are requested.

  Declaration

  Swift

  var numberOfAds: Int { get set }

  Objective-C

  @property (nonatomic) NSInteger numberOfAds;

• disableImageLoading

  Indicates whether image asset content should be loaded by the SDK. If set to YES, the SDK will disable image asset loading and native ad image URLs can be used to fetch content. Defaults to NO, image assets are loaded by the SDK.

  Declaration

  Swift

  var isImageLoadingDisabled: Bool { get set }

  Objective-C

  @property (nonatomic, assign, unsafe_unretained, readwrite,
            getter=isImageLoadingDisabled) BOOL disableImageLoading;

• shouldRequestMultipleImages

  Indicates whether multiple images should be loaded for each asset. Defaults to NO.

  Declaration

  Swift

  var shouldRequestMultipleImages: Bool { get set }

  Objective-C

  @property (nonatomic) BOOL shouldRequestMultipleImages;

• mediaAspectRatio

  Image and video aspect ratios. Portrait, landscape, and square aspect ratios are returned when this property is GADMediaAspectRatioUnknown or GADMediaAspectRatioAny. Defaults to GADMediaAspectRatioUnknown.

  Declaration

  Swift

  var mediaAspectRatio: MediaAspectRatio { get set }

  Objective-C

  @property (nonatomic) GADMediaAspectRatio mediaAspectRatio;

• preferredAdChoicesPosition

  Indicates preferred location of AdChoices icon. Default is GADAdChoicesPositionTopRightCorner.

  Declaration

  Swift

  var preferredAdChoicesPosition: AdChoicesPosition { get set }

  Objective-C

  @property (nonatomic) GADAdChoicesPosition preferredAdChoicesPosition;

• customMuteThisAdRequested

  Indicates whether the custom Mute This Ad feature is requested. Defaults to NO.

  Declaration

  Swift

  var isCustomMuteThisAdRequested: Bool { get set }

  Objective-C

  @property (nonatomic, assign, unsafe_unretained, readwrite,
            getter=isCustomMuteThisAdRequested) BOOL customMuteThisAdRequested;

• enableManualImpressions

  Indicates whether the publisher will record impressions manually when the ad becomes visible to the user. Defaults to NO.

  Declaration

  Swift

  var enableManualImpressions: Bool { get set }

  Objective-C

  @property (nonatomic) BOOL enableManualImpressions;

• -enableSwipeGestureDirection:tapsAllowed:

  Enable the direction for detecting swipe gestures and counting them as clicks, and whether tap gestures are also allowed on the ad. By default, swipe gestures are disabled.

  Available for allowlisted publishers only. Settings will be ignored for publishers not allowlisted.

  Declaration

  Swift

  func enableSwipeGestureDirection(_ direction: UISwipeGestureRecognizer.Direction, tapsAllowed: Bool)

  Objective-C

  - (void)enableSwipeGestureDirection:(UISwipeGestureRecognizerDirection)direction
                          tapsAllowed:(BOOL)tapsAllowed;

• videoOptions

  Video ad options. Defaults to nil.

  Declaration

  Swift

  @NSCopying var videoOptions: VideoOptions? { get set }

  Objective-C

  @property (nonatomic, copy, nullable) GADVideoOptions *videoOptions;

• adSizes

  Array of NSValue encoded GADAdSize structs, specifying all valid sizes that are appropriate for this slot. Never create your own GADAdSize directly. Use one of the predefined standard ad sizes (such as GADAdSizeBanner), or create one using the GADAdSizeFromCGSize method.

  Example:

  \code NSArray *adSizes = @[ NSValueFromGADAdSize(GADAdSizeBanner), NSValueFromGADAdSize(GADAdSizeLargeBanner) ];

  signalRequest.adSizes = adSizes; \endcode

  Declaration

  Swift

  var adSizes: [NSValue]? { get set }

  Objective-C

  @property (nonatomic, copy, nullable) NSArray<NSValue *> *adSizes;

• adLoaderAdTypes

  Set of ad loader ad types. See GADAdLoaderAdTypes.h for available ad loader ad types.

  Declaration

  Swift

  var adLoaderAdTypes: Set<AdLoaderAdType>? { get set }

  Objective-C

  @property (nonatomic, copy, nullable) NSSet<GADAdLoaderAdType> *adLoaderAdTypes;

• customNativeAdFormatIDs

  Array of custom native ad format IDs.

  Declaration

  Swift

  var customNativeAdFormatIDs: [String]? { get set }

  Objective-C

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

• -initWithSignalType:

  Returns an initialized native signal request.

  Declaration

  Swift

  init(signalType: String)

  Objective-C

  - (nonnull instancetype)initWithSignalType:(nonnull NSString *)signalType;

  Parameters

  signalType

  The type of signal to request.