-
Notifications
You must be signed in to change notification settings - Fork 21
A Passible Advertising WebIDL
This specification defines a set of interface to access advertising service.
This section is non-normative.
The Advertising API is designed to access advertising service from web app, such as admob, iAd, etc. Developer can request various types of advertisements from such services, as well as control the shown, hidden and destroy of the object. Meanwhile, the API can set the listener to open
and close
events of the object to maintain the states of the web app, for example, pause/resume the game.
As well as sections marked as non-normative , all authoring guidelines, diagrams, examples, and notes in this specification are non-normative. Everything else in this specification is normative.
he key words must , must not , required , should , should not , recommended , may , and optional in this specification are to be interpreted as described in RFC2119.
The following concepts, terms and interfaces are defined in HTML5:
- EventHandler
- event handler and event types
Promise objects are defined in ECMASCRIPT.
interface xwalk {
attribute Experimental experimental;
}
interface experimental {
attribute Advertising ad;
}
ad of type Advertising, readonly
- The object that exposes the Advertising functionality.
The Advertising interface exposes the Advertising functionality.
interface Advertising {
Promise create (RequestOptions requestOptions);
};
create
- This method creates an ad.
- Parameter: options
- Type: RequestOptions
- Nullable: N
- Optinal: N
- Return type: Promise
- Create a View with input options. Banner or Interstitial.
- Return a new
Promise
object. - If an error occurs call promise's
error
method. - When the method has been successfully completed, call
success
method of the promise.
interface Advertise {
Promise destroy ();
Promise show (boolean show);
attribute EventHandler onopen;
attribute EventHandler onclose;
};
onopen
- Handles the
touch
event, fired when an ad is opened by user.
onclose
- Handles the
close
event, fired when an ad is closed by user.
destroy
- This method destroys a view.
- No parameters.
- Return type: Promise
show
- This method controls the ad be shown and hidden.
- Parameter: bShow
- Type: boolean
- Nullable: N
- Optinal: N
- Return type: Promise
- Destroy the ad.
- Return a new
Promise
object. - If an error occurs call promise's
error
method. - When the method has been successfully completed, call
success
method of the promise.
- Show ad when
show
is true. Hide ad whenshow
is false. - Return a new
Promise
object. - If an error occurs call promise's
error
method. - When the method has been successfully completed, call
success
method of the promise.
The Advertising interface exposes the Advertising functionality.
interface RequestOptions {
attribute DOMString service;
attribute DOMString publisherId;
attribute AdType type;
optional attribute AdSize size;
optional attribute boolean bannerAtTop;
optional attribute boolean overlap;
}
service
of type DOMString
- Represents a unique identifier of the provider. Like, "admob", etc.
publisherId
of type DOMString
- Represents a unique identifier of the publisher.
type
of type DOMString
- Represents the type of ad. Currently, "banner" and "interstitial" are available.
size
of type DOMString
- Represents the size of ad.
bannerAtTop
of type boolean
- Represents Whether or not the ad should be positioned at top or bottom of screen.
overlap
of type boolean
- Represents Whether or not the banner will overlap the webview instead of push it up or down.
enum AdType {
"banner",
"interstitial"
}
enum AdSize {
"BANNER",
"IAB_MRECT",
"IAB_BANNER",
"IAB_LEADERBOARD",
"SMART_BANNER"
}
This section is non-normative.
xwalk.experimental.ad.create({
"service" : "admob",
"publisherId" : "ca-app-pub-xxx/4806197152",
"type" : "banner",
"size" : "SMART_BANNER",
"bannerAtTop" : false,
"overlap" : false
}).then(
function(ad) {
ad.addEventListene("open", function(evt) {
console.log("Ad is opened");
ad.show(true);
})
ad.addEventListene("close", function(evt) {
console.log("Ad is closed");
ad.destroy();
})
},
function(err) {
console.log("Failed to create ad")
}
);
First step, you should create an advertise object. If you don't have a publisherId
from an advertising service, please access the home page of corresponding service provider to register an account and get one. In this example, adverting service is admob
. The request type is banner
.
In the success
callback function of the Promise, which ad.create()
returns, you can add event listeners to object. There are two types of event you can get, open
and close
. open
is fired when the user touches or clicks the advertisement. If you are in a game, the game should be paused in the callback function of the event. In this example, just leave a log, "Ad is opened". close
means user touches or clicks the close button on the advertisement.