GoogleInteractiveMediaAds Framework Reference

  • The IMACompanionAdSlot class is used for ad slots where the SDK will place a companion ad within a provided UIView container.

  • This class is not available on tvOS.

  • Key properties include the view where the ad will be rendered, and the width and height of the slot in pixels, which are used for targeting.

  • The delegate property allows receiving events from the companion ad slot.

  • You can initialize an IMACompanionAdSlot with a specified view, width, and height, or with just a view for a fluid size.

IMACompanionAdSlot

@interface IMACompanionAdSlot : NSObject

Ad slot for companion ads. The SDK will put a subview inside the provided UIView container. The companion will be matched to the width and height provided here. This class cannot be instantiated on tvOS, where companion ads are not available.

  • The view the companion will be rendered in. Display this view in your application before video ad starts.

    Declaration

    Swift

    var view: UIView { get }

    Objective-C

    @property (nonatomic, readonly) UIView *_Nonnull view;

  • Width of the slot, in pixels. This value is sent to the DFP ad server for targeting.

    Declaration

    Swift

    var width: Int { get }

    Objective-C

    @property (nonatomic, readonly) NSInteger width;

  • Height of the slot, in pixels. This value is sent to the DFP ad server for targeting.

    Declaration

    Swift

    var height: Int { get }

    Objective-C

    @property (nonatomic, readonly) NSInteger height;

  • The IMACompanionDelegate for receiving events from the companion ad slot.

    Declaration

    Swift

    weak var delegate: (any IMACompanionDelegate)? { get set }

    Objective-C

    @property (nonatomic, weak, nullable) id<IMACompanionDelegate> delegate;

  • Initializes an instance of a IMACompanionAdSlot with design ad width and height.

    Declaration

    Swift

    init(view: UIView, width: Int, height: Int)

    Objective-C

    - (nonnull instancetype)initWithView:(nonnull UIView *)view
                               width:(NSInteger)width
                              height:(NSInteger)height;

    Parameters

    view

    the UIView that will contain the companion ad
    width

    the chosen width of the ad
    height

    the chosen height of the ad

    Return Value

    the IMACompanionAdSlot instance

  • Initializes an instance of a IMACompanionAdSlot with fluid size.

    Declaration

    Swift

    init(view: UIView)

    Objective-C

    - (nonnull instancetype)initWithView:(nonnull UIView *)view;

    Parameters

    view

    the UIView that will contain the companion ad.

    Return Value

    the IMACompanionAdSlot instance