• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.advertising.AutoAdComponent (轮播广告展示组件)
2
3本模块提供展示轮播广告的能力。
4
5> **说明：**<br/>
6> 本模块首批接口从API Version 11开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
7
8## 导入模块
9
10```ts
11import { AutoAdComponent } from '@kit.AdsKit';
12```
13
14## AutoAdComponent
15
16AutoAdComponent(adParam: advertising.AdRequestParams, adOptions: advertising.AdOptions, displayOptions: advertising.AdDisplayOptions, interactionListener: advertising.AdInteractionListener): void
17
18自动播放广告组件。
19
20**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。
21
22**系统能力：** SystemCapability.Advertising.Ads
23
24**参数：**
25
26| 参数名              | 类型                                                                              | 必填 | 说明              |
27|---------------------|-----------------------------------------------------------------------------------|-----|-----------------|
28| adParam             | advertising.[AdRequestParams](js-apis-advertising.md#adrequestparams)             | 是   | 广告请求参数。     |
29| adOptions           | advertising.[AdOptions](js-apis-advertising.md#adoptions)                         | 是   | 广告配置。         |
30| displayOptions      | advertising.[AdDisplayOptions](js-apis-advertising.md#addisplayoptions)           | 是   | 广告展示参数。     |
31| interactionListener | advertising.[AdInteractionListener](js-apis-advertising.md#adinteractionlistener) | 是   | 广告状态变化回调。 |
32
33**示例：**
34
35```ts
36import { advertising, AutoAdComponent } from '@kit.AdsKit';
37import { hilog } from '@kit.PerformanceAnalysisKit';
38
39@Entry
40@Component
41struct Index {
42  private adRequestParams: advertising.AdRequestParams = {
43    // 广告类型
44    adType: 8,
45    // 测试广告位ID
46    adId: 'testw6vs28auh3'
47  };
48  private adOptions: advertising.AdOptions = {
49    // 设置广告内容分级上限
50    adContentClassification: 'A'
51  };
52  // 广告展示参数
53  private adDisplayOptions: advertising.AdDisplayOptions = {
54    // 是否静音，默认不静音
55    mute: false,
56    // 广告轮播的时间间隔，单位ms，取值范围[30000, 120000]
57    refreshTime: 30000
58  };
59
60  build() {
61    Column() {
62      // AutoAdComponent组件用于展示轮播非全屏广告
63      AutoAdComponent({
64        adParam: this.adRequestParams,
65        adOptions: this.adOptions,
66        displayOptions: this.adDisplayOptions,
67        interactionListener: {
68          // 广告状态变化回调
69          onStatusChanged: (status: string, ad: advertising.Advertisement, data: string) => {
70            switch (status) {
71              case 'onAdOpen':
72                hilog.info(0x0000, 'testTag', 'onAdOpen');
73                break;
74              case 'onAdClick':
75                hilog.info(0x0000, 'testTag', 'onAdClick');
76                break;
77              case 'onAdClose':
78                hilog.info(0x0000, 'testTag', 'onAdClose');
79                break;
80            }
81          }
82        }
83      })
84        .width('100%')
85        .height('100%')
86    }
87    .width('100%')
88    .height('100%')
89  }
90}
91```