« HELP CENTER

Ad API 3

API Reference

Click here to access the main API Reference page.

The Flite Ad API consists of several API classes, each with a distinct set of functionalities. Each of these classes is described briefly below, with links to the appropriate sections in the API Reference. 

  • animation: Create and run animation effects in your component. Add the Animation dependency to your component in order to use this class.
  • auto: Determine if the environment in which your ad is running supports auto-play functionality like automatic video play, tab rotation, etc.
  • expand: Open, close, and configure expansions, including both overlays and lightboxes.
  • factory: Create an obtain new objects. See Factory Objects section below for details on object types and functionality.
  • library: Retrieve component containers and descriptions, and use them to change component-level properties like size, position, backround/border color, transparency, etc.
  • message: Send and receive messages to/from other components in the ad.
  • metrics: Track metrics within your component, including Interactions, Content events, and Notations.
  • net: Implement network-based actions like clickthrough links, social shares, and email/SMS messages.
  • state: Get and set the current state of your component.
  • util: Access some helpful utilities, like getting a proxied image URL.

Factory Objects

See here for the Factory API class. See below for links to documentation of specific factory objects. Note that all factory classes except the Container class require you to add a dependency to your component in order to use them. See here for more on component dependencies.

  • Container: Manipulate the component's visual representation.
  • CookieManager: Get, set and delete cookies on the user’s computer.
  • DataStore: Store and retrieve key/value pairs to/from Flite’s servers.
  • FeedParser: Parse Atom and RSS feeds either using our default schemas, or specifying custom parsing rules.
  • FeedProxy: Load Atom or RSS feeds into an XML object, optionally using Flite’s feed proxy.
  • Geo: Get the user’s current location using their IP address.
  • ImageLoader: Dynamically load an image or SWF file into your component, optionally using an image proxy.
  • ThemeFactory: This factory-within-a-factory lets you create and configure various UI elements for use within your component, including scrollbars, loading spinners, and share controls. 
  • Video: Load and control (play, pause, seek, etc.) FLV and MP4 videos from the web; both progressive download and streaming videos are supported.