GoogleMobileAds (Beta) Framework Reference

GADSwipeableInterstitialSignalRequest


@interface GADSwipeableInterstitialSignalRequest : GADSignalRequest

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

  • Specifies the maximum duration (in seconds) the app commits to holding the ad on screen before it is eligible for dismissal. The SDK only returns ads with a hold requirement that is less than or equal to this value. Defaults to 0.

    Only set this property if your app implements logic to hold swipeable interstitial ads on screen.

    Declaration

    Swift

    var maxScreenHoldDuration: TimeInterval { get set }

    Objective-C

    @property (nonatomic) NSTimeInterval maxScreenHoldDuration;

  • An optional ad size to request. If this property is set to CGSizeZero (the default), the SDK requests an ad using the device’s full screen size. If the requested ad size is determined to be too small for an interstitial experience, the ad request will fail.

    Declaration

    Swift

    var adSize: CGSize { get set }

    Objective-C

    @property (nonatomic) CGSize adSize;

  • The direction in which swipe gestures should be detected as custom click gestures for swipeable interstitial ads.

    Declaration

    Swift

    var customClickSwipeGestureDirection: UISwipeGestureRecognizer.Direction { get }

    Objective-C

    @property (nonatomic, readonly) UISwipeGestureRecognizerDirection customClickSwipeGestureDirection;

  • Determines whether the creative handles standard tap clicks when custom click swipe gestures are enabled. Defaults to YES.

    Declaration

    Swift

    var areCustomClickSwipeGestureTapsAllowed: Bool { get }

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readonly,
          getter=areCustomClickSwipeGestureTapsAllowed)
    BOOL customClickSwipeGestureTapsAllowed;

  • Enables a custom click swipe gesture on the swipeable interstitial ad. Available for allowlisted publishers only. This setting is ignored for publishers not allowlisted.

    Declaration

    Swift

    func enableCustomClickSwipeGesture(direction: UISwipeGestureRecognizer.Direction, tapsAllowed: Bool)

    Objective-C

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

    Parameters

    direction

    A swipe direction on the ad that should trigger an ad click.
    tapsAllowed

    Whether to treat tap gestures as ad clicks.

  • Returns an initialized swipeable interstitial signal request.

    Declaration

    Swift

    init(signalType: String)

    Objective-C

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

    Parameters

    signalType

    The type of signal to request.