文档管理中心
您当前正在浏览HarmonyOS最新文档,覆盖已发布的所有API版本,可在API参考中筛选您使用的API版本。详细的版本配套关系请参考版本说明
API参考应用服务Ads Kit(广告服务)ArkTS组件@ohos.advertising.AutoAdComponent (轮播广告展示组件)

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

Phone12+PC/2in113+Tablet12+

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

说明

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

导入模块

收起
自动换行
深色代码主题
复制
  1. import { AutoAdComponent } from '@kit.AdsKit';

AutoAdComponent

Phone12+PC/2in113+Tablet12+
收起
自动换行
深色代码主题
复制
  1. AutoAdComponent({
  2. adParam: advertising.AdRequestParams,
  3. adOptions: advertising.AdOptions,
  4. displayOptions: advertising.AdDisplayOptions,
  5. interactionListener: advertising.AdInteractionListener
  6. })

用于展示轮播广告的组件。

装饰器类型:@Component

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.Advertising.Ads

参数:

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

示例:

收起
自动换行
深色代码主题
复制
  1. import { advertising, AutoAdComponent } from '@kit.AdsKit';
  2. import { hilog } from '@kit.PerformanceAnalysisKit';
  3. @Entry
  4. @Component
  5. struct Index {
  6. // 广告请求参数
  7. private adRequestParams: advertising.AdRequestParams = {
  8. // 广告位ID
  9. adId: 'h5xkz3mbr2',
  10. // 广告类型
  11. adType: 8,
  12. // 广告位宽,单位vp
  13. adWidth: 360,
  14. // 广告位高,单位vp
  15. adHeight: 57
  16. };
  17. // 广告配置参数
  18. private adOptions: advertising.AdOptions = {};
  19. // 广告展示参数
  20. private adDisplayOptions: advertising.AdDisplayOptions = {
  21. // 广告轮播的时间间隔,单位ms,取值范围[30000, 120000]
  22. refreshTime: 30000
  23. };
  24. private ratio: number = -1;
  25. aboutToAppear() {
  26. if (this.adRequestParams.adWidth && this.adRequestParams.adHeight) {
  27. this.ratio = this.adRequestParams.adWidth / this.adRequestParams.adHeight;
  28. }
  29. }
  30. build() {
  31. Column() {
  32. AutoAdComponent({
  33. adParam: this.adRequestParams,
  34. adOptions: this.adOptions,
  35. displayOptions: this.adDisplayOptions,
  36. interactionListener: {
  37. onStatusChanged: (status: string, ad: advertising.Advertisement, data: string) => {
  38. switch (status) {
  39. case 'onAdOpen':
  40. hilog.info(0x0000, 'testTag', 'onAdOpen');
  41. break;
  42. case 'onAdClick':
  43. hilog.info(0x0000, 'testTag', 'onAdClick');
  44. break;
  45. case 'onAdClose':
  46. hilog.info(0x0000, 'testTag', 'onAdClose');
  47. break;
  48. }
  49. }
  50. }
  51. })
  52. .width('100%')
  53. .aspectRatio(this.ratio)
  54. }
  55. .width('100%')
  56. .height('100%')
  57. }
  58. }

build

Phone12+PC/2in113+Tablet12+

build(): void

用于创建AutoAdComponent对象的构造函数。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.Advertising.Ads

在 API参考 中进行搜索
请输入您想要搜索的关键词