GoogleInteractiveMediaAds Framework Reference

AI-generated Key Takeaways

• IMAFriendlyObstruction allows marking specific views as "friendly" for viewability measurement, ensuring they don't negatively impact ad metrics.

• It requires specifying the obstructing view, the purpose for the friendly designation, and an optional detailedReason.

• The detailedReason, if provided, should adhere to IAB standards (≤50 characters, using only A-z, 0-9, or spaces).

• Initialization is done through initWithView:purpose:detailedReason:, providing the necessary information to define the obstruction.

IMAFriendlyObstruction

@interface IMAFriendlyObstruction : NSObject

An obstruction that is marked as “friendly” for viewability measurement purposes.

• view

  The view causing the obstruction.

  Declaration

  Swift

  var view: UIView { get }

  Objective-C

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

• purpose

  The purpose for registering the obstruction as friendly.

  Declaration

  Swift

  var purpose: IMAFriendlyObstructionPurpose { get }

  Objective-C

  @property (nonatomic, readonly) IMAFriendlyObstructionPurpose purpose;

• detailedReason

  Optional, detailed reasoning for registering this obstruction as friendly. If the detailedReason is not null, it must follow the IAB standard by being 50 characters or less and only containing characters A-z, 0-9, or spaces.

  Declaration

  Swift

  var detailedReason: String? { get }

  Objective-C

  @property (nonatomic, readonly, nullable) NSString *detailedReason;

• -initWithView:purpose:detailedReason:

  Initializes a friendly obstruction.

  Declaration

  Swift

  init(view: UIView, purpose: IMAFriendlyObstructionPurpose, detailedReason: String?)

  Objective-C

  - (nonnull instancetype)initWithView:(nonnull UIView *)view
                               purpose:(IMAFriendlyObstructionPurpose)purpose
                        detailedReason:(nullable NSString *)detailedReason;

  Parameters

  view	The view causing the obstruction.
  purpose	The purpose for registering the obstruction as friendly.
  detailedReason	Optional, detailed reasoning for registering this obstruction as friendly.

  Return Value

  A new IMAFriendlyObstruction instance