@ohos.advertising.AutoAdComponent (Carousel Ad Component)

The AutoAdComponent module provides the capability of displaying carousel ads.

NOTE

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.

Modules to Import

import { AutoAdComponent } from '@ohos.advertising.AutoAdComponent';

AutoAdComponent

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

Shows a non-full-screen ad.

System capability: SystemCapability.Advertising.Ads

Since: 11

Parameters

Example

import advertising from '@ohos.advertising';
import { AutoAdComponent } from '@ohos.advertising.AutoAdComponent';
import hilog from '@ohos.hilog'; 

@Entry
@Component
export struct ShowCarouselAd {
  private adRequestParam: advertising.AdRequestParams = {
    // Ad type.
    adType: 8, 
    // Ad ID.
    adId: "test1", 
  };
  private adOptions: advertising.AdOptions = {
    // Set the 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 at which the carousel items rotate, in ms. The value range is [30000, 120000].
    refreshTime: 30000
  }

  build() {
    Column() {
      // The AutoAdComponent is used to show the carousel ad in non-full-screen mode.
      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%')
  }
}