This module provides the capability of displaying carousel ads.
The initial APIs of this module are supported since API version 11. Newly added APIs will be marked with a superscript to indicate their earliest API version.
AutoAdComponent(adParam: advertising.AdRequestParams, adOptions: advertising.AdOptions, displayOptions: advertising.AdDisplayOptions, interactionListener: advertising.AdInteractionListener): void
Component used to automatically play ads.
Decorator type: @Component
Atomic service API: This API can be used in atomic services since API version 12.
System capability: SystemCapability.Advertising.Ads
Parameters:
Parameter | Type | Mandatory | Decorator Type | Description |
|---|---|---|---|---|
adParam | advertising.AdRequestParams | Yes | - | Ad request parameters. |
adOptions | advertising.AdOptions | Yes | - | Ad configuration. |
displayOptions | advertising.AdDisplayOptions | Yes | - | Ad display parameters. |
interactionListener | advertising.AdInteractionListener | Yes | - | Ad status change callback. |
Example:
import { AutoAdComponent, advertising } from '@kit.AdsKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
@Entry
@Component
struct ShowCarouselAd {
private adRequestParam: advertising.AdRequestParams = {
// Ad type.
adType: 8,
// Test ad unit ID.
adId: 'testw6vs28auh3'
};
private adOptions: advertising.AdOptions = {
// Maximum ad content rating.
adContentClassification: 'A'
};
// Ad display parameters.
private adDisplayOptions: advertising.AdDisplayOptions = {
// Whether to mute the ad. By default, the ad is not muted.
mute: false,
// Interval for ad rotation, in ms. The value ranges from 30000 to 120000.
refreshTime: 30000
}
build() {
Column() {
// AutoAdComponent is used to show a non-full-screen carousel ad.
AutoAdComponent({
adParam: this.adRequestParam,
adOptions: this.adOptions,
displayOptions: this.adDisplayOptions,
interactionListener: {
// Ad status change callback.
onStatusChanged: (status: string, ad: advertising.Advertisement, data: string) => {
switch (status) {
case 'onAdOpen':
hilog.info(0x0000, 'testTag', '%{public}s', 'onAdOpen');
break;
case 'onAdClick':
hilog.info(0x0000, 'testTag', '%{public}s', 'onAdClick');
break;
case 'onAdClose':
hilog.info(0x0000, 'testTag', '%{public}s', 'onAdClose');
break;
}
}
}
})
.width('100%')
.height('100%')
}.width('100%').height('100%')
}
}