自学内容网 自学内容网

华为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。

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

原文地址:https://blog.csdn.net/pisceshsu/article/details/143491918

免责声明:本站文章内容转载自网络资源,如本站内容侵犯了原著者的合法权益,可联系本站删除。更多内容请关注自学内容网(zxcms.com)!