ContextualDiscovery retrieves and exposes contextual information related to the hosting page.
For more information, see the ContextualDiscovery component.
import com.google.ads.studio.ContextualDiscovery;
import com.google.ads.studio.events.StudioEvent;
var terms:Array;
var latitude:Number;
var longitude:Number;
var dataHandler:Function = function(dataEvent:StudioEvent):void {
terms = dataEvent.terms;
latitude = dataEvent.latitude as Number;
longitude = dataEvent.longitude as Number;
};
// Attach the event listener.
ContextualDiscovery.getInstance().addEventListener(
StudioEvent.CONTEXT_LOAD,
dataHandler);
// Invoke the data retrieval.
ContextualDiscovery.getInstance().discoverContext();
// This will retrieve the contextual data from the preview URL in a test
// environment.
ContextualDiscovery.getInstance().
setContextualDiscoveryPreviewUrl("www.previewURL.com");
Events
| Name | Type | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
CONTEXT_FAIL | com.google.ads.studio.events.StudioEvent | Dispatched when retrieval of contextual data fails for any reason.
import com.google.ads.studio.ContextualDiscovery;
import com.google.ads.studio.events.StudioEvent;
var failHandler:Function = function(event:StudioEvent):void {
trace("Component failed to intialize.");
};
ContextualDiscovery.getInstance().addEventListener(
StudioEvent.CONTEXT_FAIL,
failHandler);
| ||||||||
CONTEXT_LOAD | com.google.ads.studio.events.StudioEvent | Dispatched when the contextual data is available. The properties of the event object have the following values:
import com.google.ads.studio.ContextualDiscovery;
import com.google.ads.studio.events.StudioEvent;
var terms:Array;
var latitude:Number;
var longitude:Number;
var dataHandler:Function = function(dataEvent:StudioEvent):void {
terms = dataEvent.terms;
latitude = dataEvent.latitude as Number;
longitude = dataEvent.longitude as Number;
};
ContextualDiscovery.getInstance().addEventListener(
StudioEvent.CONTEXT_LOAD,
dataHandler);
ContextualDiscovery.getInstance().discoverContext();
| ||||||||
FAIL | com.google.ads.studio.events.StudioEvent | Dispatched when the component has failed to initialize. | ||||||||
INIT | com.google.ads.studio.events.StudioEvent | Dispatched when the component has initialized.
This event may fire almost immediately after component construction. To
ensure capturing the initialized state please refer to the example:
// Note the variable component refers to the component instance.
import com.google.ads.studio.events.StudioEvent;
var initializedHandler:Function = function(
event:StudioEvent = null):void {
trace("The component initialized!");
};
if (component.isInitialized()) {
initializedHandler();
} else {
component.addEventListener(StudioEvent.INIT, initializedHandler);
}
|
Static Methods
ContextualDiscovery.getInstance()
:
ContextualDiscoveryReturns the singleton instance of the ContextualDiscovery class.
Instance Methods
Defined in: com.google.ads.studio:EnabledComponent
getEnabler()
:
ObjectisInitialized()
:
BooleanReturns whether the component has initialized.
Defined in com.google.ads.studio:ContextualDiscovery
discoverContext()
:
voidInitiates a request to discover the context.
ContextualDiscovery.getInstance().discoverContext();
setContextualDiscoveryPreviewUrl(previewUrl:String)
:
voidSets the preview URL to do the contextual discovery when the ad is running locally (flash preview) or in default page preview.
ContextualDiscovery.getInstance().
setContextualDiscoveryPreviewUrl("www.previewURL.com");