# GoogleInteractiveMediaAds Framework Reference

# IMAAd

    @interface IMAAd : NSObject

Data object representing a single ad.
- `


  ### [adId](https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/ios/reference/Classes/IMAAd#/c:objc(cs)IMAAd(py)adId)


  ` The ad ID as specified in the VAST response.

  #### Declaration

  Swift

      var adId: String { get }

  Objective-C

      @property (nonatomic, copy, readonly) NSString *_Nonnull adId;

- `


  ### [adTitle](https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/ios/reference/Classes/IMAAd#/c:objc(cs)IMAAd(py)adTitle)


  ` The ad title from the VAST response.

  #### Declaration

  Swift

      var adTitle: String { get }

  Objective-C

      @property (nonatomic, copy, readonly) NSString *_Nonnull adTitle;

- `


  ### [adDescription](https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/ios/reference/Classes/IMAAd#/c:objc(cs)IMAAd(py)adDescription)


  ` The ad description.

  #### Declaration

  Swift

      var adDescription: String { get }

  Objective-C

      @property (nonatomic, copy, readonly) NSString *_Nonnull adDescription;

- `


  ### [adSystem](https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/ios/reference/Classes/IMAAd#/c:objc(cs)IMAAd(py)adSystem)


  ` The source ad server information included in the ad response.

  #### Declaration

  Swift

      var adSystem: String { get }

  Objective-C

      @property (nonatomic, copy, readonly) NSString *_Nonnull adSystem;

- `


  ### [companionAds](https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/ios/reference/Classes/IMAAd#/c:objc(cs)IMAAd(py)companionAds)


  ` The companion ads specified in the VAST response when using DAI. Empty for client-side ads.

  #### Declaration

  Swift

      var companionAds: [https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/ios/reference/Classes/IMACompanionAd.html] { get }

  Objective-C

      @property (nonatomic, copy, readonly) NSArray<https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/ios/reference/Classes/IMACompanionAd.html *> *_Nonnull companionAds;

- `


  ### [contentType](https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/ios/reference/Classes/IMAAd#/c:objc(cs)IMAAd(py)contentType)


  ` Content type of the currently selected creative. For linear creatives
  returns the content type of the currently selected media file. Returns
  empty string if no creative or media file is selected on this ad.

  #### Declaration

  Swift

      var contentType: String { get }

  Objective-C

      @property (nonatomic, copy, readonly) NSString *_Nonnull contentType;

- `


  ### [duration](https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/ios/reference/Classes/IMAAd#/c:objc(cs)IMAAd(py)duration)


  ` The duration of the ad from the VAST response.

  #### Declaration

  Swift

      var duration: TimeInterval { get }

  Objective-C

      @property (nonatomic, readonly) NSTimeInterval duration;

- `


  ### [uiElements](https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/ios/reference/Classes/IMAAd#/c:objc(cs)IMAAd(py)uiElements)


  ` The [UI elements](https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/ios/reference/Enums/IMAUiElementType.html) that will be displayed during ad
  playback.

  #### Declaration

  Swift

      var uiElements: [NSNumber] { get }

  Objective-C

      @property (nonatomic, copy, readonly) NSArray<NSNumber *> *_Nonnull uiElements;

- `


  ### [width](https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/ios/reference/Classes/IMAAd#/c:objc(cs)IMAAd(py)width)


  ` The width of the ad asset. For non-linear ads, this is the actual width
  of the ad representation. For linear ads, since they scale seamlessly, we
  currently return 0 for width.

  #### Declaration

  Swift

      var width: Int { get }

  Objective-C

      @property (nonatomic, readonly) NSInteger width;

- `


  ### [height](https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/ios/reference/Classes/IMAAd#/c:objc(cs)IMAAd(py)height)


  ` The height of the ad asset. For non-linear ads, this is the actual height
  of the ad representation. For linear ads, since they scale seamlessly, we
  currently return 0 for height.

  #### Declaration

  Swift

      var height: Int { get }

  Objective-C

      @property (nonatomic, readonly) NSInteger height;

- `


  ### [VASTMediaWidth](https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/ios/reference/Classes/IMAAd#/c:objc(cs)IMAAd(py)VASTMediaWidth)


  ` The width of the selected creative as specified in the VAST response.

  #### Declaration

  Swift

      var vastMediaWidth: Int { get }

  Objective-C

      @property (nonatomic, readonly) NSInteger VASTMediaWidth;

- `


  ### [VASTMediaHeight](https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/ios/reference/Classes/IMAAd#/c:objc(cs)IMAAd(py)VASTMediaHeight)


  ` The height of the selected creative as specified in the VAST response.

  #### Declaration

  Swift

      var vastMediaHeight: Int { get }

  Objective-C

      @property (nonatomic, readonly) NSInteger VASTMediaHeight;

- `


  ### [VASTMediaBitrate](https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/ios/reference/Classes/IMAAd#/c:objc(cs)IMAAd(py)VASTMediaBitrate)


  ` The bitrate of the selected creative as specified in the VAST response.

  #### Declaration

  Swift

      var vastMediaBitrate: Int { get }

  Objective-C

      @property (nonatomic, readonly) NSInteger VASTMediaBitrate;

- `


  ### [linear](https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/ios/reference/Classes/IMAAd#/c:objc(cs)IMAAd(py)linear)


  ` Specifies whether the ad is linear or non-linear.

  #### Declaration

  Swift

      var isLinear: Bool { get }

  Objective-C

      @property (nonatomic, readonly, getter=isLinear) BOOL linear;

- `


  ### [skippable](https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/ios/reference/Classes/IMAAd#/c:objc(cs)IMAAd(py)skippable)


  ` Specifies whether the ad is skippable.

  #### Declaration

  Swift

      var isSkippable: Bool { get }

  Objective-C

      @property (nonatomic, readonly, getter=isSkippable) BOOL skippable;

- `


  ### [skipTimeOffset](https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/ios/reference/Classes/IMAAd#/c:objc(cs)IMAAd(py)skipTimeOffset)


  ` The number of seconds of playback before the ad becomes skippable. -1 is returned for non
  skippable ads or if this is unavailable.

  #### Declaration

  Swift

      var skipTimeOffset: TimeInterval { get }

  Objective-C

      @property (nonatomic, readonly) NSTimeInterval skipTimeOffset;

- `


  ### [adPodInfo](https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/ios/reference/Classes/IMAAd#/c:objc(cs)IMAAd(py)adPodInfo)


  ` Set of ad podding properties.

  #### Declaration

  Swift

      var adPodInfo: https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/ios/reference/Classes/IMAAdPodInfo.html { get }

  Objective-C

      @property (nonatomic, readonly) https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/ios/reference/Classes/IMAAdPodInfo.html *_Nonnull adPodInfo;

- `


  ### [traffickingParameters](https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/ios/reference/Classes/IMAAd#/c:objc(cs)IMAAd(py)traffickingParameters)


  ` String representing custom trafficking parameters from the VAST response.

  #### Declaration

  Swift

      var traffickingParameters: String { get }

  Objective-C

      @property (nonatomic, copy, readonly) NSString *_Nonnull traffickingParameters;

- `


  ### [creativeID](https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/ios/reference/Classes/IMAAd#/c:objc(cs)IMAAd(py)creativeID)


  ` Returns the ID of the selected creative for the ad.

  #### Declaration

  Swift

      var creativeID: String { get }

  Objective-C

      @property (nonatomic, copy, readonly) NSString *_Nonnull creativeID;

- `


  ### [creativeAdID](https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/ios/reference/Classes/IMAAd#/c:objc(cs)IMAAd(py)creativeAdID)


  ` Returns the ISCI (Industry Standard Commercial Identifier) code for an ad. This
  is the Ad-ID of the selected creative in the VAST response.

  #### Declaration

  Swift

      var creativeAdID: String { get }

  Objective-C

      @property (nonatomic, copy, readonly) NSString *_Nonnull creativeAdID;

- `


  ### [universalAdIDs](https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/ios/reference/Classes/IMAAd#/c:objc(cs)IMAAd(py)universalAdIDs)


  ` The list of all UniversalAdIds of the selected creative for this ad. Returns an empty array if
  no universal ad IDs are found.

  #### Declaration

  Swift

      var universalAdIDs: [https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/ios/reference/Classes/IMAUniversalAdID.html] { get }

  Objective-C

      @property (nonatomic, copy, readonly) NSArray<https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/ios/reference/Classes/IMAUniversalAdID.html *> *_Nonnull universalAdIDs;

- `


  ### [universalAdIdValue](https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/ios/reference/Classes/IMAAd#/c:objc(cs)IMAAd(py)universalAdIdValue)


  ` Deprecated

  Use universalAdIDs instead.
  The UniversalAdId of the selected creative for the ad. Returns the id value or "unknown"
  if unavailable.

  #### Declaration

  Swift

      var universalAdIdValue: String { get }

  Objective-C

      @property (nonatomic, copy, readonly) DEPRECATED_MSG_ATTRIBUTE NSString *universalAdIdValue;

- `


  ### [universalAdIdRegistry](https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/ios/reference/Classes/IMAAd#/c:objc(cs)IMAAd(py)universalAdIdRegistry)


  ` Deprecated

  Use universalAdIDs instead.
  The registry associated with cataloging the UniversalAdId of the selected creative for the ad.
  Returns the registry value, or "unknown" if unavailable.

  #### Declaration

  Swift

      var universalAdIdRegistry: String { get }

  Objective-C

      @property (nonatomic, copy, readonly) DEPRECATED_MSG_ATTRIBUTE NSString *universalAdIdRegistry;

- `


  ### [advertiserName](https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/ios/reference/Classes/IMAAd#/c:objc(cs)IMAAd(py)advertiserName)


  ` The advertiser name as defined by the serving party.

  #### Declaration

  Swift

      var advertiserName: String { get }

  Objective-C

      @property (nonatomic, copy, readonly) NSString *_Nonnull advertiserName;

- `


  ### [surveyURL](https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/ios/reference/Classes/IMAAd#/c:objc(cs)IMAAd(py)surveyURL)


  ` Returns the URL associated with the survey for the given ad.

  #### Declaration

  Swift

      var surveyURL: String? { get }

  Objective-C

      @property (nonatomic, copy, readonly, nullable) NSString *surveyURL;

- `


  ### [dealID](https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/ios/reference/Classes/IMAAd#/c:objc(cs)IMAAd(py)dealID)


  ` Returns the first deal ID present in the wrapper chain for the current ad,
  starting from the top.

  #### Declaration

  Swift

      var dealID: String { get }

  Objective-C

      @property (nonatomic, copy, readonly) NSString *_Nonnull dealID;

- `


  ### [wrapperAdIDs](https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/ios/reference/Classes/IMAAd#/c:objc(cs)IMAAd(py)wrapperAdIDs)


  ` The IDs of the ads, starting with the first wrapper ad.

  #### Declaration

  Swift

      var wrapperAdIDs: [String] { get }

  Objective-C

      @property (nonatomic, copy, readonly) NSArray<NSString *> *_Nonnull wrapperAdIDs;

- `


  ### [wrapperCreativeIDs](https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/ios/reference/Classes/IMAAd#/c:objc(cs)IMAAd(py)wrapperCreativeIDs)


  ` The IDs of the ads' creatives, starting with the first wrapper ad.

  #### Declaration

  Swift

      var wrapperCreativeIDs: [String] { get }

  Objective-C

      @property (nonatomic, copy, readonly) NSArray<NSString *> *_Nonnull wrapperCreativeIDs;

- `


  ### [wrapperSystems](https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/ios/reference/Classes/IMAAd#/c:objc(cs)IMAAd(py)wrapperSystems)


  ` Ad systems used for wrapper ads. The ad systems returned begin with the
  first wrapper ad and continue to each wrapper ad recursively.

  #### Declaration

  Swift

      var wrapperSystems: [String] { get }

  Objective-C

      @property (nonatomic, copy, readonly) NSArray<NSString *> *_Nonnull wrapperSystems;