harmony 鸿蒙@ohos.advertising.AutoAdComponent (轮播广告展示组件)

2025-06-12
浏览 (6)

@ohos.advertising.AutoAdComponent (轮播广告展示组件)

本模块提供展示轮播广告的能力。

说明：
本模块首批接口从API Version 11开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import { AutoAdComponent } from '@kit.AdsKit';

AutoAdComponent

AutoAdComponent(adParam: advertising.AdRequestParams, adOptions: advertising.AdOptions, displayOptions: advertising.AdDisplayOptions, interactionListener: advertising.AdInteractionListener): void

自动播放广告组件。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Advertising.Ads

参数：

参数名	类型	必填	说明
adParam	advertising.AdRequestParams	是	广告请求参数。
adOptions	advertising.AdOptions	是	广告配置。
displayOptions	advertising.AdDisplayOptions	是	广告展示参数。
interactionListener	advertising.AdInteractionListener	是	广告状态变化回调。

示例：

import { advertising, AutoAdComponent } from '@kit.AdsKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

@Entry
@Component
struct Index {
  private adRequestParams: advertising.AdRequestParams = {
    // 广告类型
    adType: 8,
    // 测试广告位ID
    adId: 'testw6vs28auh3'
  };
  private adOptions: advertising.AdOptions = {
    // 设置广告内容分级上限
    adContentClassification: 'A'
  };
  // 广告展示参数
  private adDisplayOptions: advertising.AdDisplayOptions = {
    // 是否静音，默认不静音
    mute: false,
    // 广告轮播的时间间隔，单位ms，取值范围[30000, 120000]
    refreshTime: 30000
  };

  build() {
    Column() {
      // AutoAdComponent组件用于展示轮播非全屏广告
      AutoAdComponent({
        adParam: this.adRequestParams,
        adOptions: this.adOptions,
        displayOptions: this.adDisplayOptions,
        interactionListener: {
          // 广告状态变化回调
          onStatusChanged: (status: string, ad: advertising.Advertisement, data: string) => {
            switch (status) {
              case 'onAdOpen':
                hilog.info(0x0000, 'testTag', 'onAdOpen');
                break;
              case 'onAdClick':
                hilog.info(0x0000, 'testTag', 'onAdClick');
                break;
              case 'onAdClose':
                hilog.info(0x0000, 'testTag', 'onAdClose');
                break;
            }
          }
        }
      })
        .width('100%')
        .height('100%')
    }
    .width('100%')
    .height('100%')
  }
}