DoubleClick Studio AS3 API Reference

Gets the singleton instance of VpaidEnabler.

Closes floating and Pop-up creative types. If it is an expanding creative, close acts as a proxy to collapse.

     var closeClickHandler:Function = function(event:MouseEvent):void {
       enabler.close();
     };
     closeButton.addEventListener(MouseEvent.CLICK, closeClickHandler);
     

Closes the companion asset for floating, reminder and Pop-up creative types.

     var closeClickHandler:Function = function(event:MouseEvent):void {
       enabler.closeCompanion();
     };
     closeButton.addEventListener(MouseEvent.CLICK, closeClickHandler);
     

Clips the container of the Flash asset from the expanded dimensions to the collapsed dimensions. This function is only applicable for expandable ad formats.

     var collapseClickHandler:Function = function(event:MouseEvent):void {
       enabler.collapse();
     };
     collapseButton.addEventListener(MouseEvent.CLICK, collapseClickHandler);
     

Tracks a counter event.

     var closeClickHandler:Function = function(event:MouseEvent):void {
       enabler.counter("Close Button Counter");
       enabler.close();
     };
     collapseButton.addEventListener(MouseEvent.CLICK, closeClickHandler);
     

Displays the companion asset.

     var showClickHandler:Function = function(event:MouseEvent):void {
       enabler.displayCompanion();
     };
     showButton.addEventListener(MouseEvent.CLICK, showClickHandler);
     

Opens a new window with the URL as identified by the given exit ID.

     var exitClickHandler:Function = function(event:MouseEvent):void {
       enabler.exit("Background Exit");
     };
     customExitButton.addEventListener(MouseEvent.CLICK, exitClickHandler);
     

Exits Flash's native fullscreen mode.

     var closeFsClickHandler:Function = function(event:MouseEvent):void {
       enabler.exitFullScreen();
     };
     closeFsButton.addEventListener(MouseEvent.CLICK, closeFsClickHandler);
     

Opens a new window with the URL as identified by the given exit id. The queryString is appended to the URL.

     var exitClickHandler:Function = function(event:MouseEvent):void {
       enabler.exitQueryString("Background Exit", "id=doubleclick");
     };
     customExitButton.addEventListener(MouseEvent.CLICK, exitClickHandler);
     

Unclips the container of the Flash asset from the collapsed dimensions to the expanded dimensions. This function is only applicable for expandable ad formats.

     var expandClickHandler:Function = function(event:MouseEvent):void {
       enabler.expand();
     };
     expandButton.addEventListener(MouseEvent.CLICK, expandClickHandler);
     

This method decrements the count of assets that are currently loading. It should be called when you are finished loading an asset. See Enabler.waitForLoad() for an example.

Retrieves a custom parameter.

     var stringParam:String = enabler.getCustomParameter("stringParam");
     

Gets the DART ad ID.

     enabler.exitQueryString("Background Exit", enabler.getDartAdId());
     

Gets the DART creative ID.

     enabler.exitQueryString("Background Exit", enabler.getDartCreativeId());
     

Gets the DART page ID.

     enabler.exitQueryString("Background Exit", enabler.getDartPageId());
     

Gets the DART rendering ID.

     enabler.exitQueryString(
         "Background Exit",
         enabler.getDartRenderingId());
     

Gets the DART site ID.

     enabler.exitQueryString("Background Exit", enabler.getDartSiteId());
     

Gets the DART site name.

     enabler.exitQueryString("Background Exit", enabler.getDartSiteName());
     

Returns the whitelisted domains for Studio.

Retrieves the amount of time that has elapsed in the ad if supported by the environment. This is currently only supported for linear in-stream creatives.

DEPRECATED

     var fileName:String = enabler.getFilename(
         "AS3_300x250_test_snippets.swf");
     

Retrieves data from the shared data object for sharing between classes and SWFs.

Retrieves a creative parameter which the user can pass via queryString URL. This is the public-facing version of getAdParameter, and does some pre-filtering based on nulls and empties.

     var stringParam:String = enabler.getParameter("stringParam");
     

Retrieves a creative parameter as a typed integer.

     var intParam:Number = enabler.getParameterAsInteger("intParam");
     

Gets the DART-hosted streaming URL to be used at runtime given an original child asset file name.

     var videoUrl:String = enabler.getStreamingVideoUrl("video.flv");
     

Gets the runtime URL given the original compile-time filename.

     var url:String = enabler.getUrl("AS3_300x250_test_snippets.swf");
     

DEPRECATED

     var userAreaCode:String = enabler.getUserAreaCode();
     

Gets the user's bandwidth according to DART bandwidth codes.

     var userBandwidth:Number = enabler.getUserBandwidth();
     

Gets the two-letter string representation of the user's country, as defined by iso-3166-1 alpha 2.

     var userCountry:String = enabler.getUserCountry();
     

Returns a DART representation of the user's Nielsen Designated Market Area.

     var userDmaCode:String = enabler.getUserDMACode();
     

Gets the two letter string representation of the user's state or province.

     var userState:String = enabler.getUserState();
     

Gets the user's zip code (for users in the United States, U.S. Territories, and Canada).

     var userZipCode:String = enabler.getUserZipCode();
     

Returns the volume that the environment requested the ad be set to if supported. Values of -1 indicate that there is no requested volume. This is currently only supported for linear in-stream creatives.

Accessor to find out if the ad has started.

Indicates whether or not a user has interacted with the ad. If the user moused over the ad, we assume that the user interacted with it.

Initializes the Enabler.

Indicates whether or not the system is compatible and enabled to launch into FullScreen mode.

     if (!enabler.isFlashFullScreenSupported()) {
       openFsButton.visible = false;
       closeFsButton.visible = false;
     }
     

Returns if the ad is currently in full screen mode.

Indicates whether or not the Enabler has initialized. This method is generally used by other Studio components.

     import com.google.ads.studio.events.StudioEvent;
      
     var enablerInitHandler:Function = function(event:StudioEvent):void {
       trace("Enabler initialized.");
     };
      
     if (enabler.isInitialized()) {
       trace("Enabler initialized.");
     } else {
       trace("Enabler not yet initialized.");
       enabler.addEventListener(StudioEvent.INIT, enablerInitHandler);
     }
     

Indicates whether or not the creative is running locally or off the ad serving platform.

     if (enabler.isRunningLocally()) {
       trace("Flash is running locally.");
     }
     

Launches the creative in Flash's native fullscreen mode. Stage scale mode and align get reset to the original values when the creative exits fullscreen.

     var openFsClickHandler:Function = function(event:MouseEvent):void {
       enabler.launchFullScreen();
     };
     openFsButton.addEventListener(MouseEvent.CLICK, openFsClickHandler);
     

Mutes all video controllers.

     var muteAllClickHandler:Function = function(event:MouseEvent):void {
       enabler.muteAllVideos();
     };
     muteAllButton.addEventListener(MouseEvent.CLICK, muteAllClickHandler);
     

Indicates whether or not the host page has loaded.

     import com.google.ads.studio.events.StudioEvent;
      
     var pageLoadedHandler:Function = function(event:StudioEvent):void {
       trace("Page loaded.");
     };
      
     if (enabler.pageHasLoaded()) {
       trace("Page loaded.");
     } else {
       trace("Page not yet loaded.");
       enabler.addEventListener(StudioEvent.PAGE_LOADED, pageLoadedHandler);
     }
     

Allows a creative to specify the event they wish to be charged on.

DEPRECATED

DEPRECATED

Counts instances of the string parameter, aggregated as Custom Variable Count 1 in reports. The string must meet the following criteria:

• The string cannot exceed 100 characters
• The string must only contain Latin characters (0-9, Aa-Zz)
• The string must NOT contain any personally identifiable information such as name, email address, phone number, health info, financial info, etc.

     var siteName:String = enabler.getDartSiteName();
     enabler.reportCustomVariableCount1("Site Name: " + siteName);
     

Counts instances of the string parameter, aggregated as Custom Variable Count 2 in reports. The string must meet the following criteria:

• The string cannot exceed 100 characters
• The string must NOT contain any personally identifiable information such as name, email address, phone number, health info, financial info, etc.

     var siteName:String = enabler.getDartSiteName();
      
     var customReportClickHandler:Function = function(
         event:MouseEvent):void {
       enabler.reportCustomVariableCount2("Site Name:  " + siteName);
     };
     customReportButton.addEventListener(
         MouseEvent.CLICK,
         customReportClickHandler);
     

Records a manual closing of a Floating, Pop-up, Expanding, In-Page with Pop-up, or In-Page with Floating ad.

     var closeClickHandler:Function = function(event:MouseEvent):void {
       enabler.reportManualClose();
       enabler.close();
     };
     closeButton.addEventListener(MouseEvent.CLICK, closeClickHandler);
     

Sets the region of the ad that should still be visible when the ad is collapsed. Only used if the environment supports this. The function is considered internal and shouldn't be called directly. Use the expanding component instead.

Sets the default full screen stage align. Useful when using full screen buttons where you don't explicitly invoke #launchFullScreen.

Sets the default full screen scale mode. Useful when using full screen buttons where you don't explicitly invoke #launchFullScreen.

Updates and sets the total duration of the ad if supported by the environment. This is currently only supported for linear in-stream creatives.

Updates and reports the amount of time that has elapsed in the ad if supported by the environment. This is currently only supported for linear in-stream creatives.

Updates and reports the expanded state of the ad if supported by the environment. This method is considered internal and shouldn't be called directly. Use the expanding component instead.

Sets the default full screen source rectangle. Useful when using full screen buttons where you don't explicitly invoke #launchFullScreen.

Sets data that can be accessed between classes and SWFs.

Sets a predefined hint to be parsed on upload of the creative.

Updates and reports the linear state of the ad if supported by the environment. This should only be used by VPAID ads that are initially non-linear.

Updates and reports the skippable state of the ad if supported by the environment. This is currently only supported for linear in-stream creatives.

Updates and sets the current volume of the ad. This is currently only supported for linear in-stream creatives.

Starts an event timer.

     var mainPanelMouseoverHandler:Function = function(
         event:MouseEvent):void {
       enabler.startTimer("Roll Button Timer");
     };
     mainPanel.addEventListener(
         MouseEvent.MOUSE_OVER,
         mainPanelMouseoverHandler);
     

Stops all video controllers.

     var stopAllClickHandler:Function = function(event:MouseEvent):void {
       enabler.stopAllVideos();
     };
     stopAllButton.addEventListener(MouseEvent.CLICK, stopAllClickHandler);
     

Stops an event timer.

     var mainPanelMouseoutHandler:Function = function(
         event:MouseEvent):void {
       enabler.stopTimer("Main Panel Timer");
     };
     mainPanel.addEventListener(
         MouseEvent.MOUSE_OUT,
         mainPanelMouseoutHandler);
     

This method increments the count of assets that are currently loading. It should be called right before you begin loading an asset necessary for the initial display of the creative. When the asset is finished loading, a corresponding call to finishedLoad() must be made.

     enabler.waitForLoad();
     var urlRequest:URLRequest = new URLRequest(URL);
     var urlLoader:URLLoader = new URLLoader();
     urlLoader.addEventListener(Event.COMPLETE, urlLoadedHandler);
     urlLoader.addEventListener(IOErrorEvent.IO_ERROR, urlErrorHandler);
     urlLoader.load(urlRequest);
          function urlLoadedHandler(event:Event):void {
       enabler.finishedLoad();
       // Use loaded asset
     }
          function urlErrorHandler(event:Event):void {
       enabler.finishedLoad();
       // Handle error
     }
     

Retrieves the amount of time that has elapsed in the ad if supported by the environment. This is currently only supported for linear in-stream creatives.

Returns the volume that the environment requested the ad be set to if supported. Values of -1 indicate that there is no requested volume. This is currently only supported for linear in-stream creatives.

Returns the VpaidAdaptor for this object.

Initializes the Enabler.

Returns if the enabler is currently running in a preview environment.

Indicates whether or not the creative is running locally or off the ad serving platform.

     if (enabler.isRunningLocally()) {
       trace("Flash is running locally.");
     }
     

Records a manual closing of a Floating, Pop-up, Expanding, In-Page with Pop-up, or In-Page with Floating ad.

     var closeClickHandler:Function = function(event:MouseEvent):void {
       enabler.reportManualClose();
       enabler.close();
     };
     closeButton.addEventListener(MouseEvent.CLICK, closeClickHandler);
     

Sets the region of the ad that should still be visible when the ad is collapsed. Only used if the environment supports this. The function is considered internal and shouldn't be called directly. Use the expanding component instead.

Updates and sets the total duration of the ad if supported by the environment. This is currently only supported for linear in-stream creatives.

Updates and reports the amount of time that has elapsed in the ad if supported by the environment. This is currently only supported for linear in-stream creatives.

Updates and reports the expanded state of the ad if supported by the environment. This method is considered internal and shouldn't be called directly. Use the expanding component instead.

Updates and reports the linear state of the ad if supported by the environment. This should only be used by VPAID ads that are initially non-linear.

Updates and reports the skippable state of the ad if supported by the environment. This is currently only supported for linear in-stream creatives.

Method for ad units to use to notify the environment that the volume has changed.