• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.advertising.AutoAdComponent (轮播广告展示组件)
2
3<!--Kit: Ads Kit-->
4<!--Subsystem: Advertising-->
5<!--Owner: @SukiEvas-->
6<!--Designer: @zhansf1988-->
7<!--Tester: @hongmei_may-->
8<!--Adviser: @RayShih-->
9
10本模块提供展示轮播广告的能力。
11
12> **说明：**<br/>
13> 本模块首批接口从API version 11开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
14
15## 导入模块
16
17```ts
18import { AutoAdComponent } from '@kit.AdsKit';
19```
20
21## AutoAdComponent
22
23```ts
24AutoAdComponent({
25  adParam: advertising.AdRequestParams,
26  adOptions: advertising.AdOptions,
27  displayOptions: advertising.AdDisplayOptions,
28  interactionListener: advertising.AdInteractionListener
29})
30```
31
32**装饰器类型：** @Component
33
34**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。
35
36**系统能力：** SystemCapability.Advertising.Ads
37
38**参数：**
39
40| 名称                | 类型                                                                              | 必填 | 说明              |
41|---------------------|-----------------------------------------------------------------------------------|-----|-----------------|
42| adParam             | advertising.[AdRequestParams](js-apis-advertising.md#adrequestparams)             | 是   | 广告请求参数。     |
43| adOptions           | advertising.[AdOptions](js-apis-advertising.md#adoptions)                         | 是   | 广告配置参数。     |
44| displayOptions      | advertising.[AdDisplayOptions](js-apis-advertising.md#addisplayoptions)           | 是   | 广告展示参数。     |
45| interactionListener | advertising.[AdInteractionListener](js-apis-advertising.md#adinteractionlistener) | 是   | 广告状态变化回调。 |
46
47### build
48
49build(): void
50
51用于创建AutoAdComponent对象的构造函数。
52
53**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。
54
55**系统能力：** SystemCapability.Advertising.Ads
56
57## 示例
58
59该示例代码实现了轮播广告的展示。
60
61```ts
62import { advertising, AutoAdComponent } from '@kit.AdsKit';
63import { hilog } from '@kit.PerformanceAnalysisKit';
64
65@Entry
66@Component
67struct Index {
68  // 广告请求参数
69  private adRequestParams: advertising.AdRequestParams = {
70    // 广告位ID
71    adId: 'testw6vs28auh3',
72    // 广告类型
73    adType: 8
74  };
75  // 广告配置参数
76  private adOptions: advertising.AdOptions = {};
77  // 广告展示参数
78  private adDisplayOptions: advertising.AdDisplayOptions = {
79    // 广告轮播的时间间隔，单位ms，取值范围[30000, 120000]
80    refreshTime: 30000
81  };
82
83  build() {
84    Column() {
85      AutoAdComponent({
86        adParam: this.adRequestParams,
87        adOptions: this.adOptions,
88        displayOptions: this.adDisplayOptions,
89        interactionListener: {
90          onStatusChanged: (status: string, ad: advertising.Advertisement, data: string) => {
91            switch (status) {
92              case 'onAdOpen':
93                hilog.info(0x0000, 'testTag', 'onAdOpen');
94                break;
95              case 'onAdClick':
96                hilog.info(0x0000, 'testTag', 'onAdClick');
97                break;
98              case 'onAdClose':
99                hilog.info(0x0000, 'testTag', 'onAdClose');
100                break;
101            }
102          }
103        }
104      })
105        .width('100%')
106        .height('100%')
107    }
108    .width('100%')
109    .height('100%')
110  }
111}
112```