华为HarmonyOS打造开放合规的广告生态 - Banner广告

场景介绍

Banner广告是在应用程序顶部、中部或底部占据一个位置的矩形图片，广告内容每隔一段时间会自动刷新。

接口说明

接口名	描述
AutoAdComponent(adParam: advertising.AdRequestParams, adOptions: advertising.AdOptions, displayOptions: advertising.AdDisplayOptions, interactionListener: advertising.AdInteractionListener): void	展示广告，通过AdRequestParams、AdOptions进行广告请求参数设置，通过AdDisplayOptions进行广告展示参数设置，通过AdInteractionListener监听广告状态回调。

开发步骤

1. 获取OAID。

   如果想要为用户更精准的推送广告，可以在请求参数AdRequestParams中添加oaid属性。

   如何获取OAID参考获取OAID信息。

   说明

   使用以下示例中提供的测试广告位必须先获取OAID信息。

2. 请求和展示广告。

   在您的页面中使用AutoAdComponent组件展示Banner广告。

   请求广告关键参数如下所示：

   请求广告参数名	类型	必填	说明
   adType	number	是	请求广告类型，Banner广告类型为8。
   adId	string	是	广告位ID。 * 如果仅调测广告，可使用测试广告位ID：testw6vs28auh3。 * 如果要接入正式广告，则需要申请正式的广告位ID。可在应用发布前进入流量变现官网，点击"开始变现"，登录鲸鸿动能媒体服务平台进行申请，具体操作详情请参见展示位创建。
   adWidth	number	是	广告位宽，单位vp。宽和高支持360*57和360*144两种尺寸。
   adHeight	number	是	广告位高，单位vp。宽和高支持360*57和360*144两种尺寸。
   oaid	string	否	开放匿名设备标识符，用于精准推送广告。不填无法获取到个性化广告。

   展示广告关键参数如下所示：

   展示广告参数名	类型	必填	说明
   refreshTime	number	否	Banner广告轮播时间。单位ms，取值范围[30000, 120000]。 如果不设置或取值为非数字或小于等于0的数字，则不轮播。设置小于30000的数字取值30000，设置大于120000的数字取值120000。

   示例代码如下所示：

   1. import { advertising, AutoAdComponent, identifier } from '@kit.AdsKit';
   2. import { hilog } from '@kit.PerformanceAnalysisKit';
   3. import { BusinessError } from '@kit.BasicServicesKit';
   5. @Entry
   6. @Component
   7. struct Index {
   8. @State adParam: advertising.AdRequestParams = {
   9. // 广告类型：Banner广告
   10. adType: 8,
   11. // 'testw6vs28auh3'为测试专用的广告位ID，App正式发布时需要改为正式的广告位ID
   12. adId: 'testw6vs28auh3',
   13. // 广告位宽
   14. adWidth: 360,
   15. // 广告位高
   16. adHeight: 57,
   17. // 开放匿名设备标识符
   18. oaid: ''
   19. };
   20. private adOptions: advertising.AdOptions = {
   21. // 是否允许流量下载0：不允许，1：允许，不设置以广告主设置为准
   22. allowMobileTraffic: 0,
   23. // 是否希望根据 COPPA 的规定将您的内容视为面向儿童的内容: -1默认值，不确定 0不希望 1希望
   24. tagForChildProtection: -1,
   25. // 是否希望按适合未达到法定承诺年龄的欧洲经济区 (EEA) 用户的方式处理该广告请求： -1默认值，不确定 0不希望 1希望
   26. tagForUnderAgeOfPromise: -1,
   27. // 设置广告内容分级上限: W: 3+,所有受众 PI: 7+,家长指导 J:12+,青少年 A: 16+/18+，成人受众
   28. adContentClassification: 'A'
   29. };
   30. private displayOptions: advertising.AdDisplayOptions = {
   31. // 广告轮播的时间间隔，单位ms，取值范围[30000, 120000]
   32. refreshTime: 30000
   33. }
   34. private ratio: number = 1;
   35. private adWidth: number = -1;
   36. private adHeight: number = -1;
   37. @State visibilityState: Visibility = Visibility.Visible;
   39. aboutToAppear() {
   40. try {
   41. // 使用Promise回调方式获取OAID
   42. identifier.getOAID().then((data) => {
   43. this.adParam.oaid = data;
   44. hilog.info(0x0000, 'testTag', '%{public}s', `Succeeded in getting adsIdentifierInfo by promise`);
   45. }).catch((error: BusinessError) => {
   46. hilog.error(0x0000, 'testTag', '%{public}s',
   47. `Failed to get adsIdentifierInfo, code: ${error.code}, message: ${error.message}`);
   48. })
   49. } catch (error) {
   50. hilog.error(0x0000, 'testTag', '%{public}s', `Catch err, code: ${error.code}, message: ${error.message}`);
   51. }
   53. if (this.adParam?.adWidth && typeof (this.adParam?.adWidth) === 'number' && this.adParam?.adWidth > 0) {
   54. this.adWidth = this.adParam?.adWidth;
   55. }
   56. if (this.adParam?.adHeight && typeof (this.adParam?.adHeight) === 'number' && this.adParam?.adHeight > 0) {
   57. this.adHeight = this.adParam?.adHeight;
   58. }
   59. if (this.adWidth > 0 && this.adHeight > 0) {
   60. this.ratio = this.adWidth / this.adHeight;
   61. }
   62. }
   64. build() {
   65. if (this.adParam.oaid) {
   66. Stack({ alignContent: Alignment.Bottom }) {
   67. this.buildBannerView()
   68. }
   69. }
   70. }
   72. @Builder
   73. buildBannerView() {
   74. Row() {
   75. AutoAdComponent({
   76. adParam: this.adParam,
   77. adOptions: this.adOptions,
   78. displayOptions: this.displayOptions,
   79. interactionListener: {
   80. onStatusChanged: (status: string, ad: advertising.Advertisement, data: string) => {
   81. hilog.info(0x0000, 'testTag', '%{public}s', `status is ${status}`);
   82. switch (status) {
   83. case AdStatus.AD_OPEN:
   84. hilog.info(0x0000, 'testTag', '%{public}s', 'Status is onAdOpen');
   85. break;
   86. case AdStatus.AD_CLICKED:
   87. hilog.info(0x0000, 'testTag', '%{public}s', 'Status is onAdClick');
   88. break;
   89. case AdStatus.AD_CLOSED:
   90. hilog.info(0x0000, 'testTag', '%{public}s', 'Status is onAdClose');
   91. this.visibilityState = Visibility.None;
   92. break;
   93. case AdStatus.AD_LOAD:
   94. hilog.info(0x0000, 'testTag', '%{public}s', 'Status is onAdLoad');
   95. break;
   96. case AdStatus.AD_FAIL:
   97. hilog.error(0x0000, 'testTag', '%{public}s', 'Status is onAdFail');
   98. this.visibilityState = Visibility.None;
   99. break;
   100. }
   101. }
   102. }
   103. })
   104. }
   105. .width('100%')
   106. .aspectRatio(this.ratio)
   107. .visibility(this.visibilityState)
   108. }
   109. }
   111. enum AdStatus {
   112. AD_LOAD = 'onAdLoad',
   113. AD_FAIL = 'onAdFail',
   114. AD_OPEN = 'onAdOpen',
   115. AD_CLICKED = 'onAdClick',
   116. AD_CLOSED = 'onAdClose',
   117. AD_REWARDED = 'onAdReward',
   118. AD_VIDEO_START = 'onVideoPlayBegin',
   119. AD_COMPLETED = 'onVideoPlayEnd'
   120. }