GoogleInteractiveMediaAds Framework Reference

IMAErrorCode

enum IMAErrorCode : NSInteger {}

Possible error codes raised while loading or playing ads.

• kIMAError_VAST_MALFORMED_RESPONSE

  The ad response was not recognized as a valid VAST ad.

  Declaration

  Swift

  case VAST_MALFORMED_RESPONSE = 100

  Objective-C

  kIMAError_VAST_MALFORMED_RESPONSE = 100

• kIMAError_VAST_TRAFFICKING_ERROR

  Trafficking error. Video player received an ad type that it was not expecting and/or cannot display.

  Declaration

  Swift

  case VAST_TRAFFICKING_ERROR = 200

  Objective-C

  kIMAError_VAST_TRAFFICKING_ERROR = 200

• kIMAError_VAST_LOAD_TIMEOUT

  The VAST URI provided, or a VAST URI provided in a subsequent Wrapper element, was either unavailable or reached a timeout, as defined by the video player. The timeout is 8 seconds for initial VAST requests and 4 seconds for each subsequent Wrapper.

  Declaration

  Swift

  case VAST_LOAD_TIMEOUT = 301

  Objective-C

  kIMAError_VAST_LOAD_TIMEOUT = 301

• kIMAError_VAST_TOO_MANY_REDIRECTS

  The maximum number of VAST wrapper redirects has been reached.

  Declaration

  Swift

  case VAST_TOO_MANY_REDIRECTS = 302

  Objective-C

  kIMAError_VAST_TOO_MANY_REDIRECTS = 302

• kIMAError_VAST_INVALID_URL

  At least one VAST wrapper loaded and a subsequent wrapper or inline ad load has resulted in a 404 response code.

  Declaration

  Swift

  case VAST_INVALID_URL = 303

  Objective-C

  kIMAError_VAST_INVALID_URL = 303

• kIMAError_VIDEO_PLAY_ERROR

  There was an error playing the video ad.

  Declaration

  Swift

  case VIDEO_PLAY_ERROR = 400

  Objective-C

  kIMAError_VIDEO_PLAY_ERROR = 400

• kIMAError_VAST_MEDIA_LOAD_TIMEOUT

  Failed to load media assets from a VAST response. The default timeout for media loading is 8 seconds.

  Declaration

  Swift

  case VAST_MEDIA_LOAD_TIMEOUT = 402

  Objective-C

  kIMAError_VAST_MEDIA_LOAD_TIMEOUT = 402

• kIMAError_VAST_LINEAR_ASSET_MISMATCH

  Assets were found in the VAST ad response for linear ad, but none of them matched the video player’s capabilities.

  Declaration

  Swift

  case VAST_LINEAR_ASSET_MISMATCH = 403

  Objective-C

  kIMAError_VAST_LINEAR_ASSET_MISMATCH = 403

• kIMAError_COMPANION_AD_LOADING_FAILED

  A companion ad failed to load or render.

  Declaration

  Swift

  case COMPANION_AD_LOADING_FAILED = 603

  Objective-C

  kIMAError_COMPANION_AD_LOADING_FAILED = 603

• kIMAError_UNKNOWN_ERROR

  An unexpected error occurred and the cause is not known. Refer to the inner error for more information.

  Declaration

  Swift

  case UNKNOWN_ERROR = 900

  Objective-C

  kIMAError_UNKNOWN_ERROR = 900

• kIMAError_PLAYLIST_MALFORMED_RESPONSE

  Ads list response was malformed.

  Declaration

  Swift

  case PLAYLIST_MALFORMED_RESPONSE = 1004

  Objective-C

  kIMAError_PLAYLIST_MALFORMED_RESPONSE = 1004

• kIMAError_FAILED_TO_REQUEST_ADS

  There was a problem requesting ads from the server.

  Declaration

  Swift

  case FAILED_TO_REQUEST_ADS = 1005

  Objective-C

  kIMAError_FAILED_TO_REQUEST_ADS = 1005

• kIMAError_REQUIRED_LISTENERS_NOT_ADDED

  Listener for at least one of the required vast events was not added.

  Declaration

  Swift

  case REQUIRED_LISTENERS_NOT_ADDED = 1006

  Objective-C

  kIMAError_REQUIRED_LISTENERS_NOT_ADDED = 1006

• kIMAError_VAST_ASSET_NOT_FOUND

  No assets were found in the VAST ad response.

  Declaration

  Swift

  case VAST_ASSET_NOT_FOUND = 1007

  Objective-C

  kIMAError_VAST_ASSET_NOT_FOUND = 1007

• kIMAError_ADSLOT_NOT_VISIBLE

  The ad slot is not visible on the page.

  Declaration

  Swift

  case ADSLOT_NOT_VISIBLE = 1008

  Objective-C

  kIMAError_ADSLOT_NOT_VISIBLE = 1008

• kIMAError_VAST_EMPTY_RESPONSE

  A VAST response containing a single <VAST> tag with no child tags.

  Declaration

  Swift

  case VAST_EMPTY_RESPONSE = 1009

  Objective-C

  kIMAError_VAST_EMPTY_RESPONSE = 1009

• kIMAError_FAILED_LOADING_AD

  There was an error loading the ad.

  Declaration

  Swift

  case FAILED_LOADING_AD = 1010

  Objective-C

  kIMAError_FAILED_LOADING_AD = 1010

• kIMAError_STREAM_INITIALIZATION_FAILED

  There was an error initializing the stream.

  Declaration

  Swift

  case STREAM_INITIALIZATION_FAILED = 1020

  Objective-C

  kIMAError_STREAM_INITIALIZATION_FAILED = 1020

• kIMAError_INVALID_ARGUMENTS

  Invalid arguments were provided to SDK methods.

  Declaration

  Swift

  case INVALID_ARGUMENTS = 1101

  Objective-C

  kIMAError_INVALID_ARGUMENTS = 1101

• kIMAError_API_ERROR

  Generic invalid usage of the API.

  Declaration

  Swift

  case API_ERROR = 1102

  Objective-C

  kIMAError_API_ERROR = 1102

• kIMAError_OS_RUNTIME_TOO_OLD

  The version of the runtime is too old.

  Declaration

  Swift

  case OS_RUNTIME_TOO_OLD = 1103

  Objective-C

  kIMAError_OS_RUNTIME_TOO_OLD = 1103

• kIMAError_VIDEO_ELEMENT_USED

  Another VideoAdsManager is still using the video. It must be unloaded before another ad can play on the same element.

  Declaration

  Swift

  case VIDEO_ELEMENT_USED = 1201

  Objective-C

  kIMAError_VIDEO_ELEMENT_USED = 1201

• kIMAError_VIDEO_ELEMENT_REQUIRED

  A video element was not specified where it was required.

  Declaration

  Swift

  case VIDEO_ELEMENT_REQUIRED = 1202

  Objective-C

  kIMAError_VIDEO_ELEMENT_REQUIRED = 1202

• kIMAError_CONTENT_PLAYHEAD_MISSING

  Content playhead was not passed in, but list of ads has been returned from the server.

  Declaration

  Swift

  case CONTENT_PLAYHEAD_MISSING = 1205

  Objective-C

  kIMAError_CONTENT_PLAYHEAD_MISSING = 1205